@PathVariable、@RequestParam、@RequestBody、@ResponseBody、RequestEntity、ResponseEntity

@PathVariable

当使用 @RequestMapping URI template 样式映射时，@PathVariable 能使传过来的参数绑定到路由上，这样比较容易写出 restful api，看代码

@RequestMapping(value="/{id}", method=RequestMethod.GET)
public List<Map<String, Object>> getUser(@PathVariable Integer id) {
    return userService.getUserById(id);
}

上面这个接口可通过 get 请求 http://xxxxx/1111 来得到想要的数据，1111 既是 getUser 的方法参数又是 @RequestMapping 的路由。如果方法参数不想写成和路由一样的应该怎么办？看代码：

@RequestMapping(value="/{uid}", method=RequestMethod.GET)
public List<Map<String, Object>> getUser(@PathVariable("uid") Integer id) {
    return userService.getUserById(id);
}

在 @PathVariable 后面接入 “uid” 就可以了。

@RequestParam

@RequestParam 和 @PathVariable 的区别就在于请求时当前参数是在 url 路由上还是在请求的body 上，例如有下面一段代码：

@RequestMapping(value="", method=RequestMethod.POST)
public String postUser(@RequestParam(value="phoneNum", required=true, String phoneNum ) String userName) {
    userService.create(phoneNum, userName);
    return "success";
}

这个接口的请求 url 这样写：http://xxxxx?phoneNum=xxxxxx，也就是说被 @RequestParam 修饰的参数最后通过 key=value 的形式放在http请求的Body传过来，对比下上面的 @PathVariable 就很容易看出两者的区别了。

@Responsebody、@ResponseBody、RequestEntity、ResponseEntity

@Responsebody 用于读取 Request 请求（可能是 POST,PUT,DELETE,GET 请求）的 body 部分并且 Content-Type 为 application/json 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用 HttpMessageConverter 或者自定义的 HttpMessageConverter 将请求的 body 中的 json 字符串转换为 java 对象。

我用一个简单的例子来给演示一下基本使用！

我们有一个注册的接口：

@PostMapping("/sign-up")
public ResponseEntity signUp(@RequestBody @Valid UserRegisterRequest userRegisterRequest) {
  userService.save(userRegisterRequest);
  return ResponseEntity.ok().build();
}

UserRegisterRequest对象：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserRegisterRequest {
    @NotBlank
    private String userName;
    @NotBlank
    private String password;
    @NotBlank
    private String fullName;
}

我们发送 post 请求到这个接口，并且 body 携带 JSON 数据：

{"userName":"coder","fullName":"shuangkou","password":"123456"}

这样我们的后端就可以直接把 json 格式的数据映射到我们的 UserRegisterRequest 类上。

需要注意的是：一个请求方法只可以有一个 @RequestBody，但是可以有多个 @RequestParam 和 @PathVariable。 如果你的方法必须要用两个 @RequestBody 来接受数据的话，大概率是你的数据库设计或者系统设计出问题了！

和标注在方法参数上的 @RequestBody 注解不同，@ResponseBody 注解是标识在整个控制器方法上面的。可以将对应控制器方法的返回值直接作为响应报文体响应到浏览器。

不过更常见的做法是在整个 Controller 类上添加 @RestController 注解。

这是由于 @RestController = @Controller + @ResponseBody（相当于给所有控制器方法都添加了@ResponseBody 注解）。

RequestEntity 用于封装整个请求报文，包括请求体、请求头、请求行。

ResponseEntiry 用于封装包括响应报文在内的一系列响应信息。

参考

1. POST、GET、@RequestBody和@RequestParam区别
2. SpringBoot中@RequestParam @RequestBody @PathVariable的作用