构建功能最强、性能最好的Java BeanCopy类库

2023年2月9日 279次阅读 来源: java集合源码分析
本文所提到的类库已经开源到GITHUB，读者可下载源码并提宝贵意见。

转载请注明出处: www.jianshu.com/p/9a136ecd3…

问题

在现有的项目中，由于采用了PO/DTO/VO模型，导致需要大量的代码进行Java对象间的拷贝操作。通常的做法是取一个对象的get方法，设置到另一个对象的set方法上去：

    public MaterialInfoVO getMaterialInfo(String materialId) {
        
        MaterialInfo materialInfo = this.materialDao.findById(materialId);
        
        MaterialInfoVO materialInfoVO = new MaterialInfoVO();
        materialInfoVO.setMaterialId(materialInfo.getId());
        materialInfoVO.setType(materialInfo.getType());
        materialInfoVO.setArticles(new ArrayList<ArticleInfoVO>());
        
        List<ArticleInfo> articles = materialInfo.getArticles();
        for (ArticleInfo article : articles) {
            ArticleInfoVO articleInfoVO = new ArticleInfoVO();
            materialInfoVO.getArticles().add(articleInfoVO);
            
            articleInfoVO.setArticleId(article.getId());
            articleInfoVO.setTitle(article.getTitle());
            articleInfoVO.setContent(article.getContent());
            articleInfoVO.setContentSourceUrl(article.getContentSourceUrl());
            articleInfoVO.setDigest(article.getDigest());
            articleInfoVO.setShowCoverPic(article.getShowCoverPic());
            articleInfoVO.setShowOrder(article.getShowOrder());
            articleInfoVO.setThumbMediaId(article.getThumbMediaId());
            articleInfoVO.setUrl(article.getUrl());
            articleInfoVO.setContentSourceUrl(article.getContentSourceUrl());
            
        }
        
        return materialInfoVO;
    }

然而，大量类似重复的代码到处可见，代码重复度太高，而且很容易视觉疲劳，导致字段遗漏。由此萌生了改善的想法，希望能达到以下的目的：

    public MaterialInfoVO getMaterialInfo(Integer materialId) {
        MaterialInfo materialInfo = this.materialDao.findById(materialId);
        return BeanCopyUtils.copyBean(materialInfo,MaterialInfoVO.class);
    }

需求分析

为了改善代码，能够自动的将一个类的属性Copy到另一个类中，并且还需要满足以下的特定需求：

  • 属性名称映射：From类的属性叫id，To类的却是materialId。要能够映射到不同名称的属性上去；
  • 基本类型自动转换：要能够自动针对Java中的Primitive Type同对应的Java Type进行转换。例如：int同Integer之间转换；
  • 忽略拷贝： 要能够支持属性过滤，对不想进行拷贝的属性能够不拷贝。例如：user的password属性就不想拷贝出去；
  • 递归拷贝：From类中的某个属性也是JavaBean，也需要拷贝到To类中某个JavaBean中去；
  • 数组拷贝：如果From类中的某个属性是数组类型，也希望能拷贝到To类中对应的属性中去；
  • 集合拷贝：同数组拷贝一样，如果From类中的某个属性是集合（List，Set等）类型，也希望能拷贝到To类中对应的属性中去；
  • 自定义数据转换：如果在拷贝的过程中，希望能够按照自定义的规则将某些属性转换成其他数据类型。例如：将Date转换成String；
  • 接口简单：我们都是程序员，不希望写复杂的代码。

现有库调研

在目前比较通用的BeanCopy类库中，有如下的几个类库：

  • org.apache.commons.beanutils.BeanUtil.copyProperties
  • org.apache.commons.beanutils.PropertyUtils.copyProperties
  • org.springframework.beans.BeanUtils.copyProperties
  • org.springframework.cglib.beans.BeanCopier.create
  • net.sf.ezmorph.bean.BeanMorpher

