@RequestBody的使用

基础知识介绍：

@RequestBody主要用来接收前端传递给后端的请求体中的数据； GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而需要用POST方式进行提交。在后端的同一个接收方法里，@RequestBody与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。

注意：一个请求，只有一个RequestBody，但是可以有多个RequestParam。
这很好理解，请求体只有一个，请求参数可以有多个

当同时使用@RequestParam()和@RequestBody时，@RequestParam()指定的参数类型可以是普通元素、数组、集合、对象等等
即:当@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是url里的key-value参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。

如果参数是放在请求体中，依照application/json传入后台的话，那么后台要用@RequestBody才能接收到；如果不是放在请求体中的话，那么后台接收前台传过来的参数时，要用@RequestParam来接收，或者形参前什么也不写也能接收。

如果参数前写了@RequestParam(xxx)，那么前端必须有对应的xxx名字才行(不管其是否有值，当然可以通过设置该注解的required属性来调节是否必须传)，如果没有xxx名的话，那么请求会出错，报400。

如果参数前不写@RequestParam(xxx)的话，那么就前端可以自由选择是否传对应xxx的参数，如果有xxx的参数，那么就会自动匹配；没有的话，请求也能正确发送。

追注：这里与feign消费服务时不同；feign消费服务时，如果参数前什么也不写，那么会被默认是 ‘’ @RequestBody的。

如果后端参数是一个对象，且该参数前是以@RequestBody修饰的，那么前端传递json参数时，必须满足以下要求：

1. 后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为) 实体类的对应属性的类型时,会调用实体类的setter方法将值赋给该属性。

2. json字符串中，如果value为"“的话，后端对应属性如果是String类型的，那么接受到的就是”"，如果是后端属性的类型是Integer、Double等类型，那么接收到的就是null。

3. json字符串中，如果value为null的话，后端对应收到的就是null。

如果某个参数没有value的话，在传json字符串给后端时，要么干脆就不把该字段写到json字符串中；要么写value时， 必须有值，null 或"“都行。千万不能有类似"stature”:，这样的写法，如下:

示例详细说明：

User实体类：

Team实体类：

@RequestBody直接以String接收前端传过来的json数据：

Postman测试结果:

@RequestBody以简单对象接收前端传过来的json数据：


@RequestBody以复杂对象接收前端传过来的json数据：

@RequestBody与简单的@RequestParam()同时使用：

@RequestBody接收请求体中的json数据；不加注解接收URL中的数据并组装为对象：

@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方法进行解析。

核心逻辑分析示例：

假设前端传的json串是这样的： {"name1":"邓沙利文","age":123,"mot":"我是一只小小小小鸟~"} 后端的模型只有name和age属性，以及对应的setter/getter方法；给出一般用到的deserializeFromObject(JsonParser p, DeserializationContext ctxt)方法的核心逻辑：

小技巧之指定模型中的属性对应什么key

详细可参考：
public class BeanPropertyMap implements Iterable,Serializable

使用postman测试一下，示例：

全面的结论

结论① ：@JsonAlias注解实现 : json转模型时，使json中的特定key能转化为特定的模型属性;但是模型转json时，对应的转换后的key仍然与属性名一致，如图:

json字符串转换为模型时，json中key为Name或为name123或为name的都能识别,转换后使用的还是最初的name属性

结论②：@JsonProperty注解 实现: json转模型时，使json中的特定key能转化为指定的模型属性；同样的，模型转json时，对应的转换后的key为指定的key,如图:

此时，json字符串转换为模型时，key为MOTTO的能识别，但key为motto的不能识别。

结论③：@JsonAlias注解需要依赖于setter、getter，而@JsonProperty注解不需要。

结论④：在不考虑上述两个注解的一般情况下，key与属性匹配时,默认大小写敏感。

结论⑤：有多个相同的key的json字符串中，转换为模型时，会以相同的几个key中，排在最后的那个key的值给模型属性复制，因为setter会覆盖原来的值。见示例中的gender属性。

结论⑥：后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)实体类的对应属性的类型时，会调用实体类的setter方法将值赋给该属性。

转载自:JustryDeng的博客
原文链接:
https://blog.csdn.net/justry_deng/article/details/80972817/