注解@RequestParam与@RequestBody的使用场景

 

在这篇文章中：

• 一、前言
• 二、@RequestParam
• 三、@RequestBody
  • 3.1 向表中批量插入数据
  • 3.2 后端解析json数据
• 四、总结

每一个成功人士的背后，必定曾经做出过勇敢而又孤独的决定。

放弃不难，但坚持很酷~

一、前言

一直有这么一个疑问：在使用postman工具测试api接口的时候，如何使用 json 字符串传值呢，而不是使用 x-www-form-urlencoded 类型，毕竟通过 key-value 传值是有局限性的。假如我要测试批量插入数据的接口呢，使用 x-www-form-urlencoded 方法根本就不适用于这种场景。

那么如何通过postman工具使用json字符串传值呢，这里就引申出来了spring的两个注解：

• @RequestParam
• @RequestBody

总而言之，这两个注解都可以在后台接收参数，但是使用场景不一样。继续往下看 ↓

二、@RequestParam

先介绍一下@RequestParam的使用场景：

注解@RequestParam接收的参数是来自requestHeader中，即请求头。通常用于GET请求，比如常见的url：http://localhost:8081/spring-boot-study/novel/findByAuthorAndType?author=唐家三少&type=已完结，其在Controller 层的写法如下图所示：

@RequestParam有三个配置参数：

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

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

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

由于@RequestParam是用来处理 Content-Type 为 application/x-www-form-urlencoded 编码的内容的，所以在postman中，要选择body的类型为 x-www-form-urlencoded，这样在headers中就自动变为了 Content-Type : application/x-www-form-urlencoded 编码格式。如下图所示：

但是这样不支持批量插入数据啊，如果改用 json 字符串来传值的话，类型设置为 application/json，点击发送的话，会报错，后台接收不到值，为 null。

这时候，注解@RequestBody就派上用场了。继续往下看 ↓

三、@RequestBody

先介绍一下@RequestBody的使用场景：

注解@RequestBody接收的参数是来自requestBody中，即请求体。一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据。

就application/json类型的数据而言，使用注解@RequestBody可以将body里面所有的json数据传到后端，后端再进行解析。

3.1 向表中批量插入数据

举个批量插入数据的例子，Controller层的写法如下图所示：

由于@RequestBody可用来处理 Content-Type 为 application/json 编码的内容，所以在postman中，选择body的类型为row -> JSON(application/json)，这样在 Headers 中也会自动变为 Content-Type : application/json 编码格式。body内的数据如下图所示：

批量向表中插入两条数据，这里的 saveBatchNovel()方法已经封装了 JPA的 saveAll() 方法。body 里面的 json 语句的 key 值要与后端实体类的属性一一对应。

注意：前端使用$.ajax的话，一定要指定 contentType: "application/json;charset=utf-8;"，默认为 application/x-www-form-urlencoded。

3.2 后端解析json数据

上述示例是传递到实体类中的具体写法，那么如果传递到非实体类中，body里面的json数据需要怎么解析呢？我们再来看下面这个例子：

在body中，我们还是输入上面的json数据，根据分析，上面的json数据是一个List数组内嵌套着map对象，那么在后台的接收形式可写为 List<Map<String, String>>，具体代码如下图所示：

postman请求：

控制台输出：

得出结论，通过@RequestBody可以解析Body中json格式的数据。

四、总结

注解@RequestParam接收的参数是来自requestHeader中，即请求头。通常用于GET请求，像POST、DELETE等其它类型的请求也可以使用。

注解@RequestBody接收的参数是来自requestBody中，即请求体。一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据。通常用于接收POST、DELETE等类型的请求数据，GET类型也可以适用。

总算把这两个的逻辑理清楚了，postman也会用json传值了！

源码已上传至https://github.com/841809077/spring-boot-study。