专栏首页大数据实战演练注解@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。

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

本文分享自微信公众号 - 大数据实战演练(gh_f942bfc92d26),作者:CREATE 17

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-04-08

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • @RequestBody和@RequestParam区别

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

    chenchenchen
  • GET请求使用@RequestBody的正确姿势

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

    明明如月学长
  • @requestparam和@PathVariable和@param和@RequestParam区别

    解决前台参数名称与后台接收参数变量名称不一致的问题,等价于request.getParam

  • SpringMVC(2)——注解

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

    羊羽shine
  • 【SpringBoot注解-5】web项目相关注解

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

    云深i不知处
  • SpringMVC组件-常用注解学习笔记

    ​ required:请求参数中是否必须提供此参数,默认值:true 表示必须提供,如果不提供将报错

    地道小菜鸟
  • SpringMVC组件-常用注解学习笔记

    ​ required:请求参数中是否必须提供此参数,默认值:true 表示必须提供,如果不提供将报错

    地道小菜鸟
  • SpringMVC组件-常用注解学习笔记

    ​ required:请求参数中是否必须提供此参数,默认值:true 表示必须提供,如果不提供将报错

    地道小菜鸟
  • Spring Cloud开发注意事项

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

    lyb-geek
  • java之@RequestBody的使用

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

    botkenni
  • @PathVariable和@RequestBody 和 @Requestparam和HttpServletRequest 的区别

    @PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上。//配置url和方法的一个关系*@RequestMapping(“item/{...

    逐梦的青春
  • Springmvc注解

    //conversionServiceFactoryBean,这里只是注册了一个服务或者说配置了一个组件(和类里面类型转换的类还没有关系)

    阮键
  • springcloud系列之-快速上手feign

    Feign是一个声明式WebService客户端.使用Feign能让编写WebService客户端更加简单,它的使用方法是定义一个接口,然后在上面添加注解,同时...

    AI码师
  • springcloud系列之-快速上手hystrix

    hystrix是netflix针对微服务分布式系统采用的熔断保护中间件,hystrix提供了在服务不可达或请求超时之后,优雅的给客户端返回响应结果。

    AI码师
  • 面试不是无情物,参数注解知多少?

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

    程序员爱酸奶
  • 【刨根问底】在Springboot中MVC的常用注解<下>

    http://localhost:9010/user/login?userName=lawt&&password=123456

    田维常
  • Java工作中遇到的问题Method has too many Body parameters的处理办法SpringCloud Feign报错:Method has too many Body par

    @RequestMapping(value="/test", method=RequestMethod.GET) ​​​​​​​

    botkenni
  • @RequestParam,@RequestBody,@PathVariable注解还分不清吗?

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

    niceyoo
  • SpringMVC请求参数和响应结果全局加密和解密

    前段时间在做一个对外的网关项目,涉及到加密和解密模块,这里详细分析解决方案和适用的场景。为了模拟真实的交互场景,先定制一下整个交互流程。第三方传输(包括请求和响...

    Throwable

扫码关注云+社区

领取腾讯云代金券