在开发中,我们常常会碰到多种传参的方式。这里,我们就来总结下,springboot中可以运用到的接受参数的方式。
这种参数,组合在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的形式
这种类型是目前最流行的,在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参数,可以使用CookieValue注解来接受
@GetMapping(value = "/param/cookie") public Object cookie(@CookieValue(name = "token") String token) { return token; } 复制代码