基于 asm 实现比 spring BeanUtils.copyProperty 性能更好的属性拷贝框架

约定不等于承诺〃 2023-06-23 05:59 4阅读 0赞

# Bean-Mapping #

日常开发中经常需要将一个对象的属性，赋值到另一个对象中。

常见的工具有很多，但都多少不够简洁，要么不够强大。

我们经常使用的 Spring BeanUtils 性能较好，但是特性不足。

[Bean-Mapping][] 提供了很多丰富的特性，便于日常开发。

如果你追求更加极致的性能，可以考虑使用 asm 实现的模块，该实现性能优于 spring BeanUtils 35% 左右。

## 特性 ##

*  支持对象属性的浅拷贝
 *  支持不同名称字段的指定赋值
 *  支持自定义字段属性赋值的条件，比如目标字段不为 null 才进行赋值
 *  支持自定义字段值转换，可以转换为其他类型，或者相同类型
 *  支持属性字段为【对象】【集合】【数组】的赋值，对象赋值更加方便。
 *  支持基于 asm 实现的高性能复制

# 快速开始 #

## 准备 ##

JDK1.7 及其以上版本

Maven 3.X 及其以上版本

## maven 项目依赖 ##

<dependency>
        <groupId>com.github.houbb</groupId>
        <artifactId>bean-mapping-core</artifactId>
        <version>0.2.5</version>
    </dependency>

## 核心类说明 ##

### BeanUtil ###

提供一个简单的静态方法 copyProperties。

/** * 复制属性 * 将 source 中的赋值给 target 中名称相同，且可以赋值的类型中去。类似于 spring 的 BeanUtils。 * @param source 原始对象 * @param target 目标对象 */
    public static void copyProperties(final Object source, Object target)

# 测试代码参考 #

详情参见 bean-mapping-test 模块下的测试代码。

# 示例代码 #

## 对象的定义 ##

*  BaseSource.java & BaseTarget.java

其中 BaseSource 对象和 BaseTarget 对象的属性是相同的。

public class BaseSource { 
    
        /** * 名称 */
        private String name;
    
        /** * 年龄 */
        private int age;
    
        /** * 生日 */
        private Date birthday;
    
        /** * 字符串列表 */
        private List<String> stringList;
        
        //getter & setter
    }

## 属性赋值测试案例 ##

我们构建 BaseSource 的属性，然后调用

BeanUtil.copyProperties(baseSource, baseTarget);

类似于 spring BeanUtils 和 Apache BeanUtils，并验证结果符合我们的预期。

/** * 基础测试 */
        @Test
        public void baseTest() { 
            BaseSource baseSource = buildBaseSource();
            BaseTarget baseTarget = new BaseTarget();
            BeanUtil.copyProperties(baseSource, baseTarget);
    
            // 断言赋值后的属性和原来相同
            Assertions.assertEquals(baseSource.getAge(), baseTarget.getAge());
            Assertions.assertEquals(baseSource.getName(), baseTarget.getName());
            Assertions.assertEquals(baseSource.getBirthday(), baseTarget.getBirthday());
            Assertions.assertEquals(baseSource.getStringList(), baseTarget.getStringList());
        }
    
        /** * 构建用户信息 * @return 用户 */
        private BaseSource buildBaseSource() { 
            BaseSource baseSource = new BaseSource();
            baseSource.setAge(10);
            baseSource.setName("映射测试");
            baseSource.setBirthday(new Date());
            baseSource.setStringList(Arrays.asList("1", "2"));
            return baseSource;
        }

# asm 复制 #

## 简介 ##

有时候我们对于性能要求较高，而对便利性要求没有这么高。

本框架也提供了基于 asm 的复制方式，性能比 spring 好 35% 左右。

见文末的 benchmark。

## maven 引入 ##

<dependency>
        <groupId>com.github.houbb</groupId>
        <artifactId>bean-mapping-asm</artifactId>
        <version>0.2.5</version>
    </dependency>

