Spring中使用@RequestBody注解接收的实体类中的某些参数为null

1、问题描述

我写完一个接口，在用postman测试的时候，发现其中有一个参数cEnterpriseId明明是有值的，但接口controller接收到的该参数为null，但其他参数都不为null的。

2、解决方法

我首先去百度了一下，说是由于实体类的参数命名不规范导致的，没有按照标准“驼峰法”进行参数命名。也可以在实体类相应的参数上加上@JsonProperty(value="xxx")来解决。

解决方法一、

加@JsonProperty注解

在实体类的cEnterpriseId参数上加上@JsonProperty(value = "cEnterpriseId")就解决了。

解决方法二、

手动在实体类添加get / set方法

解决方法三、

把postman传参的cEnterpriseId改成小写centerpriseId

3、产生原因

我看网上不少说产生类似的问题@RequestBody获取的参数为null是由于springboot解析器在解析json过程中出现问题，因字段名驼峰命名无法匹配字段名导致。spring框架在接收参数的时候的get()方法无法识别参数。

不过我感觉这样子说的太笼统了，无法解答我的困惑。

后来我仔细研究了一下，简单说一下我的看法和理解吧。

首先我在实体类CustomerUsecaseJourneyBO上加了@Data注解，@Data注解大家应该都熟悉，就是用来生成实体类的get和set方法并隐藏get/set方法的。

那么对于cEnterpriseId这个参数，@Data注解自动为它生成的get/set方法是这样子的：

然后我用idea工具，自动在实体类中生成了一下cEnterpriseId的get/set方法。

@Data生成的是getCEnterpriseId()/setCEnterpriseId()，而idea自动生成的是getcEnterpriseId()/setcEnterpriseId()。

我用postman传一个json到接口，json在传输过程中会被转为“字节流”。接口controller层的@RequestBody加在实体类参数前面，会把接收到的字节流反序列成为一个java实体类。@RequestBody在反序列化的时候给实体类赋值使用的get/set方法是同idea自动生成的get/set方法，即：getcEnterpriseId()/setcEnterpriseId()。所以@RequestBody是用setcEnterpriseId()给是实体类CustomerUsecaseJourneyBO赋值，但在CustomerUsecaseJourneyBO类中setcEnterpriseId()是不存在的，CustomerUsecaseJourneyBO类中只有setCEnterpriseId()。

setcEnterpriseId() 不等于 setCEnterpriseId()。

当然其实也可以不加@JsonProperty注解，只需修改一下postman传参的大小写就行了。

把cEnterpriseId改成centerpriseId，因为centerpriseId对应的get/set方法是getcEnterpriseId()/setcEnterpriseId()。

梳理了一下，大致的流程是这样的

关于json被@RequestBody反序列化给实体类的具体过程可以参考一下这篇：@RequestBody的使用_JustryDeng-CSDN博客_@requestbody

4、总结

@RequestBody反序列化实体类部分值为null，这个问题以前没有碰到过，后来经研究发现竟然是参数命名不符合“驼峰法”，cEnterpriseId对应的数据库表字段是c_enterpriseId，我的idea工具装了阿里巴巴代码规范检测插件明明检查结果是“cEnterpriseId”是一个合法的参数命名，因此是因为cEnterpriseId命名不规范导致@RequestBody反序列化set不了实体类的参数，显然也是解释不通的。

不过我也是第一次发现注解@Data生成的get/set方法和idea工具自动生成的get/set在命名上竟然会不一致。

不过@Data生成的get/set方法是会被覆盖的。因此看来以后写实体类在加@Data注解时要多留个心眼，最好在实体类中写get/set方法，而不是通过@Data隐藏封装get/set方法。另外如果涉及前端的json的化，最好一定要加@JsonProperty。来保证实体类中的字段与json一一对应上。