Spring中@RequestParam与@RequestBody的使用场景详解

 更新时间:2023年12月04日 09:47:36   作者:制造bug的键盘钢琴师  
这篇文章主要介绍了Spring中@RequestParam与@RequestBody的使用场景详解,注解@RequestParam接收的参数是来自requestHeader中即请求头或body请求体,通常用于GET请求,比如常见的url等,需要的朋友可以参考下

一、前言

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

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

  • @RequestParam
  • @RequestBody

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

二、@RequestParam

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

注解@RequestParam接收的参数是来自requestHeader中即请求头或body(请求体)。

通常用于GET请求,比如常见的url://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>>,具体代码如下图所示:

在这里插入图片描述

在这里插入图片描述

控制台输出:

在这里插入图片描述

四、总结

注解@RequestParam接收的参数是来自requestHeader中,即请求头。

通常用于GET请求,像POST、DELETE等其它类型的请求也可以使用。

注解@RequestBody接收的参数是来自requestBody中,即请求体。

一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据,比如:application/json、application/xml等类型的数据。通常用于接收POST、DELETE等类型的请求数据,GET类型也可以适用。

**重点补充:

**在使用注解@RequestParam的时候【不加注解的时候效果与@RequestParam类似】,在body data中我们不能传json字符串类型的参数,否则对象中是接收不到传递参数相应的值。

相应的在@RequestBody注解标记的形式上传递表格参数则会报错。

postman模拟发送请求【@RequestParam接受json字符串】:

在这里插入图片描述

debug断点后页面展示的结果:

在这里插入图片描述

postman模拟发送请求【@RequestBody接受application/x-www-form-urlencoded表格参数】:

在这里插入图片描述

代码以及报错显示:

在这里插入图片描述

到此这篇关于Spring中@RequestParam与@RequestBody的使用场景详解的文章就介绍到这了,更多相关@RequestParam与@RequestBody注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java使用@Transactional时常犯的N种错误

    java使用@Transactional时常犯的N种错误

    @Transactional是我们在用Spring时候几乎逃不掉的一个注解,本文主要介绍了使用 @Transactional 时常犯的N种错误,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Java实现常用缓存淘汰算法:FIFO、LRU、LFU

    Java实现常用缓存淘汰算法:FIFO、LRU、LFU

    在高并发、高性能的质量要求不断提高时,我们首先会想到的就是利用缓存予以应对。而常用的几个缓存淘汰算法有:FIFO、LRU和LFU,本文将为大家详细介绍一下这三个算法并用java实现,感兴趣的可以跟随小编一起学习一下
    2021-12-12
  • flyway实现java 自动升级SQL脚本的问题及解决方法

    flyway实现java 自动升级SQL脚本的问题及解决方法

    大家在平时开发自己写SQL语句忘记在所有环境执行,需要新增环境做数据迁移,那么遇到这样的问题该如何解决呢?本文通过场景分析给大家介绍java 自动升级SQL脚本的策略,感兴趣的朋友一起看看吧
    2021-07-07
  • Java实战之实现在线小说阅读系统

    Java实战之实现在线小说阅读系统

    本文主要介绍了一个通过Java实现的在线电子书小说阅读系统,文中用到的技术有Layui、Springboot、SpringMVC、HTML、FTP、JavaScript、JQuery等,感兴趣的可以试试
    2022-01-01
  • SpringBoot使用freemarker导出word文件方法详解

    SpringBoot使用freemarker导出word文件方法详解

    这篇文章主要介绍了SpringBoot使用freemarker导出word文件方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-11-11
  • Java中字符串和byte数组之间的简单转换方法

    Java中字符串和byte数组之间的简单转换方法

    这篇文章主要给大家介绍了关于Java中字符串和byte数组之间的简单转换方法,Java中将String类型转换为byte[]类型,可以使用String的getBytes()方法,还有很多其他的办法,需要的朋友可以参考下
    2023-08-08
  • Springboot实现人脸识别与WebSocket长连接的实现代码

    Springboot实现人脸识别与WebSocket长连接的实现代码

    这篇文章主要介绍了Springboot实现人脸识别与WebSocket长连接的实现,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-11-11
  • java判断远程服务器上的文件是否存在的方法

    java判断远程服务器上的文件是否存在的方法

    java判断远程服务器上的文件是否存在的方法,需要的朋友可以参考一下
    2013-03-03
  • SpringBoot集成Mybatis-plus并实现自动生成相关文件的示例代码

    SpringBoot集成Mybatis-plus并实现自动生成相关文件的示例代码

    Mybatis-Plus是一个优秀的Mybatis增强工具,目前更新到3.1.1,本文通过示例代码给大家介绍SpringBoot集成Mybatis-plus并实现自动生成相关文件的问题,感兴趣的朋友跟随小编一起看看吧
    2021-12-12
  • java大话之创建型设计模式教程示例

    java大话之创建型设计模式教程示例

    这篇文章主要为大家介绍了java大话之创建型设计模式教程示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02

最新评论