Java 对象拷贝的一些方法和约定

2023-01-16 本文已影响0人 voxer

概述

后台 Java 开发会有很多对象拷贝的情况，这里的对象一般指 Java Bean，或者叫 Model，通常只有一些基础属性 String，int等属性及get、set 方法。在我们目前的项目中主要是 VM<->M<->Entity 之间的转换。
目前主要的问题是数据库 Entity 字段很多，导致对象拷贝的时候代码很长，非常影响代码的结构和理解。

VM 指visual model，大家可以去了解一下 MVVM 的概念

相应解决办法

1. new新对象，通过 get 和 set 方法来获取旧对象的属性和设置新对象的属性值

这是最基础的最通用的方法，很多情况是没有更好的方法的，只能用这个。但是我们可以约定一下，如果属性多(比如4个以上的属性)，我们就可以考虑把代码放到对象类里。
比如在一个TestService.java 里的一个方法里需要把 Bean1 对象的属性拷贝到 Bean2 对象里，如果都写在这个方法里会让代码特别长和混乱，我们可以把这些代码放在 Bean2.java 里，新建一个构造函数或方法来实现对象拷贝。

2. MapStruct

MapStruct 用于 Bean的Copy 应用很广。但是个人不推荐使用，主要原因有2个：

又额外增加很多映射类，看到一大堆文件非常不喜。
转换之间的关系通过注解来标记，非常不直观。写的人简单，但是理解起来要费劲不少。

我们也约定一下不要用这个库。

3. SpringBoot自带的BeanUtil

如果源和目标对象属性值一致，直接使用 copyProperties 没有问题。不过也有一些瑕疵：

我们经常从 VM 到 Entity 需要忽略一些值为 null 的属性，BeanUtil 是不支持的，如果拷贝就会把现有的 Entity 对象里的属性值改为 null
不能拷贝 list，而我们实际情况很多都需要做list的拷贝，从数据库查出的 entity对象列表需要转换成给前端的 vm 对象列表
拷贝的效率低，当然如果数据量小可以忽略

4. Hutool和Cgilib库

Hutool 带的BeanUtil 可以解决忽略 null值的属性拷贝

BeanUtil.copyProperties(model, entity, CopyOptions.create().setIgnoreNullValue(true));

另外 Cgilib 库是公认的效率很高的属性拷贝库，Hutool 在这个基础上又封装了一个 CglibUtil ，使用更为方便，可以看看对应的说明
它最大的优势是可以实现列表的拷贝，推荐使用：

//把一个对象为 PassRecordEntity 的列表拷贝到对象为 LatestPassRecordVm 的列表
List<PassRecordEntity> results = passRecordService.findLatest();
return CglibUtil.copyList(results, LatestPassRecordVm::new);

但是也有一点问题，就是 copyList 只会复制属性名称完全一样的属性，其他的会忽略掉。虽然copyList 还支持第3个参数 Convert，但是 Convert 也会跳过名称不一致的属性

List<Test2> test3List = CglibUtil.copyList(test1List, Test2::new, new Converter() {
    @Override
  //value 是源对象属性的值；target是value值对应的类型，比如1对应的是 Integer；
  //context 对应的是 set方法的名称
    public Object convert(Object value, Class target, Object context) {
    return value;
    }
});

注意：使用 CglibUtil 需要额外依赖cglib的库

implementation 'cglib:cglib:3.3.0'

总结

使用方法4为主，方法1为辅. 不管如何，我们约定：拷贝对象的代码稍微多一些，就把相应的代码放在目标对象的 java 代码里面。