本文重点来看几种传参方式,看看它们都是如何被解析并应用到方法参数上的。
一、@PathVariable
获取路径参数。即url/{id}这种形式。
@GetMapping(value = "/param/{id}")
public Object pathVariable(@PathVariable(value = "id") Integer id) {
return id;
}
二、@RequestParam
获取查询参数。即url?name=这种形式
@PostMapping(value = "/param")
public Object queryString(@RequestParam(required = true) 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的形式
三、@RequestBody
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;
}
测试
四、@RequestHeader
有些接口要求用请求头传递参数,比如使用token鉴权的系统,token一般都携带在请求头上,或者在cookie上(cookie也在请求头上)。我们可以使用RequestHeader注解来接受,如下:
@GetMapping(value = "/param/header")
public Object header(@RequestHeader(value = "token") String token) {
return token;
}
五、@CookieValue
接受cookie参数,可以使用CookieValue注解来接受
@GetMapping(value = "/param/cookie")
public Object cookie(@CookieValue(name = "token") String token) {
return token;
}
六、HttpServletRequest
接受全部的params参数和form-data参数
七、无注解
例子
对应的java代码
@PostMapping(path = "/demo2")
public void demo2(Person person) {
System.out.println(person.toString());
}
输出结果:
name:suki_rong;age=18;hobby:programing
//Person类
public class Person {
private long id;
private String name;
private int age;
private String hobby;
@Override
public String toString(){
return "name:"+name+";age="+age+";hobby:"+hobby;
}
}