对象拷贝类PropertyUtils，BeanUtils，BeanCopier的技术沉淀

ゝ一纸荒年。 2021-10-01 06:56 321阅读 0赞

[功能简介][Link 1]

# 对象拷贝的应用现状简介： #

业务系统中经常需要两个对象进行属性的拷贝，不能否认逐个的对象拷贝是最快速最安全的做法，但是当数据对象的属性字段数量超过程序员的容忍的程度，代码因此变得臃肿不堪，使用一些方便的对象拷贝工具类将是很好的选择。

# 目前流行的较为公用认可的工具类： #

Apache的两个版本：（反射机制）

org.apache.commons.beanutils.PropertyUtils.copyProperties(Object dest, Object orig)

org.apache.commons.beanutils.BeanUtils.copyProperties(Object dest, Object orig)

Spring版本：（反射机制）  **对应的包为：spring-beans-4.0.6.RELEASE.jar**

org.springframework.beans.BeanUtils.copyProperties(Object source, Object target, Class editable, String\[\] ignoreProperties)

cglib版本：（使用动态代理，效率高）

net.sf.cglib.beans.BeanCopier.copy(Object paramObject1, Object paramObject2, Converter paramConverter)

# 原理简介 #

## 反射类型：（apache） ##

都使用静态类调用，最终转化虚拟机中两个单例的工具对象。

public BeanUtilsBean()

this(new ConvertUtilsBean(), new PropertyUtilsBean());

ConvertUtilsBean可以通过ConvertUtils全局自定义注册。

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

PropertyUtilsBean的copyProperties方法实现了拷贝的算法。

1、  动态bean：orig instanceof DynaBean：Object value = ((DynaBean)orig).get(name);然后把value复制到动态bean类

2、  Map类型：orig instanceof Map：key值逐个拷贝

3、  其他普通类：：从beanInfo【每一个对象都有一个缓存的bean信息，包含属性字段等】取出name，然后把sourceClass和targetClass逐个拷贝

## Cglib类型：BeanCopier ##

copier = BeanCopier.create(source.getClass(), target.getClass(), false);

copier.copy(source, target, null);

Create对象过程：产生sourceClass-》TargetClass的拷贝代理类，放入jvm中，所以创建的代理类的时候比较耗时。最好保证这个对象的单例模式，可以参照最后一部分的优化方案。

创建过程：源代码见jdk：net.sf.cglib.beans.BeanCopier.Generator.generateClass(ClassVisitor)

1、  获取sourceClass的所有public get 方法-》PropertyDescriptor\[\] getters

2、  获取TargetClass 的所有 public set 方法-》PropertyDescriptor\[\] setters

3、  遍历setters的每一个属性，执行4和5

4、  按setters的name生成sourceClass的所有setter方法-》PropertyDescriptor getter【不符合javabean规范的类将会可能出现空指针异常】

5、  PropertyDescriptor\[\] setters-》PropertyDescriptor setter

6、  将setter和getter名字和类型 配对，生成代理类的拷贝方法。

Copy属性过程：调用生成的代理类，代理类的代码和手工操作的代码很类似，效率非常高。

[缺陷预防][Link 2]

# 你不知道这些陷阱吧？ #

