【SpringBoot】@RequestBody的使用
阅读目录
- 基础知识介绍
- 示例详细说明
- `@RequestBody`与前端传过来的`json`数据的匹配规则
- 解析json数据大体流程概述
- 全面的结论
提示: 建议一定要看后面的@RequestBody的核心逻辑源码以及六个重要结论!本文前半部分的内容都是一些基本知识常识,可选择性跳过。
声明:本文是基于SpringBoot,进行的演示说明。
基础知识介绍
@RequestBody
主要用来接收前端传递给后端的json
字符串中的数据(请求体中的数据的);GET方式无请求体,所以使用@RequestBody
接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。在后端的同一个接收方法里,@RequestBody
与@RequestParam()
可以同时使用,@RequestBody
最多只能有一个,而@RequestParam()
可以有多个。
注意:
- 一个请求,只有一个
RequestBody
;一个请求,可以有多个RequestParam
。 - 当同时使用
@RequestParam()
和@RequestBody
时,@RequestParam()
指定的参数可以是普通元素、数组、集合、对象等等(即:当@RequestBody
与@RequestParam()
同时使用时,原SpringMVC接收参数的机制不变,只不过RequestBody
接收的是请求体里面的数据;而RequestParam
接收的是key-value
里面的参数,所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。
即:如果参数时放在请求体中,传入后台的话,那么后台要用@RequestBody
才能接收到;如果不是放在请求体中的话,那么后台接收前台传过来的参数时,要用@RequestParam
来接收,或则形参前什么也不写也能接收。 - 如果参数前写了
@RequestParam(xxx)
,那么前端必须有对应的xxx
名字才行(不管其是否有值,当然可以通过设置该注解的required
属性来调节是否必须传),如果没有xxx
名的话,那么请求会出错,报400。 - 如果参数前不写
@RequestParam(xxx)
的话,那么就前端可以有可以没有对应的xxx
名字才行,如果有xxx
名的话,那么就会自动匹配;没有的话,请求也能正确发送。 - 这里与
feign
消费服务时不同;feign
消费服务时,如果参数前什么也不写,那么会被默认是@RequestBody
的。
如果后端参数是一个对象,且该参数前是以@RequestBody
修饰的,那么前端传递json
参数时,必须满足以下要求:
后端
@RequestBody
注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即:@RequestBody
后面的类)时,会根据json字符串中的key来匹配对应实体类的属性,如果匹配一致且json
中的该key
对应的值符合(或可转换为)实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性。这一条我会在下面详细分析,其他的都可简单略过,但是本文末的核心逻辑代码以及几个结论一定要看!json
字符串中,如果value
为""
的话,后端对应属性如果是String
类型的,那么接受到的就是"",如果是后端属性的类型是Integer
、Double
等类型,那么接收到的就是null
。json
字符串中,如果value
为null
的话,后端对应收到的就是null
。如果某个参数没有
value
的话,在传json
字符串给后端时,要么干脆就不把该字段写到json
字符串中;要么写value
时, 必须有值,null
或""
都行。千万不能有类似"stature":
,这样的写法,如:
注:关于@RequestParam()
的用法,这里就不再一 一说明了,可详见 《程序员成长笔记(一)》中的相关章节。
示例详细说明
先给出两个等下要用到的实体类
User实体类:
Team实体类:
1.@RequestBody
直接以String
接收前端传过来的json
数据:
后端对应的Controller
:
使用PostMan测试:
2.@RequestBody
以复杂对象接收前端传过来的json
数据:
后端对应的Controller
:
使用PostMan测试:
3.@RequestBody
与简单的@RequestParam()
同时使用:
后端对应的Controller
:
使用PostMan测试:
4.@RequestBody
与复杂的@RequestParam()
同时使用:
后端对应的Controller
:
使用PostMan测试:
5.@RequestBody
接收请求体中的json
数据;不加注解接收URL中的数据并组装为对象:
后端对应的Controller
:
使用PostMan测试:
注:如果在后端方法参数前,指定了@RequestParam()
的话,那么前端必须要有对应字段才行(当然可以通过设置该注解的required
属性来调节是否必须传),否者会报错;如果参数前没有任何该注解,那么前端可以传,也可 以不传,如:
上图中,如果我们传参中没有指定token
,那么请求能正常进去,但是token
为null
;如果在String token
前指定了@RequestParam(“token”)
,那么前端必须要有token
这个键时,请求才能正常进去,否者报400
错误。
@RequestBody
与前端传过来的json
数据的匹配规则
声明: 根据不同的Content-Type
等情况,Spring-MVC
会采取不同的HttpMessageConverter
实现来进行信息转换解析。
下面介绍的是最常用的:
前端以Content-Type
为application/json
,传递json
字符串数据; 后端以@RequestBody
模型接收数据的情况。
解析json数据大体流程概述
Http传递请求体信息,最终会被封装进com.fasterxml.jackson.core.json.UTF8StreamJsonParser中
(提示:Spring采用CharacterEncodingFilter
设置了默认编码为UTF-8
),然后在public class BeanDeserializer extends BeanDeserializerBase implements java.io.Serializable中,通过 public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException
方法进行解析。
核心逻辑分析示例
小技巧之指定模型中的属性对应什么key
这里简单介绍,更多的可参考:
public class BeanPropertyMap implements Iterable<SettableBeanProperty>,java.io.Serializable
给出Controller
中的测试类:
给出模型中的属性(setter/getter
方法没截出来):
使用postman测试一下,示例:
上图简单测试了一下,但是测得并不全面,这里就不带大家一起测试了,直接给出。
全面的结论
结论①:@JsonAlias
注解,实现json
转模型时,使json
中的特定key
能转化为特定的模型属性;但是模型转json
时,对应的转换后的key仍然与属性名一致,见:上图示例中的name字段的请求与响应。
以下图进一步说明:
此时,json
字符串转换为模型时,json
中key
为Name
或为name123
或为name
的都能识别。
结论②:@JsonProperty
注解,实现:json
转模型时,使json
中的特定key能转化为指定的模型属性;同样的,模型转json
时,对应的转换后的key
为指定的key
,见:示例中的motto
字段的请求与响应。
以下图进一步说明:
此时,json
字符串转换为模型时,key
为MOTTO
的能识别,但key
为motto
的不能识别。
结论③:@JsonAlias
注解需要依赖于setter
、getter
,而@JsonProperty
注解不需要。
结论④:在不考虑上述两个注解的一般情况下,key
与属性匹配时,默认大小写敏感。
结论⑤:有多个相同的key
的json
字符串中,转换为模型时,会以相同的几个key
中,排在最后的那个key
的值给模型属性复制,因为setter
会覆盖原来的值。见示例中的gender
属性。
结论⑥:后端@RequestBody
注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即@RequestBody
后面的类)时,会根据json
字符串中的key
来匹配对应实体类的属性,如果匹配一致且json
中的该key
对应的值符合(或可转换为)实体类的对应属性的类型要求时,会调用实体类的setter
方法将值赋给该属性。
^_^ 如有不当之处,欢迎指正
^_^ 代码托管链接
https://github.com/JustryDeng/PublicRepository/tree/master/Abc_RequestBodyAndRequestParam
^_^ 本文已经被收录进《程序员成长笔记(二)》,笔者JustryDeng
【SpringBoot】@RequestBody的使用相关推荐
- springboot @RequestBody 接收字符串
前言 springboot 2.1.1.RELEASE @RequestBody 接收字符串 @RequestMapping(method = {RequestMethod.POST})public ...
- SpringBoot - @RequestBody、@ResponseBody的使用场景
写在前面 @RequestBody和@ResponseBody是Spring中的两个注解,简单来说: @RequestBody,用于将前端发送来的JSON/XML格式的数据转化为JAVABEAN对象: ...
- SpringBoot RequestBody ajax提交对象
前端实现: var student = {"name":1,"age":2,"score":3 }; $.ajax({ url:" ...
- SpringBoot_JsonFormat日期序列化
文章目录 SpringBoot_JsonFormat日期序列化 1.什么是@JsonFormat 2.兼容多种格式时间字符串 3.参考链接 SpringBoot_JsonFormat日期序列化 1.什 ...
- SpringBoot 中 @RequestBody的正确使用方法
SpringBoot 中 @RequestBody的正确使用方法 最近在接收一个要离职同事的工作,接手的项目是用SpringBoot搭建的,其中看到了这样的写法: [java] view plain ...
- SpringBoot关于@RequestBody请求参数
一.Post请求中Dto参数带@RequestBody 方法代码: @PostMapping("/test")public UserDto getUserParam(@Reques ...
- SpringBoot普通参数与基本注解(@PathVariable、@RequestHeader、@RequestParam、@RequestBody)
基本注解 @PathVariable(获取路径变量) @RequestParam(获取请求参数) @RequestHeader(获取请求头) @RequestBody(获取请求体[POST]) @Pa ...
- springboot配置拦截器,在拦截器中获取@RequestBody注解参数和post请求参数以及get请求参数
1.配置拦截器 package com.jy.gxw.config.interceptor;import org.springframework.beans.factory.annotation.Au ...
- springboot接收多对象_SpringBoot Controller 中使用多个@RequestBody的正确姿势
最近遇到Controller中需要多个@RequestBody的情况,但是发现并不支持这种写法, 这样导致 1.单个字符串等包装类型都要写一个对象才可以用@RequestBody接收: 2.多个对象需 ...
最新文章
- 沃森世界研讨会前瞻:AI服务 了解客户情绪
- python在内存中生成Zip文件!
- 没有安装提供程序“System.Data.SqlServerCe.3.5”的解决方法
- Spring Boot - 自动装配中的不可忽视的@Import
- additive tree
- 数据结构与算法 / 默克尔树
- OpenGL ES之GLSL实现仿抖音“分屏滤镜”效果
- java md5算法_JAVA实现MD5算法
- lbp2900打印机linux驱动下载,lbp2900打印机驱动下载
- 计算机网络协议名词解析,网络协议名词解释
- Zuken CADSTAR 16 破解过程
- 用STM32F407开发板实现4G模块L610发送短信功能
- shell编程三大神器之sed
- 计算机光驱无法启用,光驱提示:无法访问G:\函数不正确解决方法
- adb基础命令学习随笔
- 删掉wps后台烂进程
- 魔戒中超眩的武器装备!
- 热销超极本iFunk翼S到底怎么样?
- 机器学习之随机森林RandomForestRegressor
- adb命令获取sys_adb shell dumpsys 命令