学习
实践
活动
工具
TVP
写文章
专栏首页大数据实战演练注解@RequestParam与@RequestBody的使用场景

注解@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 层的写法如下图所示:

@RequestParam有三个配置参数:

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

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

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

由于@RequestParam是用来处理 Content-Typeapplication/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/jsonapplication/xml等类型的数据。

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

3.1 向表中批量插入数据

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

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

批量向表中插入两条数据,这里的 saveBatchNovel()方法已经封装了 JPAsaveAll() 方法。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/jsonapplication/xml等类型的数据。通常用于接收POST、DELETE等类型的请求数据,GET类型也可以适用。

总算把这两个的逻辑理清楚了,postman也会用json传值了!赶紧整理成笔记,与大家分享?

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

求大家点点好看??,给点鼓励。

文章分享自微信公众号:
大数据实战演练

本文参与 腾讯云自媒体分享计划 ,欢迎热爱写作的你一起参与!

作者:CREATE 17
原始发表时间:2019-04-08
如有侵权,请联系 cloudcommunity@tencent.com 删除。
登录 后参与评论
0 条评论

相关文章

  • 使用RequestBody注解需要注意的地方

    使用@RequestBody注解需要注意的地方就是,一定不要把get请求跟@RequestBody这个注解用在一块,get请求时没有请求体的,

    johnhuster的分享
  • RequestBody注解的使用场景你都不懂,先回去等通知吧!

    温馨提示: 本文总共3010字,阅读完大概需要3-4分钟,希望您能耐心看完,倘若你对该知识点已经比较熟悉,你可以直接通过目录跳转到你感兴趣的地方,希望阅读本...

    IT学习日记
  • 浅谈@RequestMapping @ResponseBody 和 @RequestBody 注解的用法与区别

    国际惯例先介绍什么是@RequestMapping,@RequestMapping 是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有...

    全栈程序员站长
  • Spring MVC中的@RequestParam注解的使用指南

    在这个快速教程中,我们将研究一下Spring的@RequestParam注解。简而言之,我们可以使用@RequestParam从请求中提取查询参数,表单参数甚至...

    码农小胖哥
  • Spring中的注解 @RequestBody和@ResponseBody的使用和区别

    @RequestBody的作用是将前端传来的json格式的数据转为自己定义好的javabean对象 如图以微信小程序为例,前端向后端传入如下json格式的数据...

    全栈程序员站长
  • @RequestParam、@RequestBody、@PathVariable区别和案例分析

    掉发的小王
  • @RequestParam,@RequestBody,@PathVariable注解还分不清吗?

    在使用 SpringMVC 开发时,经常遇到前端传递的各种参数,比如 form 表单,JSON 数据,String[] 数组,再或者是最常见的 String 字...

    niceyoo
  • POST、GET、@RequestBody和@RequestParam区别

    注解@RequestParam接收的参数是来自HTTP请求体或请求url的QueryString中。

    chenchenchen
  • Java 注解 —— 注解的理解、注解的使用与自定义注解

    版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.n...

    剑影啸清寒
  • @RequestBody和@RequestParam区别

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

    chenchenchen
  • POST、GET、@RequestBody和@RequestParam区别[通俗易懂]

    注解@RequestParam接收的参数是来自HTTP请求体或请求url的QueryString中。

    全栈程序员站长
  • @RequestBody的使用[通俗易懂]

    提示:建议一定要看后面的@RequestBody的核心逻辑源码以及六个重要结论!本文前半部分的内容都是一些基 本知识常识,可选择性跳过。

    全栈程序员站长
  • GET请求使用@RequestBody的正确姿势

    但是由于GET的参数是通过Url方式传递的,而不是请求体传递的所以无法通过@RequestBody注解来接收。

    明明如月学长
  • java之@RequestBody的使用

    @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);GET方式无请求体,所以使用@RequestB...

    botkenni
  • SpringMVC(2)——注解

    spring提供了多个注解声明bean为Spring管理的Bean @Controller 声明此类事一个MVC类,通常与@RequestMapping一起使...

    羊羽shine
  • Spring Cloud开发注意事项

    如果provider中需要引入其他feign client的接口,需在 provider的启动类添加注解 @EnableFeignClients(basePac...

    lyb-geek
  • 【SpringBoot注解-5】web项目相关注解

    @RestController 是MVC中应用非常频繁的一个注解,也是 SpringBoot 新增的一个注解,包括:

    云深i不知处
  • 面试不是无情物,参数注解知多少?

    前两天面试的,面试官问我用在参数上的注解有哪些?我想了一下说有RequestParam,每个参数都需要RequestParam修饰,可以设置required 等...

    程序员爱酸奶

扫码关注腾讯云开发者

领取腾讯云代金券