前往掘金查看:https://juejin.im/post/5d05e5f9f265da1b6c5f74b4
前言
在開發中,我們常常會碰到多種傳參的方式。這里,我們就來總結下,springboot中可以運用到的接受參數的方式。
URL參數
這種參數,組合在url上,形如url/{id}。在springboot中,接受此類參數可以使用PathVariable注解,如下:
@GetMapping(value = "/param/{id}")
public Object pathVariable(@PathVariable(value = "id") Integer id) {
return id;
}
測試
表單參數類型
這種參數形如:name=xxx&age=xxx。可能是拼接在url上的,如get方法,也可能是放在http requestBody 里面的。這種參數可以使用RequestParam注解接受,比如:
@PostMapping(value = "/param")
public Object queryString(@RequestParam(value = "username") String name,
String remark) {
Map<String, String> map = new HashMap<>();
map.put("name", name);
map.put("remark", remark);
return map;
}
這里使用RequestParam注解,把username參數接受到了name,而第二個參數remark沒有使用RequestParam注解,這是因為如果請求參數和方法參數一致的話,可以省略RequestParam注解。
測試如下:
第一種:直接把請求參數放在url上
請求參數放在url上
第二種:請求參數放在body上
點擊postman的code,查看curl的格式,可以看出是name=xxx&age=xxx的形式
json類型
這種類型是目前最流行的,在restful風格下,目前幾乎所有的系統都使用json的形式進行數據傳遞。
我們先定義一個Person類,用來做參數接受類,其中字段命名要與json參數的key一致。
public static class Person {
private String username;
private String remark;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getRemark() {
return remark;
}
public void setRemark(String remark) {
this.remark = remark;
}
}
我們可以使用RequestBody注解來接受json參數
@PostMapping(value = "/param/json")
public Object json(@RequestBody Person person) {
return person;
}
測試
如果我們不想定義一個對象來接受參數,大可以使用Map來接收。
@PostMapping(value = "/param/map")
public Object map(@RequestBody Map data) {
System.out.println(data.get("username"));
System.out.println(data.get("remark"));
return data;
}
接受請求頭
有些接口要求用請求頭傳遞參數,比如使用token鑒權的系統,token一般都攜帶在請求頭上,或者在cookie上(cookie也在請求頭上)。我們可以使用RequestHeader注解來接受,如下:
@GetMapping(value = "/param/header")
public Object header(@RequestHeader(value = "token") String token) {
return token;
}
接受cookie參數
接受cookie參數,可以使用CookieValue注解來接受
@GetMapping(value = "/param/cookie")
public Object cookie(@CookieValue(name = "token") String token) {
return token;
}