摘要：于是我建議這位小伙伴使用了進(jìn)行屬性拷貝，這為我們的程序挖了一個(gè)坑阿里代碼規(guī)約當(dāng)我們開(kāi)啟阿里代碼掃描插件時(shí)，如果你使用了進(jìn)行屬性拷貝，它會(huì)給你一個(gè)非常嚴(yán)重的警告。大名鼎鼎的提供的包，居然會(huì)存在性能問(wèn)題，以致于阿里給出了嚴(yán)重的警告。

聲明：本文屬原創(chuàng)文章，始發(fā)于公號(hào)：程序員自學(xué)之道，并同步發(fā)布于 https://blog.csdn.net/dadiyang，特此，同步發(fā)布到 sf，轉(zhuǎn)載請(qǐng)注明出處。

有一次開(kāi)發(fā)過(guò)程中，剛好看到一個(gè)小伙伴在調(diào)用 set 方法，將一個(gè)數(shù)據(jù)庫(kù)中查詢出來(lái)的 PO 對(duì)象的屬性拷貝到 Vo 對(duì)象中，類似這樣：

可以看出，Po 和 Vo 兩個(gè)類的字段絕大部分是一樣的，我們一個(gè)個(gè)地調(diào)用 set 方法只是做了一些重復(fù)的冗長(zhǎng)的操作。這種操作非常容易出錯(cuò)，因?yàn)閷?duì)象的屬性太多，有可能會(huì)漏掉一兩個(gè)，而且肉眼很難察覺(jué)。

類似這樣的操作，我們可以很容易想到，可以通過(guò)反射來(lái)解決。其實(shí)，如此普遍通用的功能，一個(gè) BeanUtils 工具類就可以搞定了。

于是我建議這位小伙伴使用了 Apache BeanUtils.copyProperties 進(jìn)行屬性拷貝，這為我們的程序挖了一個(gè)坑！

當(dāng)我們開(kāi)啟阿里代碼掃描插件時(shí)，如果你使用了 Apache BeanUtils.copyProperties 進(jìn)行屬性拷貝，它會(huì)給你一個(gè)非常嚴(yán)重的警告。因?yàn)椋?strong>Apache BeanUtils性能較差，可以使用 Spring BeanUtils 或者 Cglib BeanCopier 來(lái)代替。

看到這樣的警告，有點(diǎn)讓人有點(diǎn)不爽。大名鼎鼎的 Apache 提供的包，居然會(huì)存在性能問(wèn)題，以致于阿里給出了嚴(yán)重的警告。

那么，這個(gè)性能問(wèn)題究竟是有多嚴(yán)重呢？畢竟，在我們的應(yīng)用場(chǎng)景中，如果只是很微小的性能損耗，但是能帶來(lái)非常大的便利性，還是可以接受的。

帶著這個(gè)問(wèn)題。我們來(lái)做一個(gè)實(shí)驗(yàn)，驗(yàn)證一下。

如果對(duì)具體的測(cè)試方式?jīng)]有興趣，可以跳過(guò)直接看結(jié)果哦~

首先，為了測(cè)試方便，讓我們來(lái)定義一個(gè)接口，并將幾種實(shí)現(xiàn)統(tǒng)一起來(lái)：

public interface PropertiesCopier {
    void copyProperties(Object source, Object target) throws Exception;
}
public class CglibBeanCopierPropertiesCopier implements PropertiesCopier {
    @Override
    public void copyProperties(Object source, Object target) throws Exception {
        BeanCopier copier = BeanCopier.create(source.getClass(), target.getClass(), false);
        copier.copy(source, target, null);
    }
}
// 全局靜態(tài) BeanCopier，避免每次都生成新的對(duì)象
public class StaticCglibBeanCopierPropertiesCopier implements PropertiesCopier {
    private static BeanCopier copier = BeanCopier.create(Account.class, Account.class, false);
    @Override
    public void copyProperties(Object source, Object target) throws Exception {
        copier.copy(source, target, null);
    }
}
public class SpringBeanUtilsPropertiesCopier implements PropertiesCopier {
    @Override
    public void copyProperties(Object source, Object target) throws Exception {
        org.springframework.beans.BeanUtils.copyProperties(source, target);
    }
}
public class CommonsBeanUtilsPropertiesCopier implements PropertiesCopier {
    @Override
    public void copyProperties(Object source, Object target) throws Exception {
        org.apache.commons.beanutils.BeanUtils.copyProperties(target, source);
    }
}
public class CommonsPropertyUtilsPropertiesCopier implements PropertiesCopier {
    @Override
    public void copyProperties(Object source, Object target) throws Exception {
        org.apache.commons.beanutils.PropertyUtils.copyProperties(target, source);
    }
}

