后台返回给前端json字段的大小写问题，Lombok的坑@Data，@Getter

╰半橙微兮° 2023-09-30 11:48 6阅读 0赞

## Lombok的@Data注解踩坑，@Setter的大小写问题 ##

以前在处理前端请求的实体类的时候，都是用Lombok的@Data注解对实体类进行getter、setter以及toString的声名，今天处理实体类的时候，发现生成的setter方法和Java Bean的命名规则不一致。（@Data的作用是为我们定义的字段添加Lombok的@ToString、@EqualsAndHashCode、 @Getter方法、@RequiredArgsConstructor 和 为非final字段添加@Setter）

我要生成getter、setter的字段是：

private List<Map<String,String>> yAxis;
        private List<XAxis> xAxis;

在我使用@Data时生成的代码和实际要生成的代码比较如下：

//@Data生成的setter方法
    setYAxis()  setXAxis()
    //实际需要的setter方法
    setyAxis()  setxAxis()

Java Bean的4种命名特殊规范中有一种情况：**如果属性名的第二个字母大写，那么该属性名直接用作 getter/setter 方法中 get/set 的后部分**，就是说大小写不变。例如属性名为uName，方法是getuName/setuName。

字段的**首字母大小写**发生了变化。这个变化意味着，我在使用@Data注解生成的getter方法得到的属性值是"**yaxis**"和"**xaxis**"，而实际上我需要的属性值为"**yAxis**"和"**xAxis**"，这也就导致了我返回给前端的数据，前端无法识别，从而出错。

## JavaBean getter/setter命名规范\[特例\] ##

一般JavaBean属性以小写字母开头，驼峰命名格式，相应的 getter/setter 方法是 get/set 接上首字母大写的属性名。例如：属性名为userName，其对应的getter/setter 方法是 getUserName/setUserName。

但是，还有一些特殊情况：

1.  如果属性名的第二个字母大写，那么该属性名直接用作 getter/setter 方法中 get/set 的后部分，就是说大小写不变。例如属性名为uName，方法是getuName/setuName。
2.  如果属性名的前两个字母是大写（一般的专有名词和缩略词都会大写），也是属性名直接用作 getter/setter 方法中 get/set 的后部分。例如属性名为URL，方法是getURL/setURL。
3.  如果属性名的首字母大写，也是属性名直接用作 getter/setter 方法中 get/set 的后部分。例如属性名为Name，方法是getName/setName，这种是最糟糕的情况，会找不到属性出错，因为默认的属性名是name。
4.  如果属性名以"is"开头，则getter方法会省掉get，set方法会去掉is。例如属性名为isOK，方法是isOK/setOK。  
    需要注意的是有些开发工具自动生成的getter/setter方法，并没有考虑到上面所说的特例情况，会导致bug的产生。

我们在定义JavaBean的属性名时，应该尽量避免属性名的头两个字母中任意一个为大写以及属性名以"is"开头。