上面是目前能在市面上找到的几个比较通用的类库。然而，这些类库却很难满足上述的需求：

Library属性名称映射基本类型转换忽略拷贝数组拷贝集合拷贝自定义转换性能
apache BeanUtil. copyPropertiesXXXXXX惨不忍睹
apache PropertyUtils. copyPropertiesXXXXXX惨不忍睹
spring BeanUtils. copyPropertiesX√√XXX还能接受
cglib BeanCopierXXXXX难用优秀
ezmorph BeanMorpherXXXXXX惨不忍睹

也许有些库的用法还不得知，但很难全部功能都满足。看来只能自己造轮子了。

库接口设计

函数接口

为了自己的轮子能否方便的使用，在接口函数设计上可尽量简单。 函数调用方式如下：

  // 使用class方式
  ToBean toBean = BeanCopyUtils.copyBean(fromBean, ToBean.class);
  // 使用对象方式
  ToBean toBean = new ToBean();
  BeanCopyUtils.copyBean(fromBean, toBean);

为了能达到上述的需求，需要引入一些注解来进行配置。


                                           @BeanCopySource(source=FromBean.class)          
    public class FromBean {                public class ToBean {                           
                                                                                           
        private boolean beanBool;              private Boolean beanBool;                   
        private byte beanByte;                 private Byte beanByte;                      
        private char beanChar;                 private Character beanChar;                 
        private short beanShort;               private Short beanShort;                    
        private int beanInt;                   private Integer beanInt;                    
        private Long beanLong;                 private long beanLong;                      
        private Float beanFloat;               private float beanFloat;                    
        private Double beanDouble;             private double beanDouble;                  
        private String beanString;             private String beanString;                  
                                                                                           
                                               @CopyProperty(convertor=DateConvertor.class)
        private Date beanDate;                 private String beanDate;                    
                                                                                           
        private int[] beanIntArray;            private int[] beanIntArray;                 
                                                                                           
                                               @CopyProperty                               
        private FromBean2 bean2;               private ToBean2 bean2;                      
                                                                                           
                                               @CopyCollection(targetClass=ToBean3.class)  
        private List<FromBean3> bean3List;     private List<ToBean3> bean3List;            
                                                                                           
                                               @CopyProperty                               
        private FromBean4[] bean4Array;        private ToBean4[] bean4Array;               
                                                                                           
        // getters and setters...              @CopyProperty(property="beanInt")           
    }                                          private int beanId;                         
                                                                                           
                                               @CopyProperty(property="bean2.beanString")  
                                               private String bean2String;                 
                                               
                                               // getters and setters...
                                           }

现在问题又来了，如果ToBean是第三方类库的，无法在ToBean上加注解，怎么办？这能难倒我吗？这儿仅需要提供一个Option类，将所有注解的内容加到Option类中，让Option类代替ToBean来做配置。

@BeanCopySource(source=FromBean.class)
public class ToBeanOption {
    
    private Boolean beanBool;
    private Byte beanByte;
    private Character beanChar;
    private Short beanShort;
    private Integer beanInt;
    private long beanLong;
    private float beanFloat;
    private double beanDouble;
    private String beanString;
    
    @CopyProperty(convertor=DateConvertor.class)
    private String beanDate;
    
    private int[] beanIntArray;

    @CopyProperty
    private ToBean2 bean2;
    
    @CopyCollection(targetClass=ToBean3.class)
    private List<ToBean3> bean3List;
    
    @CopyProperty
    private ToBean4[] bean4Array;
    
    @CopyProperty(property="beanInt")
    private int beanId;
    
    @CopyProperty(property="bean2.beanString")
    private String bean2String;
    // getters and setters can be empty.
}

调用方法也非常简单：

  // 使用class方式
  ToBean toBean = BeanCopyUtils.copyBean(fromBean, ToBean.class, ToBeanOption.class);
  // 使用对象方式
  ToBean toBean = new ToBean();
  BeanCopyUtils.copyBean(fromBean, toBean, ToBeanOption.class);

