快捷導(dǎo)航

BeanUtils.copyProperties使用總結(jié)以及注意事項說明

更新時間：2021年08月31日 10:36:41 作者：啊~~噙！

這篇文章主要介紹了BeanUtils.copyProperties使用總結(jié)以及注意事項說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

1.前言

開發(fā)過程中，講一個對象的屬性和值賦值到另一個對象上，大量使用了get、set方法，看著很臃腫，思考下肯定不只有我有這種想法，所以技術(shù)上肯定有方法能解決這個問題，所以查閱了一些資料發(fā)現(xiàn)了BeanUtils.copyProperties這個方法以下是這次所有的總結(jié)以及使用時的注意事項。

使用org.springframework.beans.BeanUtils.copyProperties方法進行對象之間屬性的賦值，避免通過get、set方法一個一個屬性的賦值。

2.一般使用

BeanUtils是這個包里比較常用的一個工具類，該方法定義如下：

public static void copyProperties(java.lang.Object dest,java.lang.Object orig)
   throws java.lang.IllegalAccessException,
      java.lang.reflect.InvocationTargetException

如果你有兩個具有很多相同屬性的JavaBean，一個很常見的情況就是Struts里的PO對象（持久對象）和對應(yīng)的ActionForm，例如 Teacher和TeacherForm。我們一般會在Action里從ActionForm構(gòu)造一個PO對象，傳統(tǒng)的方式是使用類似下面的語句對屬性逐個賦值：

//1得到TeacherForm
TeacherForm teacherForm=(TeacherForm)form;
//2構(gòu)造Teacher對象
Teacher teacher=new Teacher();
//3賦值
teacher.setName(teacherForm.getName());
teacher.setAge(teacherForm.getAge());
teacher.setGender(teacherForm.getGender());
teacher.setMajor(teacherForm.getMajor());
teacher.setDepartment(teacherForm.getDepartment());
//4持久化Teacher對象到數(shù)據(jù)庫
HibernateDAO=;
HibernateDAO.save(teacher);

而使用BeanUtils后，代碼就大大改觀了，如下所示：

//1得到TeacherForm
TeacherForm teacherForm=(TeacherForm)form;
//2構(gòu)造Teacher對象
Teacher teacher=new Teacher();
//3賦值
BeanUtils.copyProperties(teacher,teacherForm);
//4持久化Teacher對象到數(shù)據(jù)庫
HibernateDAO=;
HibernateDAO.save(teacher);

如果Teacher和TeacherForm間存在名稱不相同的屬性，則BeanUtils不對這些屬性進行處理，需要程序員手動處理。

例如 Teacher包含modifyDate（該屬性記錄最后修改日期，不需要用戶在界面中輸入）屬性而TeacherForm無此屬性，那么在上面代碼的 copyProperties()后還要加上一句：

teacher.setModifyDate(new Date());

3.拷貝屬性時忽略空值

使用BeanUtils.copyProperties有一個問題就是當(dāng)src對象的鍵值為Null時

就會把target對象的對應(yīng)鍵值覆蓋成空了，這明顯不是我們想要的，以下這個方法可以解決

/**
 * 復(fù)制屬性，過濾掉不復(fù)制的屬性
 */
public static void copyBeanProperties(
    final Object source,//1，待復(fù)制的原始對象
    final Object target,//2，復(fù)制后的結(jié)果對象
    //3，獲取保存你不需要復(fù)制的屬性名
    final Collection<String> excludes = new ArrayList<String>();
    final PropertyDescriptor[] propertyDescriptors = BeanUtils.getPropertyDescriptors(source.getClass());
    for(final PropertyDescriptor propertyDescriptor : propertyDescriptors){
        String propName = propertyDescriptor.getName();
        if(!includes.contains(propName)){
            excludes.add(propName);
        }
    }
    //4，復(fù)制操作
    BeanUtils.copyProperties(source, target, excludes.toArray(new String[excludes.size()]));
}

使用案例

public static String[] getNullPropertyNames (Object source) {
        final BeanWrapper src = new BeanWrapperImpl(source);
        java.beans.PropertyDescriptor[] pds = src.getPropertyDescriptors();
        Set<String> emptyNames = new HashSet<String>();
        for(java.beans.PropertyDescriptor pd : pds) {
            Object srcValue = src.getPropertyValue(pd.getName());
            if (srcValue == null) emptyNames.add(pd.getName());
        }
        String[] result = new String[emptyNames.size()];
        return emptyNames.toArray(result);
    }
    public static void copyPropertiesIgnoreNull(Object src, Object target){
        BeanUtils.copyProperties(src, target, getNullPropertyNames(src));
    }

