【快學springboot】3.多種接受參數的方式

前言

在開發中，咱們經常會碰到多種傳參的方式。這裏，咱們就來總結下，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;
 }
複製代碼