序言
在项目中使用 Lombok 后,Getter、Setter、toString 等重复方法不用再手写,确实省了不少事。但使用过程中,我也遇到了两个不太容易察觉的问题:一个导致 MyBatis 插入时属性值变成 null,另一个让 EasyExcel 无法正常转换实体类。
起初很难直接把问题和 Lombok 联系起来,跟踪相关组件源码后,才发现问题出在属性访问方法的命名和返回值上。
Setter 和 Getter 的命名问题
问题发现
项目中使用 Lombok 的 @Data 生成 Getter 和 Setter。一次通过 MyBatis 插入数据时,遇到了一个特殊情况。
实体类大致如下:
@Data
public class NMetaVerify {
private NMetaType nMetaType;
private Long id;
// 其他属性
}
插入数据库后,其他属性都正常,只有 nMetaType 对应的值一直是 null。
排查过程
调试时,在调用 MyBatis 插入 SQL 对应的方法之前,NMetaVerify 对象里的 nMetaType 仍然有值。执行插入后,数据库中的值却是 null。
我最初怀疑枚举类型的写法有问题,但检查其他包含枚举的实体后,发现它们都能正常插入。于是继续跟踪 MyBatis 源码,发现它通过反射获取属性值,而 nMetaType 对应的 Getter 名称与属性解析结果对不上。
原因
在这个案例中,属性 nMetaType 的第一个字母小写、第二个字母大写。Lombok 生成的访问方法,与 MyBatis 按方法名解析出的属性名称产生了差异。
Lombok 生成的方法在调用时表现如下:
@Data
public class NMetaVerify {
private Long id;
private NMetaType nMetaType;
private Date createTime;
public void lombokFound() {
NMetaVerify nMetaVerify = new NMetaVerify();
nMetaVerify.setNMetaType(NMetaType.TWO);
nMetaVerify.getNMetaType();
}
}
这里的方法名分别是 setNMetaType 和 getNMetaType,其中属性名开头的 n 被转换成了大写。
而针对这个属性,也可以使用下面的 Getter 和 Setter 写法:
public class NMetaVerify {
private Long id;
private NMetaType nMetaType;
private Date createTime;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public NMetaType getnMetaType() {
return nMetaType;
}
public void setnMetaType(NMetaType nMetaType) {
this.nMetaType = nMetaType;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
}
两种写法只差一个字母的大小写,MyBatis 解析出来的属性名却不同。下面以 MyBatis 3.4.6 为例分析。
MyBatis 解析属性名的源码
PropertyNamer 根据 Getter、Setter 的方法名推导属性名:
package org.apache.ibatis.reflection.property;
import java.util.Locale;
import org.apache.ibatis.reflection.ReflectionException;
/**
* @author Clinton Begin
*/
public final class PropertyNamer {
private PropertyNamer() {
// Prevent Instantiation of Static Class
}
public static String methodToProperty(String name) {
if (name.startsWith("is")) {
name = name.substring(2);
} else if (name.startsWith("get") || name.startsWith("set")) {
name = name.substring(3);
} else {
throw new ReflectionException(
"Error parsing property name '" + name
+ "'. Didn't start with 'is', 'get' or 'set'."
);
}
if (name.length() == 1
|| (name.length() > 1 && !Character.isUpperCase(name.charAt(1)))) {
name = name.substring(0, 1).toLowerCase(Locale.ENGLISH)
+ name.substring(1);
}
return name;
}
public static boolean isProperty(String name) {
return name.startsWith("get")
|| name.startsWith("set")
|| name.startsWith("is");
}
public static boolean isGetter(String name) {
return name.startsWith("get") || name.startsWith("is");
}
public static boolean isSetter(String name) {
return name.startsWith("set");
}
}
解析过程的关键在于去掉方法前缀后的首字母处理:
- 方法名以
is 开头时,去掉前两个字符;以 get 或 set 开头时,去掉前三个字符。
- 剩余名称只有一个字符时,将其转换为小写。例如
getX 解析为 x。
- 剩余名称长度大于 1,且第二个字符不是大写字母时,将第一个字符转换为小写。
- 如果第二个字符是大写字母,则保留剩余名称的原有大小写。
因此,getnMetaType 和 getNMetaType 去掉前缀后,第二个字符都是大写的 M,但它们的首字符不同,最终得到的属性名也不同。
属性名解析测试
@Test
public void foundPropertyNamer() {
String isName = "isName";
String getName = "getName";
String getnMetaType = "getnMetaType";
String getNMetaType = "getNMetaType";
Stream.of(isName, getName, getnMetaType, getNMetaType)
.forEach(methodName -> System.out.println(
"方法名字是:" + methodName
+ " 属性名字:" + PropertyNamer.methodToProperty(methodName)
));
}
输出结果:
方法名字是:isName 属性名字:name
方法名字是:getName 属性名字:name
方法名字是:getnMetaType 属性名字:nMetaType
方法名字是:getNMetaType 属性名字:NMetaType
可见,getNMetaType 被解析成了 NMetaType,而不是实体中期望使用的 nMetaType。实际项目中还需要结合映射配置和使用的组件版本排查,不能仅凭字段名就断定所有 null 问题都是由此造成的。
解决方案
- 修改属性名,避免使用第一个字母小写、第二个字母大写的命名方式;也可以在项目中约定属性名前两个字母使用小写。
- 如果数据库设计和前后端接口已经确定,不方便修改属性名,可以针对这类特殊属性,使用 IDEA 生成或手写符合预期的 Getter 和 Setter,并确认框架解析出的属性名。
@Accessors(chain = true) 的问题
问题发现
使用 EasyExcel 转换实体类时,以前的实体类都正常,新增加的实体类却出现了转换问题。对比后发现,新实体类增加了 Lombok 的 @Accessors(chain = true) 注解。
这个注解的目的,是让 Setter 支持链式调用:
new UserDto()
.setUserName("")
.setAge(10)
// 其他属性
.setBirthday(new Date());
开启链式调用后,生成的 Setter 返回当前对象,而不是通常 JavaBean Setter 使用的 void。
原因
在这次排查涉及的 EasyExcel 实现中,实体转换使用了 cglib 的 BeanMap:
com.alibaba.excel.read.listener.ModelBuildEventListener 中的调用:
BeanMap.create(resultModel).putAll(map);
底层涉及 cglib 的 BeanMap 方法:
abstract public Object put(Object bean, Object key, Object value);
在这条处理路径中,cglib 使用了 Java 的 Introspector 来识别 Bean 属性。以下是排查时查看的 Introspector.java 相关代码:
if (int.class.equals(argTypes[0]) && name.startsWith(GET_PREFIX)) {
pd = new IndexedPropertyDescriptor(
this.beanClass, name.substring(3), null, null, method, null
);
} else if (void.class.equals(resultType) && name.startsWith(SET_PREFIX)) {
// Simple setter
pd = new PropertyDescriptor(
this.beanClass, name.substring(3), null, method
);
if (throwsException(method, PropertyVetoException.class)) {
pd.setConstrained(true);
}
}
其中,普通 Setter 的判断要求方法名以 set 开头,且返回类型为 void。链式 Setter 返回实体对象,不满足这里的返回类型判断,因此在该案例使用的转换路径中没有按预期被识别。
具体行为与 EasyExcel、cglib 和 JDK 的版本及实际实现路径有关;排查时应以项目中使用的版本为准。
解决方案
- 去掉相关实体类上的
@Accessors(chain = true),让 Setter 使用 void 返回类型。
- 检查所用 EasyExcel 版本及其底层转换实现是否支持返回值不是
void 的 Setter;如果实现已支持,再结合项目兼容性考虑升级或替换转换方式。
来源
原文出处:juejin.im/post/6881432532332576781
来源页面
文章页面