JAVA对象之间属性复制BeanUtils.copyProperties

背景

项目中有时遇到对象属性之间赋值，但是对象的赋值属性比较多的时候，会想到用BeanUtils.copyProperties进行拷贝。

用法

 BeanUtils提供对Java反射和自省API的包装。其主要目的是利用反射机制对JavaBean的属性进行处理。

User对象

/**
 * Created by XDarker
 * 2019/9/28 22:23
 */
public class User{
    private String name;
    private Integer age;

    public User() {
    }

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public Integer getAge() {
        return age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

我们通过BeanUtils.copyProperties进行拷贝User对象中的属性值

import org.springframework.beans.BeanUtils;
/**
 * Created by XDarker
 * 2019/9/28 22:25
 */
public class demo {
    public static void main(String[] args) {
            User user1 = new User("Darker", 1);
            User user2 = new User();
            BeanUtils.copyProperties(user1, user2);
            System.out.println("用户1:" + user1);
            System.out.println("用户2:" + user2);
    }
}

注意：当User对象中的属性没有get/set方法时，拷贝后属性值为null   ！！！

分析

当我们屏蔽name的get方法，age的set方法时，拷贝为null，这是为什么呢？？？

源码通过targetPd.getWriteMethod()找set方法，sourcePd.getReadMethod()找get方法。

走到这readMethod.invoke(source)会调用对象属性的get方法获取属性值；然后走到writeMethod.invoke(target, value)会调用对象属性的set方法设置属性值。

for (PropertyDescriptor targetPd : targetPds) {
                        //找set方法
			Method writeMethod = targetPd.getWriteMethod();
			if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {
				PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
				if (sourcePd != null) {
                                    //找get方法
					Method readMethod = sourcePd.getReadMethod();
					if (readMethod != null &&
							ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) {
						try {
							if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {
								readMethod.setAccessible(true);
							}
                                                    //调用get方法
							Object value = readMethod.invoke(source);
							if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {
								writeMethod.setAccessible(true);
							}
                                                    //调用set方法
							writeMethod.invoke(target, value);
						}
						catch (Throwable ex) {
							throw new FatalBeanException(
									"Could not copy property '" + targetPd.getName() + "' from source to target", ex);
						}
					}
				}
			}
		}

通过源码可知，BeanUtils.copyProperties通过java反射将类中当前属性字段对应的内容复制到另外一个类中，属性必须具有get/set方法，不然拷贝值为null。