基础知识介绍
@requestbody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);get方式无请求体,所以使用@requestbody接收数据时,前端不能使用get方式提交数据,而是用post方式进行提交。
在后端的同一个接收方法里,@requestbody与@requestparam()可以同时使用,@requestbody最多只能有一个,而@requestparam()可以有多个。
即:
- 如果参数时放在请求体中,application/json传入后台的话,那么后台要用@requestbody才能接收到;
- 如果不是放在请求体中的话,那么后台接收前台传过来的参数时,要用@requestparam来接收,或则形参前 什么也不写也能接收。
- 如果参数前写了@requestparam(xxx),那么前端必须有对应的xxx名字才行(不管其是否有值,当然可以通过设置该注解的required属性来调节是否必须传),如果没有xxx名的话,那么请求会出错,报400。
- 如果参数前不写@requestparam(xxx)的话,那么就前端可以有可以没有对应的xxx名字才行,如果有xxx名的话,那么就会自动匹配;没有的话,请求也能正确发送。
- 这里与feign消费服务时不同;feign消费服务时,如果参数前什么也不写,那么会被默认是@requestbody的。
如果后端参数是一个对象,且该参数前是以@requestbody修饰的,那么前端传递json参数时,必须满足以下要求:
- 后端@requestbody注解对应的类在将http的输入流(含请求体)装配到目标类时,会根据json字符串中的key来匹配对应实体类的属性,如果匹配一致且json中的该key对应的值符合,实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性。
- json字符串中,如果value为""的话,后端对应属性如果是string类型的,那么接受到的就是"",如果是后端属性的类型是integer、double等类型,那么接收到的就是null。
- json字符串中,如果value为null的话,后端对应收到的就是null。
- 如果某个参数没有value的话,在传json字符串给后端时,要么干脆就不把该字段写到json字符串中;要么写value时, 必须有值,null 或""都行。
示例详细说明
先给出两个等下要用到的实体类
user实体类:

team实体类:

@requestbody直接以string接收前端传过来的json数据
后端对应的controller:

使用postman测试:

@requestbody以简单对象接收前端传过来的json数据
后端对应的controller:

使用postman测试:

@requestbody以复杂对象接收前端传过来的json数据
后端对应的controller:

使用postman测试:

@requestbody与简单的@requestparam()同时使用
后端对应的controller:

使用postman测试:

@requestbody与复杂的@requestparam()同时使用
后端对应的controller:

使用postman测试:

@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),然后在beandeserializer中,通过deserializefromobject(jsonparser p, deserializationcontext ctxt) throws ioexception方法进行解析。
核心逻辑分析示例
假设前端传的json串是这样的: {"name1":"邓沙利文","age":123,"mot":"我是一只小小小小鸟~"} 后端的模型只有name和age属性,以及对应的setter/getter方法;给出一般用到的deserializefromobject(jsonparser p, deserializationcontext ctxt)方法的核心逻辑:

结论
结论①:@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方法将值赋给该属性。
最后
以上为个人经验,希望能给大家一个参考,也希望大家多多支持代码网。
发表评论