是不是有点羡慕？

自定义数据转换

为了支持自定义数据转换，需要引入接口，以方便自定义转换要求：

public interface BeanCopyConvertor<S, T> {
    abstract public T convertTo(S object);
}

具体实现举例：

public class GendorConvertor implements BeanCopyConvertor<Integer, String> {

    @Override
    public String convertTo(Integer object) {
        if( object == 1 ) 
            return "Male";
        if( object == 2) 
            return "Female";
        return "Unknown";
    }
}

当然，也需要在注解上标明：

    @CopyProperty(convertor=GendorConvertor.class)
    private String gendor;

实现及优化

具体的实现步骤不表，仅说优化及其它考虑。

优化方案

  • 使用缓存
    由于采取的注解的方式，所以在拷贝具体执行前可以明确的知道哪些属性要拷贝，需要做哪些映射，对应哪些属性要做递归拷贝等。而且，对于特定的FromBean和ToBean以及特定的ToBeanOption，在整个Java进程的生命期中拷贝的属性是定死的。因此，我们可以先解析注解的拷贝信息，然后缓存起来，在后续相同的对象类型拷贝中直接使用。
  • 使用Javassist类库
    如果直接使用Java的反射方式，那么性能最高也就是和spring的BeanUtils.copyProperties性能相当。对于CGlib的BeanCopier那样高性能，只能采取相同的做法，也就是动态生成特定的Copy class，然后在执行。可惜我对CGlib的纯粹字节码操作不感冒，因此采用了Javassist库了。

减少依赖

类库设计之初是为了通用使用，因此要尽量减少对其它类库的引用。因此，除了必须要引用的javassist类库之外，全部自我实现相关功能，不引用其它的类库。 更为甚者，如果要在javassist类都无法运行的环境中使用此库，也可以通过修改此类库的全局配置，切换到用反射的方式上运行此库。

缺省集合类

再做集合拷贝的时候，对于集合类的实现类可以通过全局配置的方式切换为自定义的实现类。 例如List对应的实现类，缺省为ArrayList。但是如果想使用LinkedList，可以通过全局配置来进行切换。

性能

通过对不同类库循环调用的方法来测试各个类库的性能。

Library1 time100 times10000 times1000000 times10000000 times
apache BeanUtil.copyProperties112128996399879
apache PropertyUtils.copyProperties0256556455651
spring BeanUtils.copyProperties0254734700
ezmorph BeanMorpher1467676968051
cglib BeanCopier.create 112287843
cglib BeanCopier.create 20001098
BeanCopyUtils.copyBean 100021196
BeanCopyUtils.copyBean 20001197
native Copy0001088
  • 表格中数字单位为毫秒，也就是对应类库运行次数所花费的时间
  • 表格中各个数据为类库的运行多次的平均值，运行平台为Win10, intel i7 6700HQ, 24G
  • 具体的测试代码也在GITHUB中。读者可自行下载运行比较
  • cglib BeanCopier.create的两种使用方法和BeanCopyUtils.copyBean的两种使用方法，请参考GITHUB中代码
  • native copy：就是全部手动写get/set代码

结尾和后续

目前第一版本已经完成，后续会加上对注解的检查函数，以避免注解配置错误。同时由于是第一版本，测试的并不是很充分，还需要大量的测试来保证正确性。

关于作者

作者很懒，很少发表技术有关的话题文章。同时作者在软件开发上混了快20年，辗转于C、C++，Java，Object-C各个开发语言之间；做过Windows、Linux、Android、iOS以及Java后台开发，管理过20+以上的团队。但更多的，却是想当一个默默奉献的码农。

    原文作者：java集合源码分析
    原文地址: https://juejin.im/entry/598d6a7f6fb9a03c367d0a1d
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