Spring中BeanUtils.copyProperties的坑及解決

更新時(shí)間：2023年09月05日 14:50:27 作者：K_米諾

這篇文章主要介紹了Spring中BeanUtils.copyProperties的坑及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

一、問題背景

在做 源對(duì)象 與 目標(biāo)對(duì)象 拷貝時(shí)目標(biāo)對(duì)象中繼承父類的屬性沒有成功復(fù)制。

二、Spring 的 BeanUtils.copyProperties方法

使用 Spring 的 BeanUtils.copyProperties方法進(jìn)行屬性拷貝時(shí)，只會(huì)拷貝源對(duì)象中定義的屬性，而不會(huì)拷貝目標(biāo)對(duì)象中繼承自父類的屬性。

因?yàn)?BeanUtils.copyProperties()方法是基于 Java 反射實(shí)現(xiàn)的，它只能訪問源對(duì)象中的屬性，無法訪問目標(biāo)對(duì)象中繼承自父類的屬性。

如果需要將源對(duì)象中的屬性拷貝到目標(biāo)對(duì)象中，包括目標(biāo)對(duì)象中繼承自父類的屬性，可以使用其他的 Java 對(duì)象映射工具，比如 Hutool的 BeanUtil、Apache Commons BeanUtils 和 Dozer 等。

這些工具可以通過配置來決定是否拷貝繼承自父類的屬性。

三、demo

以下是使用 Hutool 中的 BeanUtil.copyProperties()方法進(jìn)行屬性拷貝的示例代碼：

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) {
        // 創(chuàng)建一個(gè)子類對(duì)象
        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<String, String>() {{
            put("key1", "value1");
            put("key2", "value2");
        }});
        // 創(chuàng)建一個(gè)父類對(duì)象
        Parent target = new Parent();
        // 將子類對(duì)象的屬性拷貝到父類對(duì)象中
        BeanUtil.copyProperties(source, target);
        // 輸出父類對(duì)象中的屬性
        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<String> stringList;
    private Map<String, String> 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<String> getStringList() {
        return stringList;
    }
    public void setStringList(List<String> stringList) {
        this.stringList = stringList;
    }
    public Map<String, String> getStringMap() {
        return stringMap;
    }
    public void setStringMap(Map<String, String> 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;
    }
}

輸出結(jié)果為：

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}

四、補(bǔ)充（Spring的BeanUtils.copyProperties與hutool中BeanUtil.copyProperties區(qū)別）

Spring 的 BeanUtils.copyProperties()和 Hutool 中的 BeanUtil.copyProperties()都是用于對(duì)象屬性復(fù)制的工具方法

但它們?cè)趯?shí)現(xiàn)細(xì)節(jié)和使用方式上有一些區(qū)別：

1. 底層實(shí)現(xiàn)不同

Spring 的 BeanUtils.copyProperties()方法是基于 Java 反射實(shí)現(xiàn)的，它可以將源對(duì)象中的屬性拷貝到目標(biāo)對(duì)象中，并支持類型轉(zhuǎn)換和自定義轉(zhuǎn)換器。

Hutool 中的 BeanUtil.copyProperties()方法則是基于 ASM 字節(jié)碼操作實(shí)現(xiàn)的，它不僅可以將源對(duì)象中的屬性拷貝到目標(biāo)對(duì)象中，還支持自定義映射規(guī)則、字段過濾和類型轉(zhuǎn)換。

2. 使用方式不同

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

BeanUtils.copyProperties(source, target);

其中， source是源對(duì)象， target是目標(biāo)對(duì)象。

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

BeanUtil.copyProperties(source, target, ignoreNullValue);

其中， source 是源對(duì)象， target 是目標(biāo)對(duì)象， ignoreNullValue 是一個(gè)布爾值，表示是否忽略源對(duì)象中值為 null 的屬性。

如果 ignoreNullValue 為 true，則會(huì)忽略源對(duì)象中值為 null 的屬性，不會(huì)拷貝到目標(biāo)對(duì)象中；如果 ignoreNullValue 為 false，則會(huì)將源對(duì)象中值為 null 的屬性拷貝到目標(biāo)對(duì)象中。