然后寫(xiě)一個(gè)參數(shù)化的單元測(cè)試：

@RunWith(Parameterized.class)
public class PropertiesCopierTest {
    @Parameterized.Parameter(0)
    public PropertiesCopier propertiesCopier;
    // 測(cè)試次數(shù)
    private static List testTimes = Arrays.asList(100, 1000, 10_000, 100_000, 1_000_000);
    // 測(cè)試結(jié)果以 markdown 表格的形式輸出
    private static StringBuilder resultBuilder = new StringBuilder("|實(shí)現(xiàn)|100|1,000|10,000|100,000|1,000,000|
").append("|----|----|----|----|----|----|
");

    @Parameterized.Parameters
    public static Collection data() {
        Collection params = new ArrayList<>();
        params.add(new Object[]{new StaticCglibBeanCopierPropertiesCopier()});
        params.add(new Object[]{new CglibBeanCopierPropertiesCopier()});
        params.add(new Object[]{new SpringBeanUtilsPropertiesCopier()});
        params.add(new Object[]{new CommonsPropertyUtilsPropertiesCopier()});
        params.add(new Object[]{new CommonsBeanUtilsPropertiesCopier()});
        return params;
    }

    @Before
    public void setUp() throws Exception {
        String name = propertiesCopier.getClass().getSimpleName().replace("PropertiesCopier", "");
        resultBuilder.append("|").append(name).append("|");
    }

    @Test
    public void copyProperties() throws Exception {
        Account source = new Account(1, "test1", 30D);
        Account target = new Account();
        // 預(yù)熱一次
        propertiesCopier.copyProperties(source, target);
        for (Integer time : testTimes) {
            long start = System.nanoTime();
            for (int i = 0; i < time; i++) {
                propertiesCopier.copyProperties(source, target);
            }
            resultBuilder.append((System.nanoTime() - start) / 1_000_000D).append("|");
        }
        resultBuilder.append("
");
    }

    @AfterClass
    public static void tearDown() throws Exception {
        System.out.println("測(cè)試結(jié)果：");
        System.out.println(resultBuilder);
    }
}

時(shí)間單位毫秒

結(jié)果表明，Cglib 的 BeanCopier 的拷貝速度是最快的，即使是百萬(wàn)次的拷貝也只需要 10 毫秒！
相比而言，最差的是 Commons 包的 BeanUtils.copyProperties 方法，100 次拷貝測(cè)試與表現(xiàn)最好的 Cglib 相差 400 倍之多。百萬(wàn)次拷貝更是出現(xiàn)了 2800 倍的性能差異！

結(jié)果真是讓人大跌眼鏡。

但是它們?yōu)槭裁磿?huì)有這么大的差異呢？

查看源碼，我們會(huì)發(fā)現(xiàn) CommonsBeanUtils 主要有以下幾個(gè)耗時(shí)的地方：

輸出了大量的日志調(diào)試信息

重復(fù)的對(duì)象類型檢查