## 测试代码 ##

和 `BeanUtil#copyProperties(Object, Object)` 使用类似，但是暂时不支持注解等更加丰富的功能。

BaseSource baseSource = buildBaseSource();
    BaseTarget baseTarget = new BaseTarget();
    AsmBeanUtil.copyProperties(baseSource, baseTarget);

# 拓展阅读 #

实际工作中，我们遇到的情况会比这个复杂一些。

比如两个字段名称不同，我们也想进行赋值，值得处理转换等等。

## 深入学习 ##

Bean-Mapping 相关文档:

[01-项目模块简介和预期功能][01-]

[02-BeanMapping 注解的引入][02-BeanMapping]

03-不同名称字段的指定赋值

[04-自定义赋值生效的条件][04-]

[05-自定义字段转换实现][05-]

[06-支持属性字段为【对象】【集合】【数组】的赋值][06-]

07-BeanUtil\#copyProperties(Object, Class) 方法

# 性能 #

## 对比图 ##

![benchmark][]

可见框架默认 bean-mapping 实现性能一般，涉及到了太多的特性，导致复制性能略低于 spring。

基于 [reflectasm][] 实现的 asm-bean-mapping 的性能高于 spring。

代码示例参见 [BeanUtilBeanchmarkTest.java][]

## 展望 ##

相对 BeanCopier 这种实现方式，我们的实现方式性能还是有很大提升空间。

后期可以考虑实现类似 BeanCopier 的方式。

# 开源地址 #

这个框架的源代码全部开源，也便于我们学习。

> [Bean-Mapping][]

[Bean-Mapping]: https://github.com/houbb/bean-mapping
[01-]: https://github.com/houbb/bean-mapping/tree/master/doc/blog/%E5%B1%9E%E6%80%A7%E5%A4%8D%E5%88%B6%E6%A1%86%E6%9E%B6-00-%E9%A1%B9%E7%9B%AE%E6%A8%A1%E5%9D%97%E5%92%8C%E9%A2%84%E6%9C%9F%E5%8A%9F%E8%83%BD.md
[02-BeanMapping]: https://github.com/houbb/bean-mapping/tree/master/doc/blog/%E5%B1%9E%E6%80%A7%E5%A4%8D%E5%88%B6%E6%A1%86%E6%9E%B6-01-BeanMapping%20%E6%B3%A8%E8%A7%A3%E5%BC%95%E5%85%A5.md
[04-]: https://github.com/houbb/bean-mapping/tree/master/doc/blog/%E5%B1%9E%E6%80%A7%E5%A4%8D%E5%88%B6%E6%A1%86%E6%9E%B6-03-BeanMapping%20%E8%B5%8B%E5%80%BC%E6%9D%A1%E4%BB%B6.md
[05-]: https://github.com/houbb/bean-mapping/tree/master/doc/blog/%E5%B1%9E%E6%80%A7%E5%A4%8D%E5%88%B6%E6%A1%86%E6%9E%B6-04-BeanMapping%20%E5%AD%97%E6%AE%B5%E8%BD%AC%E6%8D%A2.md
[06-]: https://github.com/houbb/bean-mapping/tree/master/doc/blog/%E5%B1%9E%E6%80%A7%E5%A4%8D%E5%88%B6%E6%A1%86%E6%9E%B6-05-BeanMappingEntry.md
[benchmark]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL2hvdWJiL2JlYW4tbWFwcGluZy9tYXN0ZXIvYmVuY2htYXJrLnBuZw?x-oss-process=image/format,png
[reflectasm]: https://houbb.github.io/2018/07/20/asm-14-reflectasm
[BeanUtilBeanchmarkTest.java]: https://github.com/houbb/bean-mapping/blob/master/bean-mapping-test/src/test/java/com/github/houbb/bean/mapping/test/core/benchmark/BeanUtilBeanchmarkTest.java