4.使用注意事項（1）

Property.copyProperties()和BeanUtils.copyProperties()

除BeanUtils外還有一個名為PropertyUtils的工具類，它也提供copyProperties()方法

1.無論是org.springframework.beans或者org.apache.commons.beanutils，與get/set方式相比，都存在性能問題。
2.效率由高到底：get/set 》PropertyUtils 》BeanUtils。
3.PropertyUtils和BeanUtils兩個工具類都是對bean之間存在屬性名相同的屬性進行處理，無論是源bean或者是目標bean中多出來的屬性均不處理。
4.具體來說：BeanUtils.copyProperties()可以在一定范圍內(nèi)進行類型轉(zhuǎn)換，同時還要注意一些不能轉(zhuǎn)換時候，會將默認null值轉(zhuǎn)化成0;Property.copyProperties()則是嚴格的類型轉(zhuǎn)化，必須類型和屬性名完全一致才轉(zhuǎn)化。對于null的處理：PropertyUtils支持為null的場景；BeanUtils對部分屬性不支持null，具體如下：
- a. java.util.Date類型不支持,但是它的自雷java.sql.Date是被支持的。java.util.Date直接copy會報異常；
- b. Boolean，Integer，Long等不支持，會將null轉(zhuǎn)化為0；
- c. String支持，轉(zhuǎn)化后依然為null。
5.BeanUtils的高級功能org.apache.commons.beanutils.Converter接口可以自定義類型轉(zhuǎn)化，也可以對部分類型數(shù)據(jù)的null值進行特殊處理，如ConvertUtils.register(new DateConverter(null), java.util.Date.class);但是PropertyUtils沒有。

另外：值得注意的是，在測試過程中發(fā)現(xiàn)，commons-beanutils-1.8.0.jar版本中的BeanUtils類，支持Byte到Integer或int的轉(zhuǎn)化。說明實際使用過程中，我們還是要多看源碼，多做測試，并且注意版本號升級帶來的微小變化。

BeanUtils支持的轉(zhuǎn)換類型如下：

* java.lang.BigDecimal
* java.lang.BigInteger
* boolean and java.lang.Boolean
* byte and java.lang.Byte
* char and java.lang.Character
* java.lang.Class
* double and java.lang.Double
* float and java.lang.Float
* int and java.lang.Integer
* long and java.lang.Long
* short and java.lang.Short
* java.lang.String
* java.sql.Date
* java.sql.Time
* java.sql.Timestamp

這里要注意一點，java.util.Date是不被支持的，而它的子類java.sql.Date是被支持的。因此如果對象包含時間類型的屬性，且希望被轉(zhuǎn)換的時候，一定要使用java.sql.Date類型。否則在轉(zhuǎn)換時會提示argument mistype異常。

5.使用注意事項（2）

在Java中copyProperties() 這個方法出處有兩個地方，

BeanUtils是org.springframework.beans.BeanUtils

BeanUtils是org.apache.commons.beanutils.BeanUtils

下面具體說說他們的用法和區(qū)別。這個方法在不同的包下面，而這兩個類的copyProperties()方法里面?zhèn)鬟f的參數(shù)賦值是相反的。

例如：a,b為對象 BeanUtils.copyProperties(a, b);

BeanUtils是org.springframework.beans.BeanUtils
//a拷貝到b
//a1 源文件，b1 目標文件
public static void copyProperties(Object a1, Object b1)
        throws BeansException
    {
        copyProperties(a1, b1, null, (String[])null);
    }

BeanUtils是org.apache.commons.beanutils.BeanUtils

//b拷貝到a
//a2目標文件 ,b2 原始的，源文件
public static void copyProperties(Object a2, Object b2)
        throws IllegalAccessException, InvocationTargetException
    {
        BeanUtilsBean.getInstance().copyProperties(a2, b2);
    }

引用包出處不一樣，意思就不一樣，使用的時候一定要看清楚是哪個包下面的。

6.使用注意事項（3）

方法使用起來是不是即省事又舒服？but。。。get/set寫代碼省事是要付出代價的，那就是使用BeanUtils的運行成本也驚人！BeanUtils所花費的時間要超過取數(shù) 據(jù)、將其復(fù)制到對應(yīng)的 value對象（通過手動調(diào)用get和set方法），以及通過串行化將其返回到遠程的客戶機的時間總和。所以要小心使用這種威力！有失必有得，反之亦然。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: