beanutils.copyproperties拷贝无法覆盖问题及源码解析

一、copyproperties简介

        copyproperties是BeanUtils提供对Java反射和自省API的包装。其主要目的是利用反射机制对JavaBean的属性进行复制。我们知道，一个JavaBean通常包含了大量的属性，很多情况下，对JavaBean的处理导致大量get/set代码堆积，增加了代码长度和阅读代码的难度。因此可以使用copyproperties更方便的进行复制

public static void copyProperties(Object source, Object target) throws BeansException {
        copyProperties(source, target, (Class)null, (String[])null);
    }

由源码可见BeanUtils.copyProperties(a, b)中a为源对象，b为复制的目标对象：

(1).b中的存在的属性，a中一定要有，但是a中可以有多余的属性；
(2).a中与b中相同的属性都会被替换，不管是否有值；
(3).a、 b中的属性要名字相同，才能被赋值，不然的话需要手动赋值；
(4).Spring的BeanUtils的CopyProperties方法需要对应的属性有getter和setter方法；
(5).如果存在属性完全相同的内部类，但是不是同一个内部类，即分别属于各自的内部类，则spring会认为属性不同，不会copy；
(5).spring和apache的copy属性的方法源和目的参数的位置正好相反，所以导包和调用的时候都要注意一下。
 

二、使用事例

这个一个使用事例，笔者想要通过两次copyProperties方法复制entop1和entop2中的所有属性值

public static void main(String[] args) {
        GlocalTop entop1 = new GlocalTop();
        GlocalTop entop2 = new GlocalTop();
        GlocalTop entop = new GlocalTop();
        System.out.println(JsonUtils.serialize(entop));
        entop1.setId(100L);
        entop1.setBrandName("Nike");
        entop2.setArea("HK");
        BeanUtils.copyProperties(entop1, entop);
        System.out.println(JsonUtils.serialize(entop));
        BeanUtils.copyProperties(entop2, entop);
        System.out.println(JsonUtils.serialize(entop));
    }

然而通过打印我们发现最后得到的结果是

{"id":100,"brandName":"Nike"}
{"area":"HK"}

并没有像期望中的会使entop同时拥有entop1和entop2的属性值。代码调试后发现第二次复制后会将第一次中的数据全部刷新。

 三、源码解析

private static void copyProperties(Object source, Object target, @Nullable Class<?> editable,
    @Nullable String... ignoreProperties) throws BeansException {
  Assert.notNull(source, "Source must not be null");
  Assert.notNull(target, "Target must not be null");
  //目标Class
  Class<?> actualEditable = target.getClass();
  if (editable != null) {
    if (!editable.isInstance(target)) {
      throw new IllegalArgumentException("Target class [" + target.getClass().getName() +
          "] not assignable to Editable class [" + editable.getName() + "]");
    }
    actualEditable = editable;
  }
    //1.获取目标Class的属性描述
  PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);
  List<String> ignoreList = (ignoreProperties != null ? Arrays.asList(ignoreProperties) : null);
  //2.遍历源Class的属性
  for (PropertyDescriptor targetPd : targetPds) {
        //源Class属性的写方法,setXXX
    Method writeMethod = targetPd.getWriteMethod();
        //3.如果存在写方法,并且该属性不忽略,继续往下走,否则跳过继续遍历
    if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {
            //4.获取源Class的与目标属性同名的属性描述
      PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
      //5.如果源属性描述不存在直接跳过,否则继续往下走
            if (sourcePd != null) {
                //获取源属性描述的读方法
        Method readMethod = sourcePd.getReadMethod();
                //6.如果源属性描述的读防范存在且返回数据类型和目标属性的写方法入参类型相同或者派生
                //继续往下走,否则直接跳过继续下次遍历
        if (readMethod != null &&
            ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) {
          try {
                        //如果源属性读方法修饰符不是public,那么修改为可访问
            if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {
              readMethod.setAccessible(true);
            }
                        //7.读取源属性的值
            Object value = readMethod.invoke(source);
                        //如果目标属性的写方法修饰符不是public,则修改为可访问
            if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {
              writeMethod.setAccessible(true);
            }
                        //8.通过反射将源属性值赋值给目标属性
            writeMethod.invoke(target, value);
          }
          catch (Throwable ex) {
            throw new FatalBeanException(
                "Could not copy property '" + targetPd.getName() + "' from source to target", ex);
          }
        }
      }
    }
  }
}

 由于该方法是通过反射的方式去重新构造一个对象，因此不管原先的目标对象中已经存在什么参数值，都会被新的想要复制的对象的参数进行覆盖。