BeanCopier属性复制值全为null

一、问题

在解决一个参数校验过程中，发现beanCopier复制的所有值全为null。beanCopier使用代码如下

public static <T> T copy(T src) {
    T target = null;

    try {
        if (null != src) {
            target = (T) src.getClass().newInstance();
            BeanCopier beanCopier = BeanCopier.create(src.getClass(), target.getClass(), false);
            beanCopier.copy(src, target, null);
        }
    } catch (Exception e) {
        throw new DaProdBaseException(ErrorCodeEnum.UNKNOWN_EXCEPTION, "对象转换异常", e);
    }
    return target;
}

经检查发现，原来是对实体新加了@Accessors(chain = true)注解导致的。

去掉该注解后，复制值全为null的问题就解决了。

二、原理

单单解决问题是不够的，还要弄清背后的原理。

1.@Accessors

首先分析@Accessors的作用（官方文档：https://projectlombok.org/features/experimental/Accessors）

@Accessors主要用于配置getter和setter方法的生成结果，有三个属性，如下图所示

1.1.fluent

fluent设置为true的话，则getter和setter方法的方法名都是基础属性名，且setter方法返回当前对象。

@Data
@Accessors(fluent = true)
public class User {
    private Long id;
    private String name;
    
    // 生成的getter和setter方法如下，方法体略
    public Long id() {}
    public User id(Long id) {}
    public String name() {}
    public User name(String name) {}
}

1.2.chain

chain设置为true，则setter方法返回当前对象

@Data
@Accessors(chain = true)
public class User {
    private Long id;
    private String name;
    
    // 生成的setter方法如下，方法体略
    public User setId(Long id) {}
    public User setName(String name) {}
}

1.3.prefix

perfix，用于生成getter和setter方法的字段名会忽视指定前缀（遵守驼峰命名)

@Data
@Accessors(prefix = "p")
class User {
	private Long pId;
	private String pName;
	
	// 生成的getter和setter方法如下，方法体略
	public Long getId() {}
	public void setId(Long id) {}
	public String getName() {}
	public void setName(String name) {}
}

2.BeanCopier

在文章最开始的那段代码中，核心代码就两行

copier = BeanCopier.create // 生成用于两个bean间进行复制的类

copier.copy(source, target, converter) // 执行复制

所有值都为null，但是对象复制却复制成功，初步怀疑是不是set的时候失败了。

研究了下BeanCopier源码，发现有个generateClass方法，其中有个获取实体类setter的方法。

下图是实体类没有和有@Accessors注解的两种setters情况

可以发现加上@Accessors注解后，setter就没有获取到实体的set方法（剩余的4个是父类的set方法）

进入getBeanSetters方法

 public static PropertyDescriptor[] getBeanSetters(Class type) {
        return getPropertiesHelper(type, false, true);
    }
        
    private static PropertyDescriptor[] getPropertiesHelper(Class type, boolean read, boolean write) {
        try {
            BeanInfo info = Introspector.getBeanInfo(type, Object.class);
            PropertyDescriptor[] all = info.getPropertyDescriptors();
            if (read && write) {
                return all;
            }
            List properties = new ArrayList(all.length);
            for (int i = 0; i < all.length; i++) {
                PropertyDescriptor pd = all[i];
                if ((read && pd.getReadMethod() != null) ||
                    (write && pd.getWriteMethod() != null)) {
                    properties.add(pd);
                }
            }
            return (PropertyDescriptor[])properties.toArray(new PropertyDescriptor[properties.size()]);
        } catch (IntrospectionException e) {
            throw new CodeGenerationException(e);
        }
    }

其中getPropertyDescriptors在@Accessors注解的情况下如下，可以发现属性都没有writeMethod（除了父类的属性）

综上分析大致可知：@Accessors(chain = true) 会将 setter 方法的返回值由 void 修改为 当前对象。 这导致 setter 的方法签名改变，最终导致 BeanCopier 无法识别现有的 setter 方法。