理解SpringBoot注解s · Mr.li's Blog

@ReuqestBody和@RequestParam

这两个注解都是在Controller某个Mapping函数的形参前加上的，但两个具体有什么区别呢？在使用的时候我们该如何选择呢? 这跟我们希望用户以什么形式来请求接口有关。

众所周知，请求头的Content-type有多个，如

常见的媒体格式类型如下：

text/html ： HTML格式
text/plain ：纯文本格式
text/xml ： XML格式
image/gif ：gif图片格式
image/jpeg ：jpg图片格式
image/png：png图片格式

以application开头的媒体格式类型：

application/xhtml+xml ：XHTML格式
application/xml： XML数据格式
application/atom+xml ：Atom XML聚合格式
⭐️application/json： JSON数据格式
application/pdf：pdf格式
application/msword ： Word文档格式
application/octet-stream ：二进制流数据（如常见的文件下载）
⭐️application/x-www-form-urlencoded ：<form encType="">中默认的encType，form表单数据被编码为key/value格式发送到服务器（表单默认的提交数据的格式）

另外一种常见的媒体格式是上传文件之时使用的：

multipart/form-data ：需要在表单中进行文件上传时，就需要使用该格式

其中，POST请求最常用的是application/x-www-form-urlencoded,浏览器的原生 form 表单，如果不设置 enctype 属性，那么最终就会以 application/x-www-form-urlencoded 方式提交数据。数据按照 key1=val1&key2=val2 的方式进行编码，key 和 val 都进行了 URL 转码。请求类似于下面这样

post-www

此外，application/json也是POST比较常用的一种形式，也是目前比较推荐的，用来告诉服务端消息主体是序列化后的 JSON 字符串。在这种编码方式下，请求内容如下：

post-json

可以看出，无论是哪种编码，POST基本上都是从请求体中取数据解析的。而@RequestBody正是对应的请求体；@RequestParam呢，接收的参数是来自requestHeader中，即请求头。通常用于GET请求，功能是从URL中提取请求参数。比如常见的url：http://localhost:8081/spring-boot-study/novel/findByAuthorAndType?author=唐家三少&type=已完结。对应的接口为public List<NovelEntity> findByAuthorAndType(@RequestParam(value="author", required=false,defaultValue="天蚕土豆") String author, @RequestParam(value="type") String type)

@RequestParam有三个配置参数：

required 表示是否必须，默认为 true，必须。
defaultValue 可设置请求参数的默认值。
value 为接收url参数的参数名（相当于key值）。

@RequestParam用来处理 Content-Type 为 application/x-www-form-urlencoded 编码的内容，Content-Type默认为该属性。

@RequestParam也可用于其它类型的请求，例如：GET、POST、DELETE等请求。比如向表中插入单条数据，Controller 层的写法如下图所示：

但是，这样不支持批量插入数据，相对之下，json来表达的优势就很明显，但是@RequestParam没办法处理application/json，点击发送的话，会报错后台接收不到值，为 null。

此时就需要使用对应的@RequestBody，它一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据。就application/json类型的数据而言，使用注解@RequestBody可以将body里面所有的json数据传到后端，后端再进行解析。如public Map<String, Boolean> saveBatchNovel(@RequestBody List<NovelEntity> novelEntityList)

此外，针对希望用户传入的为指定参数的话，有相应的Entity，使用@RequestBody会根据请求主体中的参数名与对象的属性名进行匹配并绑定值，自动将参数封装成该对象，并且还可以通过@Valid注解对请求主体中的参数进行校验。

总结：

@RequestParam的核心功能是从URL中提取请求参数，即接收的参数是来自HTTP请求头的QueryString中。
@RequestBody功能是从请求体重提取参数，并封装成对象

额外经验总结：

标准协议下，通常认为GET请求是没有请求体的，只有POST请求有请求体

get请求只能传query参数，query参数都是拼在请求地址上的

post可以同时传body和query两种形式的参数

@RestController
@RequestMapping("/hello")
public class HelloController {
    @PostMapping("/post/{id}")
    public Map<String, String> postHello(@PathVariable Long id,
                                         @RequestParam(value = "name", required = false, defaultValue = "CL") String name,
                                         @RequestBody User user
    ) {
        System.out.println(user);
        return new HashMap<String, String>() {{
            put("name", name);
            put("id", String.valueOf(id));
        }};
    }
}

@Data
class User{
    private int id;
    private int age;
}

talent-API

post-query+body

postman-web

post+body+query2

针对接口的测试，最好还是手动设置Content-type比较好

@PathVariable

承接上文，同样作为参数传入的还有@PathVariable，它可以从URL中提取变量

@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板变量上。特别地，@PathVariable注解允许我们使用value或name属性来给参数取一个别名。下面是使用此注解的一个示例：

@GetMapping("/users/{id}/roles/{roleId}")
public Role getUserRole(@PathVariable long id, @PathVariable long roleId){

}

模板变量名需要使用{ }进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。