【Java 对象拷贝机制】使用 CGlib 实现 Bean 拷贝(BeanCopier)

语言: CN / TW / HK

【Java对象拷贝机制】使用CGlib实现Bean拷贝(BeanCopier)

对象拷贝现状

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

模型数据转换

项目中或多或少会对某些实体进行转换(DTO、VO、DO 或者 PO 等),往往具有相同的属性名称,数量少的情况下我们可以直接采取 set、get 方法进行赋值,可是如果这样的转换在很多地方都会用到,还是靠 set 来进行操作势必会大大的影响开发效率。

  • 关于实体转换,我们把一个实体对应一张表(这可以当成 DO)。
  • 业务中与第三方进行数据交互,我们需要把实体的数据传给他们,但不一定是一个 DO 中的所有属性可能减少或者多个 DO 中的属性组成,这里我们引入 DTO(这个实体中我们可以去除一些隐私信息,比如:银行卡号,身份证,密码)。
  • 一个性别我们用 1、2 表示男女,页面中不能直接显示 1 或者 2,需要显示男、女或者靓仔(男)、靓妹(女),这时候代表这样的一个实体我们可以看作 VO。

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

Apache 的两个版本:(反射机制)

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

原因:dateTimeConveter 的 conveter 没有对 null 值的处理

​ // targetObject特殊属性的限制:(Date,BigDecimal等) ​ public class BeanObject { //此处省略getter,setter方法    private String name;    private java.util.Date date; } public class BeanObjectTest {     public static void main(String args[]) throws Throwable {     BeanObject from = new BeanObject();     BeanObject to = new BeanObject();     //from.setDate(new java.util.Date());     from.setName("TTTT");     org.apache.commons.beanutils.BeanUtils.copyProperties(to, from);//如果from.setDate去掉,此处出现conveter异常     System.out.println(ToStringBuilder.reflectionToString(from));         System.out.println(ToStringBuilder.reflectionToString(to));     } }

  • org.apache.commons.beanutils.BeanUtils.copyProperties(Object dest, Object orig)
  • 相同属性名,且类型不匹配时候的处理
  • 原因:这两个工具类不支持同名异类型的匹配 !!!【包装类 Long 和原始数据类型 long 是可以的】

public class SourceClass {  //此处省略getter,setter方法    private Long num;    private String name; } ​ public class TargetClass {  //此处省略getter,setter方法    private Long num;    private String name; } ​ public class PropertyUtilsTest {    public static void main(String args[]) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException {        SourceClass from = new SourceClass();        from.setNum(1);        from.setName("name");        TargetClass to = new TargetClass();        //抛出参数不匹配异常        org.apache.commons.beanutils.PropertyUtils.copyProperties(to, from);        org.springframework.beans.BeanUtils.copyProperties(from, to);        //抛出参数不匹配异常        System.out.println(ToStringBuilder.reflectionToString(from));        System.out.println(ToStringBuilder.reflectionToString(to));   } }

Spring 版本:(反射机制)

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

cglib 版本:(使用动态代理,效率高)

cglib 是一款比较底层的操作 java 字节码的框架

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

工具操作

img

原理简介

反射类型:(apache)

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

public BeanUtilsBean(){    this(new ConvertUtilsBean(), new PropertyUtilsBean()); }

  • ConvertUtilsBean 可以通过 ConvertUtils 全局自定义注册。
  • ConvertUtils.register(new DateConvert(), java.util.Date.class);
  • PropertyUtilsBean 的 copyProperties 方法实现了拷贝的算法。

  • 动态 bean:orig instanceof DynaBean:Object value = ((DynaBean)orig).get(name); 然后把 value 复制到动态 bean 类。

  • Map 类型:orig instanceof Map:key 值逐个拷贝
  • 其他普通类:从 beanInfo【每一个对象都有一个缓存的 bean 信息,包含属性字段等】取出 name,然后把 sourceClass 和 targetClass 逐个拷贝。

Cglib 类型:BeanCopier

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

Get 和 set 方法不匹配的处理

public class BeanCopierTest {    /**    * 从该用例看出BeanCopier.create的target.class 的每一个get方法必须有队形的set方法    * @param args    */    public static void main(String args[]) {        BeanCopier copier = BeanCopier.create(UnSatifisedBeanCopierObject.class, SourceClass.class,false);        copier = BeanCopier.create(SourceClass.class, UnSatifisedBeanCopierObject.class, false); //此处抛出异常创建   } } class UnSatifisedBeanCopierObject {    private String name;    private Long num;    public String getName() {undefined        return name;   }    public void setName(String name) {undefined        this.name = name;   }    public Long getNum() {undefined        return num;   }    // public void setNum(Long num) {undefined    //     this.num = num;    // } }

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 属性过程:调用生成的代理类,代理类的代码和手工操作的代码很类似,效率非常高。

上述这几种方式速度最快的是 BeanCopier,默认只复制名称和类型相同的字段,还会对 date 为空的情况不进行复制。

我认为这样做最好,比如对象 A 的值复制到 B 中,我们把相同的进行复制,把不同的,也就是需要我们个性化的一些字段,单独出来用 get 来赋值,这样程序就会很明确,重点也就聚焦在了不同的地方。