類型轉(zhuǎn)換

  public void copyProperties(final Object dest, final Object orig)
        throws IllegalAccessException, InvocationTargetException {
        // 類型檢查 
        if (orig instanceof DynaBean) {
            ...
        } else if (orig instanceof Map) {
           ...
        } else {
            final PropertyDescriptor[] origDescriptors = ...
            for (PropertyDescriptor origDescriptor : origDescriptors) {
                ...
                // 這里每個(gè)屬性都調(diào)一次 copyProperty
                copyProperty(dest, name, value);
            }
        }
    }

    public void copyProperty(final Object bean, String name, Object value)
        throws IllegalAccessException, InvocationTargetException {
        ...
        // 這里又進(jìn)行一次類型檢查
        if (target instanceof DynaBean) {
            ...
        }
        ...
        // 需要將屬性轉(zhuǎn)換為目標(biāo)類型
        value = convertForCopy(value, type);
        ...
    }
    // 而這個(gè) convert 方法在日志級(jí)別為 debug 的時(shí)候有很多的字符串拼接
    public  T convert(final Class type, Object value) {
        if (log().isDebugEnabled()) {
            log().debug("Converting" + (value == null ? "" : " "" + toString(sourceType) + """) + " value "" + value + "" to type "" + toString(targetType) + """);
        }
        ...
        if (targetType.equals(String.class)) {
            return targetType.cast(convertToString(value));
        } else if (targetType.equals(sourceType)) {
            if (log().isDebugEnabled()) {
                log().debug("No conversion required, value is already a " + toString(targetType));
            }
            return targetType.cast(value);
        } else {
            // 這個(gè) convertToType 方法里也需要做類型檢查
            final Object result = convertToType(targetType, value);
            if (log().isDebugEnabled()) {
                log().debug("Converted to " + toString(targetType) + " value "" + result + """);
            }
            return targetType.cast(result);
        }
    }

具體的性能和源碼分析，可以參考這幾篇文章：

幾種copyProperties工具類性能比較：https://www.jianshu.com/p/bcb...

CGLIB中BeanCopier源碼實(shí)現(xiàn)：https://www.jianshu.com/p/f8b...

Java Bean Copy框架性能對(duì)比：https://yq.aliyun.com/article...

除了性能問(wèn)題之外，在使用 CommonsBeanUtils 時(shí)還有其他的坑需要特別小心！

在進(jìn)行屬性拷貝時(shí)，雖然 CommonsBeanUtils 默認(rèn)不會(huì)給原始包裝類賦默認(rèn)值的，但是在使用低版本(1.8.0及以下)的時(shí)候，如果你的類有 Date 類型屬性，而且來(lái)源對(duì)象中該屬性值為 null 的話，就會(huì)發(fā)生異常：

org.apache.commons.beanutils.ConversionException: No value specified for "Date"

解決這個(gè)問(wèn)題的辦法是注冊(cè)一個(gè) DateConverter：

ConvertUtils.register(new DateConverter(null), java.util.Date.class);

然而這個(gè)語(yǔ)句，會(huì)導(dǎo)致包裝類型會(huì)被賦予原始類型的默認(rèn)值，如 Integer 屬性默認(rèn)賦值為 0，盡管你的來(lái)源對(duì)象該字段的值為 null。

在高版本(1.9.3)中，日期 null 值的問(wèn)題和包裝類賦默認(rèn)值的問(wèn)題都被修復(fù)了。

這個(gè)在我們的包裝類屬性為 null 值時(shí)有特殊含義的場(chǎng)景，非常容易踩坑！例如搜索條件對(duì)象，一般 null 值表示該字段不做限制，而 0 表示該字段的值必須為0。

當(dāng)我們看到阿里的提示，或者你看了這篇文章之后，知道了 CommonsBeanUtils 的性能問(wèn)題，想要改用 Spring 的 BeanUtils 時(shí)，要小心：

org.apache.commons.beanutils.BeanUtils.copyProperties(Object target, Object source);
org.springframework.beans.BeanUtils.copyProperties(Object source, Object target);

從方法簽名上可以看出，這兩個(gè)工具類的名稱相同，方法名也相同，甚至連參數(shù)個(gè)數(shù)、類型、名稱都相同。但是參數(shù)的位置是相反的。因此，如果你想更改的時(shí)候，千萬(wàn)要記得，將 target 和 source 兩個(gè)參數(shù)也調(diào)換過(guò)來(lái)！

另外，可能由于種種原因，你獲取的堆棧信息不完整找不到問(wèn)題在哪，所以這里順便提醒一下：

如果你遇到 java.lang.IllegalArgumentException: Source must not be null 或者 java.lang.IllegalArgumentException: Target must not be null 這樣的異常信息卻到處找不到原因時(shí)，不用找了，這是由于你在 copyProperties 的時(shí)候傳了 null 值導(dǎo)致的。