<table> 
 <tbody> 
 <tr> 
 <td> 陷阱条件 </td> 
 <td> Apache- PropertyUtils </td> 
 <td> Apache- BeanUtils </td> 
 <td> Spring- &nbsp;BeanUtils </td> 
 <td> Cglib- BeanCopier </td> 
 </tr> 
 <tr> 
 <td> 是否可以扩展 useConvete功能 </td> 
 <td> NO </td> 
 <td> Yes </td> 
 <td> Yes </td> 
 <td> Yes，但比较难用 </td> 
 </tr> 
 <tr> 
 <td> （sourceObject，targetObject）的顺序 </td> 
 <td> 逆序 </td> 
 <td> 逆序 </td> 
 <td> OK &nbsp; </td> 
 <td> OK </td> 
 </tr> 
 <tr> 
 <td> 对sourceObject特殊属性的限制：(Date，BigDecimal等）【见备注1】 </td> 
 <td> OK </td> 
 <td> NO，异常出错 </td> 
 <td> OK </td> 
 <td> OK </td> 
 </tr> 
 <tr> 
 <td> 相同属性名，且类型不匹配时候的处理 【见备注2】 </td> 
 <td> 异常，拷贝部分属性,非常危险 </td> 
 <td> OK，并能进行初级转换，Long和Integer互转 </td> 
 <td> 异常，拷贝部分属性 </td> 
 <td> OK，但是该属性不拷贝 </td> 
 </tr> 
 <tr> 
 <td> Get和set方法不匹配的处理 【见备注3】 </td> 
 <td> OK </td> 
 <td> OK </td> 
 <td> OK </td> 
 <td> 创建拷贝的时候报错，无法拷贝任何属性（当且仅当sourceClass的get方法超过set方法） </td> 
 </tr> 
 </tbody> 
</table>

## 备注1 ##

<table> 
 <tbody> 
 <tr> 
 <td> 对targetObject特殊属性的限制：(Date，BigDecimal等） 原因：dateTimeConveter的conveter没有对null值的处理 </td> 
 </tr> 
 <tr> 
 <td> public class&nbsp;ErrorBeanUtilObject {&nbsp;//此处省略getter，setter方法 &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;name; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;java.util.Date&nbsp;date; } &nbsp;public class&nbsp;ErrorBeanUtilsTest { &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public static void&nbsp;main(String args[])&nbsp;throws&nbsp;Throwable&nbsp; {&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; ErrorBeanUtilObject from =&nbsp;new&nbsp;ErrorBeanUtilObject();&nbsp; &nbsp;&nbsp;&nbsp; ErrorBeanUtilObject to =&nbsp;new&nbsp;ErrorBeanUtilObject();&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; //from.setDate(new&nbsp;java.util.Date()); &nbsp;&nbsp;&nbsp; from.setName("TTTT"); &nbsp;&nbsp;&nbsp; org.apache.commons.beanutils.BeanUtils.copyProperties(to, from);//如果from.setDate去掉，此处出现conveter异常 &nbsp;&nbsp;&nbsp; System.out.println(ToStringBuilder.reflectionToString(from)); &nbsp;&nbsp;&nbsp; System.out.println(ToStringBuilder.reflectionToString(to)); &nbsp;&nbsp;&nbsp; }&nbsp;&nbsp; } </td> 
 </tr> 
 </tbody> 
</table>

## 备注2 ##

<table> 
 <tbody> 
 <tr> 
 <td> 相同属性名，且类型不匹配时候的处理 原因：这两个工具类不支持同名异类型的匹配 !!!【包装类Long和原始数据类型long是可以的】 </td> 
 </tr> 
 <tr> 
 <td> public class&nbsp;TargetClass {&nbsp;&nbsp;//此处省略getter，setter方法 &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;Long num;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String name; } public class&nbsp;TargetClass {&nbsp;&nbsp;//此处省略getter，setter方法 &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;Long num; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String name; } public class&nbsp;ErrorPropertyUtilsTest {&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public static void&nbsp;main(String args[])&nbsp;throws&nbsp;IllegalAccessException, InvocationTargetException, NoSuchMethodException&nbsp; {&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; SourceClass from =&nbsp;new&nbsp;SourceClass();&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; from.setNum(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; from.setName("name");&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; TargetClass to =&nbsp;new&nbsp;TargetClass();&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; org.apache.commons.beanutils.PropertyUtils.copyProperties(to, from); //抛出参数不匹配异常 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; org.springframework.beans.BeanUtils.copyProperties(from, to); //抛出参数不匹配异常 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; System.out.println(ToStringBuilder.reflectionToString(from));&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; System.out.println(ToStringBuilder.reflectionToString(to));&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; }&nbsp;&nbsp; } </td> 
 </tr> 
 </tbody> 
</table>

## 备注3 ##

<table> 
 <tbody> 
 <tr> 
 <td> Get和set方法不匹配的处理 </td> 
 </tr> 
 <tr> 
 <td> public class&nbsp;ErrorBeanCopierTest {&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp; &nbsp;* 从该用例看出BeanCopier.create的target.class 的每一个get方法必须有队形的set方法 &nbsp;&nbsp;&nbsp; &nbsp;*&nbsp;@param&nbsp;args &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp;&nbsp;public static void&nbsp;main(String args[]) {&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; BeanCopier copier = BeanCopier.create(UnSatifisedBeanCopierObject.class, SourceClass.class,false); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; copier = BeanCopier.create(SourceClass.class, UnSatifisedBeanCopierObject.class,&nbsp;false); //此处抛出异常创建&nbsp; &nbsp;&nbsp;&nbsp; }&nbsp;&nbsp; } class&nbsp;UnSatifisedBeanCopierObject {&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String name; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;Long num; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getName() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;name; &nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp;&nbsp;public void&nbsp;setName(String name) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.name = name; &nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;Long getNum() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;num; &nbsp;&nbsp;&nbsp; } //&nbsp; public void setNum(Long&nbsp;num) { //&nbsp;&nbsp;&nbsp;&nbsp; this.num =&nbsp;num; //&nbsp; } } </td> 
 </tr> 
 </tbody> 
</table>

[优化方案][Link 3]

# 一些优化和改进 #

<table> 
 <tbody> 
 <tr> 
 <td> 增强apache的beanUtils的拷贝属性，注册一些新的类型转换 </td> 
 </tr> 
 <tr> 
 <td> public class BeanUtilsEx extends BeanUtils { &nbsp; public static void copyProperties(Object dest, Object orig) &nbsp; { &nbsp;&nbsp;&nbsp; try &nbsp;&nbsp;&nbsp; { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; BeanUtils.copyProperties(dest, orig); &nbsp;&nbsp;&nbsp; } catch (IllegalAccessException ex) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ex.printStackTrace(); &nbsp;&nbsp;&nbsp; } catch (InvocationTargetException ex) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ex.printStackTrace(); &nbsp;&nbsp;&nbsp; } &nbsp; } &nbsp; static &nbsp; { &nbsp;&nbsp;&nbsp; ConvertUtils.register(new DateConvert(), java.util.Date.class); &nbsp;&nbsp;&nbsp; ConvertUtils.register(new DateConvert(), java.sql.Date.class); &nbsp;&nbsp;&nbsp; ConvertUtils.register(new BigDecimalConvert(), BigDecimal.class); &nbsp; } } </td> 
 </tr> 
 <tr> 
 <td> 将beancopier做成静态类，方便拷贝 </td> 
 </tr> 
 <tr> 
 <td> public class&nbsp;BeanCopierUtils { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public static&nbsp;Map&lt;String,BeanCopier&gt;&nbsp;beanCopierMap&nbsp;=&nbsp;new&nbsp;HashMap&lt;String,BeanCopier&gt;(); &nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public static void&nbsp;copyProperties(Object source, Object target){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; String beanKey =&nbsp;&nbsp;generateKey(source.getClass(), target.getClass()); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; BeanCopier copier =&nbsp;&nbsp;null; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if(!beanCopierMap.containsKey(beanKey)){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; copier = BeanCopier.create(source.getClass(), target.getClass(),&nbsp;false); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;beanCopierMap.put(beanKey, copier); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; }else{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; copier =&nbsp;beanCopierMap.get(beanKey); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; copier.copy(source, target,&nbsp;null); &nbsp;&nbsp;&nbsp;&nbsp; }&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;private static&nbsp;String generateKey(Class&lt;?&gt; class1,Class&lt;?&gt;class2){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;class1.toString() + class2.toString(); &nbsp;&nbsp;&nbsp;&nbsp; } } </td> 
 </tr> 
 <tr> 
 <td> 修复beanCopier对set方法强限制的约束 </td> 
 </tr> 
 <tr> 
 <td> 改写net.sf.cglib.beans.BeanCopier.Generator.generateClass(ClassVisitor)方法 将133行的 MethodInfo write = ReflectUtils.getMethodInfo(setter.getWriteMethod()); 预先存一个names2放入 /* 109 */&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Map names2 =&nbsp;new&nbsp;HashMap(); /* 110 */&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(int&nbsp;i = 0; i &lt; getters.length; ++i) { /* 111 */&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; names2.put(setters[i].getName(), getters[i]); /*&nbsp;&nbsp;&nbsp;&nbsp; */&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } 调用这行代码前判断查询下，如果没有改writeMethod则忽略掉该字段的操作，这样就可以避免异常的发生。 
 <div>
 &nbsp; 
 </div> </td> 
 </tr> 
 </tbody> 
</table>

转载于:https://www.cnblogs.com/zxwBj/p/8661711.html

[Link 1]: http://blog.csdn.net/express_wind/article/details/7326350
[Link 2]: http://blog.csdn.net/express_wind/article/details/7326359
[Link 3]: http://blog.csdn.net/express_wind/article/details/7326369