【Java】Spring中BeanUtils.copyProperties的坑及解决

一、问题背景

在做 源对象 与 目标对象 拷贝时目标对象中继承父类的属性没有成功复制。

二、Spring 的 BeanUtils.copyProperties方法

使用 Spring 的 BeanUtils.copyProperties方法进行属性拷贝时，只会拷贝源对象中定义的属性，而不会拷贝目标对象中继承自父类的属性。

因为 BeanUtils.copyProperties()方法是基于 Java 反射实现的，它只能访问源对象中的属性，无法访问目标对象中继承自父类的属性。

如果需要将源对象中的属性拷贝到目标对象中，包括目标对象中继承自父类的属性，可以使用其他的 Java 对象映射工具，比如 Hutool的 BeanUtil、Apache Commons BeanUtils 和 Dozer 等。

这些工具可以通过配置来决定是否拷贝继承自父类的属性。

三、demo

以下是使用 Hutool 中的 BeanUtil.copyProperties()方法进行属性拷贝的示例代码：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

import cn.hutool.core.bean.BeanUtil; import cn.hutool.core.collection.CollUtil; import cn.hutool.core.date.DateUtil; import java.util.*; public class Example {     public static void main(String[] args) {         // 创建一个子类对象         Child source = new Child();         source.setPublicField("public field");         source.setProtectedField("protected field");         source.setPrivateField("private field");         source.setDateField(DateUtil.parse("2023-05-22"));         source.setStringList(CollUtil.newArrayList("a", "b", "c"));         source.setStringMap(new HashMap() {{             put("key1", "value1");             put("key2", "value2");         }});         // 创建一个父类对象         Parent target = new Parent();         // 将子类对象的属性拷贝到父类对象中         BeanUtil.copyProperties(source, target);         // 输出父类对象中的属性         System.out.println("publicField: " + target.getPublicField());         System.out.println("protectedField: " + target.getProtectedField());         System.println("privateField: " + target.getPrivateField());         System.out.println("dateField: " + target.getDateField());         System.out.println("stringList: " + target.getStringList());         System.out.println("stringMap: " + target.getStringMap());     } } // 父类 class Parent {     private String privateField;     private Date dateField;     private List stringList;     private Map stringMap;     public String getPrivateField() {         return privateField;     }     public void setPrivateField(String privateField) {         this.privateField = privateField;     }     public Date getDateField() {         return dateField;     }     public void setDateField(Date dateField) {         this.dateField = dateField;     }     public List getStringList() {         return stringList;     }     public void setStringList(List stringList) {         this.stringList = stringList;     }     public Map getStringMap() {         return stringMap;     }     public void setStringMap(Map stringMap) {         this.stringMap = stringMap;     } } // 子类 class Child extends Parent {     public String publicField;     protected String protectedField;     public String getPublicField() {         return publicField;     }     public void setPublicField(String publicField) {         this.publicfield = publicField;     }     public String getProtectedField() {         return protectedField;     }     public void setProtectedField(String protectedField) {         this.protectedField = protectedField;     }     private String privateField;     public String getPrivateField() {         return privateField;     }     public void setPrivateField(String privateField) {         this.privateField = privateField;     } }

输出结果为：

publicField: public field
protectedField: protected field
privateField: private field
dateField: Mon May 22 00:00:00 CST 2023
stringList: [a, b, c]
stringMap: {key1=value1, key2=value2}

四、补充（Spring的BeanUtils.copyProperties与hutool中BeanUtil.copyProperties区别）

Spring 的 BeanUtils.copyProperties()和 Hutool 中的 BeanUtil.copyProperties()都是用于对象属性复制的工具方法

但它们在实现细节和使用方式上有一些区别：

1. 底层实现不同

Spring 的 BeanUtils.copyProperties()方法是基于 Java 反射实现的，它可以将源对象中的属性拷贝到目标对象中，并支持类型转换和自定义转换器。

Hutool 中的 BeanUtil.copyProperties()方法则是基于 ASM 字节码操作实现的，它不仅可以将源对象中的属性拷贝到目标对象中，还支持自定义映射规则、字段过滤和类型转换。

2. 使用方式不同

Spring 的 BeanUtils.copyProperties()方法的使用方式如下：

1	BeanUtils.copyProperties(source, target);

其中， source是源对象， target是目标对象。

Hutool 中的 BeanUtil.copyProperties()方法的使用方式如下：

1	BeanUtil.copyProperties(source, target, ignoreNullValue);

其中， source 是源对象， target 是目标对象， ignoreNullValue 是一个布尔值，表示是否忽略源对象中值为 null 的属性。

如果 ignoreNullValue 为 true，则会忽略源对象中值为 null 的属性，不会拷贝到目标对象中；如果 ignoreNullValue 为 false，则会将源对象中值为 null 的属性拷贝到目标对象中。

3. 支持的类型不同

Spring 的 BeanUtils.copyProperties()方法支持的类型非常广泛，包括 Java 基本类型、字符串、日期、集合、数组等等。

Hutool 中的 BeanUtil.copyProperties()方法支持的类型也很广泛，包括 Java 基本类型、字符串、日期、集合、数组等等，但是它还支持一些其他类型，比如枚举、Map、JSONObject 等等。