当前位置: 首页 > news >正文

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

一、前言

一直有这么一个疑问:在使用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 层的写法如下图所示:

image

 

@RequestParam有三个配置参数:

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

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

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

image

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

image

 

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

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

三、@RequestBody

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

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

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

3.1 向表中批量插入数据

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

image

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

image

 

批量向表中插入两条数据,这里的 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>>,具体代码如下图所示:

image

 postman请求:

image

 控制台输出:

image

 

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

四、总结

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

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

五:区别总结

@RequestParam@RequestBody是Spring MVC中常用的参数绑定注解,它们在处理HTTP请求时有以下区别:

  1. 功能:@RequestParam用于将HTTP请求中的参数绑定到方法的参数上,主要用于处理GET请求的参数或POST请求中的表单参数。@RequestBody用于接收整个请求体,并将其转换为方法参数所需的对象或数据类型。
  2. 参数位置:@RequestParam注解通常用于方法的参数上,用于绑定URL中的查询参数或表单参数。@RequestBody注解通常用于方法的参数上,用于接收请求体中的数据。
  3. 数据类型:@RequestParam注解可以绑定简单类型的参数(如字符串、整数等),也可以绑定复杂类型的参数(如自定义对象)。@RequestBody注解通常用于绑定复杂类型的参数,例如JSON格式的请求体,会将请求体的JSON数据转换为指定的Java对象。
  4. 绑定方式:@RequestParam注解通过查询字符串或表单参数的方式来获取参数值。@RequestBody注解通过接收整个请求体,并将其转换为方法参数所需的对象或数据类型。
  5. 使用场景:@RequestParam适用于处理简单的GET请求参数或表单参数,常用于查询操作。@RequestBody适用于处理复杂的请求体数据,例如JSON格式的数据,常用于创建或更新操作。

总结起来,@RequestParam主要用于绑定URL中的查询参数或表单参数,适用于简单的参数绑定;@RequestBody主要用于接收请求体中的数据,适用于复杂的参数绑定和处理。

 

http://www.hskmm.com/?act=detail&tid=28424

相关文章:

  • 2025 最新推荐!大连深海原种海参源头厂家权威榜:聚焦全产业链优质供应商及选购指南青海淡干/青海围堰/青海圈养/青海吊笼/青海网箱/青海大棚海参厂家推荐
  • 博客导航
  • 金碟KIS迷你版v12.0sp1注册补丁/金蝶迷你版破解
  • 2025 年酒店一次性用品源头厂家最新推荐榜单:含牙签牙线筷子套杯盖等多品类品牌及配套能力与质检体系详解
  • MP4和WMV2压缩机制对比 - 详解
  • Rokid JSAR开发:开发实现小游戏语音控制
  • 2025 年餐饮一次性用品实力厂家最新推荐榜单:资质完备、口碑卓越的标杆企业权威甄选餐饮一次性牙签/牙线/筷子套/杯盖用品厂家推荐
  • 金蝶KIS专业版v12.3_破解补丁/金蝶KIS专业版v12.3下载
  • 2025 年金属线槽厂家最新推荐排行榜:涵盖不锈钢 / 铝合金 / 防火 / 大跨距 / 喷塑类型,助您精准选优质厂家企业
  • 金蝶KIS行政事业版v11.0免费补丁/行政事业版11破解版
  • 视觉异常检测系统的机器学习实践
  • 2025 年最新电缆桥架厂家推荐排行榜:精选不锈钢 / 铝合金 / 热镀锌等多类型优质桥架厂家,助力高效选购热镀锌/热浸锌/托盘式/防火/喷塑电缆桥架厂家推荐
  • PK-CWT/600 罗氏线圈在高压输变电线路故障监测中的应用
  • 金蝶店铺版v5.0.7安装包及店铺版v5.0.7破解补丁
  • 模切 vs CO₂激光切割:非金属材料加工工艺终极对决,如何选择?-外协加工-委外加工-专注于河南郑州激光微纳代加工-激光切割雕刻打孔打标镭雕焊接划线表面处理-芯晨微纳(河南)光电科技有限公司
  • 阵列信号处理波束形成
  • 高QE sCMOS相机在SIM超分辨显微成像中的应用 - 详解
  • 基本骨架
  • HTML5-标签语法
  • 金蝶KIS云.标准版v14.0破解补丁(20211201)
  • CNVD 实战笔记:通过 Java 代码审计挖掘 SSRF 漏洞
  • 金蝶KIS账套编辑器v3.0/金蝶KIS降级工具
  • 重生之我是特莉丝
  • 小X被抽到参加运动会
  • 【项目-1】如何根据霍尔信号与反电动势波形关系准确推导出绕组通电顺序?
  • 金蝶KIS专业版v12.1破解补丁/金蝶KIS专业版v12.1_Patch
  • Ai元人文:“悟空之眼”的洞察本质——一种基于历史态势审阅的负价值决策范式
  • 小X的回忆录
  • 智慧记v7.0.x破解补丁及智慧记v7.0安装程序下载
  • 如何通过Midjourney推导图片提示词:借助云漾AI轻松实现