关于spring:Java对象拷贝原理剖析及最佳实践

作者：宁海翔

对象拷贝，是咱们在开发过程中，绕不开的过程，既存在于 Po、Dto、Do、Vo 各个体现层数据的转换，也存在于零碎交互如序列化、反序列化。

Java 对象拷贝分为深拷贝和浅拷贝，目前罕用的属性拷贝工具，包含 Apache 的 BeanUtils、Spring 的 BeanUtils、Cglib 的 BeanCopier、mapstruct 都是浅拷贝。

深拷贝：对根本数据类型进行值传递，对援用数据类型，创立一个新的对象，并复制其内容称为深拷贝。

深拷贝常见有以下四种实现形式:

构造函数
Serializable 序列化
实现 Cloneable 接口
JSON 序列化

浅拷贝：对根本数据类型进行值传递，对援用数据类型进行援用传递般的拷贝称为浅拷贝。通过实现 Cloneabe 接口并重写 Object 类中的 clone() 办法能够实现浅克隆。

目前罕用的属性拷贝工具，包含 Apache 的 BeanUtils、Spring 的 BeanUtils、Cglib 的 BeanCopier、mapstruct。

Apache BeanUtils:BeanUtils 是 Apache commons 组件外面的成员，由 Apache 提供的一套开源 api，用于简化对 javaBean 的操作，可能对根本类型主动转换。
Spring BeanUtils：BeanUtils 是 spring 框架下自带的工具，在 org.springframework.beans 包下，spring 我的项目能够间接应用。
Cglib BeanCopier：cglib（Code Generation Library）是一个弱小的、高性能、高质量的代码生成类库，BeanCopier 依靠于 cglib 的字节码加强能力，动静生成实现类，实现对象的拷贝。
mapstruct：mapstruct 是一个 Java 正文处理器，用于生成类型平安的 bean 映射类，在构建时，依据注解生成实现类，实现对象拷贝。

2.1.1 Apache BeanUtils

应用形式：BeanUtils.copyProperties(target, source);
BeanUtils.copyProperties 对象拷贝的外围代码如下:


// 1. 获取源对象的属性形容
PropertyDescriptor[] origDescriptors = this.getPropertyUtils().getPropertyDescriptors(orig);
PropertyDescriptor[] temp = origDescriptors;
int length = origDescriptors.length;
String name;
Object value;

// 2. 循环获取源对象每个属性，设置指标对象属性值
for(int i = 0; i < length; ++i) {PropertyDescriptor origDescriptor = temp[i];
name = origDescriptor.getName();
// 3. 校验源对象字段可读切指标对象该字段可写
if (!"class".equals(name) && this.getPropertyUtils().isReadable(orig, name) && this.getPropertyUtils().isWriteable(dest, name)) {
try {
// 4. 获取源对象字段值
value = this.getPropertyUtils().getSimpleProperty(orig, name);
// 5. 拷贝属性
this.copyProperty(dest, name, value);
} catch (NoSuchMethodException var10) {}}
}

循环遍历源对象的每个属性，对于每个属性，拷贝流程为:

校验起源类的字段是否可读 isReadable
校验指标类的字段是否可写 isWriteable
获取起源类的字段属性值 getSimpleProperty
获取指标类字段的类型 type，并进行类型转换
设置指标类字段的值

因为单字段拷贝时每个阶段都会调用 PropertyUtilsBean.getPropertyDescriptor 获取属性配置, 而该办法通过 for 循环获取类的字段属性，重大影响拷贝效率。
获取字段属性配置的外围代码如下：

PropertyDescriptor[] descriptors = this.getPropertyDescriptors(bean);
if (descriptors != null) {for (int i = 0; i < descriptors.length; ++i) {if (name.equals(descriptors[i].getName())) {return descriptors[i];
}
}
}

应用形式: BeanUtils.copyProperties(source, target);
BeanUtils.copyProperties 外围代码如下：

PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);
List<String> ignoreList = ignoreProperties != null ? Arrays.asList(ignoreProperties) : null;
PropertyDescriptor[] arr$ = targetPds;
int len$ = targetPds.length;
for(int i$ = 0; i$ < len$; ++i$) {PropertyDescriptor targetPd = arr$[i$];
Method writeMethod = targetPd.getWriteMethod();
if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
if (sourcePd != null) {Method readMethod = sourcePd.getReadMethod();
if (readMethod != null && ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) {
try {if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {readMethod.setAccessible(true);
}
Object value = readMethod.invoke(source);
if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {writeMethod.setAccessible(true);
}
writeMethod.invoke(target, value);
} catch (Throwable var15) {throw new FatalBeanException("Could not copy property'" + targetPd.getName() + "'from source to target", var15);
}
}
}
}
}

拷贝流程简要形容如下:

获取指标类的所有属性形容
循环指标类的属性值做以下操作
- 获取指标类的写办法
- 获取起源类的该属性的属性形容 (缓存获取)
- 获取起源类的读办法
- 读起源属性值
- 写指标属性值

与 Apache BeanUtils 的属性拷贝相比，Spring 通过 Map 缓存，防止了类的属性形容反复获取加载，通过懒加载，首次拷贝时加载所有属性形容。

2.1.3 Cglib BeanCopier

应用形式：

BeanCopier beanCopier = BeanCopier.create(AirDepartTask.class, AirDepartTaskDto.class, false);
beanCopier.copy(airDepartTask, airDepartTaskDto, null);

create 调用链如下:

BeanCopier.create
-\> BeanCopier.Generator.create
-\> AbstractClassGenerator.create
->DefaultGeneratorStrategy.generate
-\> BeanCopier.Generator.generateClass

BeanCopier 通过 cglib 动静代理操作字节码，生成一个复制类，触发点为 BeanCopier.create

2.1.4 mapstruct

应用形式:

引入 pom 依赖
申明转换接口

mapstruct 基于注解，构建时主动生成实现类，调用链如下:
MappingProcessor.process -> MappingProcessor.processMapperElements
MapperCreationProcessor.process: 生成实现类 Mapper
MapperRenderingProcessor: 将实现类 mapper，写入文件，生成 impl 文件
应用时须要申明转换接口，例如：

@Mapper(nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
public interface AirDepartTaskConvert {AirDepartTaskConvert INSTANCE = getMapper(AirDepartTaskConvert.class);
AirDepartTaskDto convertToDto(AirDepartTask airDepartTask);
}

生成的实现类如下：

public class AirDepartTaskConvertImpl implements AirDepartTaskConvert {

@Override
public AirDepartTaskDto convertToDto(AirDepartTask airDepartTask) {if ( airDepartTask == null) {return null;}

AirDepartTaskDto airDepartTaskDto = new AirDepartTaskDto();

airDepartTaskDto.setId(airDepartTask.getId() );
airDepartTaskDto.setTaskId(airDepartTask.getTaskId() );
airDepartTaskDto.setPreTaskId(airDepartTask.getPreTaskId() );
List<String> list = airDepartTask.getTaskBeginNodeCodes();
if (list != null) {airDepartTaskDto.setTaskBeginNodeCodes( new ArrayList<String>( list) );
}
// 其余属性拷贝
airDepartTaskDto.setYn(airDepartTask.getYn() );

return airDepartTaskDto;
}
}

以航空业务零碎中发货工作 po 到 dto 转换为例，随着拷贝数据量的增大，钻研拷贝数据耗时状况

通过以上剖析，随着数据量的增大，耗时整体呈上升趋势

整体状况下，Apache BeanUtils 的性能最差，日常应用过程中不倡议应用
在数据规模不大的状况下，spring、cglib、mapstruct 差别不大，spring 框架下倡议应用 spring 的 beanUtils，不须要额定引入依赖包
数据量大的状况下，倡议应用 cglib 和 mapstruct
波及大量数据转换，属性映射，格局转换的，倡议应用 mapstruct

应用时能够应用 map 缓存，缩小同一类对象转换时，create 次数

/**
* BeanCopier 的缓存，防止频繁创立，高效复用
*/
private static final ConcurrentHashMap<String, BeanCopier> BEAN_COPIER_MAP_CACHE = new ConcurrentHashMap<String, BeanCopier>();

/**
* BeanCopier 的 copyBean，高性能举荐应用，减少缓存
*
* @param source 源文件的
* @param target 指标文件
*/
public static void copyBean(Object source, Object target) {String key = genKey(source.getClass(), target.getClass());
BeanCopier beanCopier;
if (BEAN_COPIER_MAP_CACHE.containsKey(key)) {beanCopier = BEAN_COPIER_MAP_CACHE.get(key);
} else {beanCopier = BeanCopier.create(source.getClass(), target.getClass(), false);
BEAN_COPIER_MAP_CACHE.put(key, beanCopier);
}
beanCopier.copy(source, target, null);
}

/**
* 不同类型对象数据 copylist
*
* @param sourceList
* @param targetClass
* @param <T>
* @return
*/
public static <T> List<T> copyListProperties(List<?> sourceList, Class<T> targetClass) throws Exception {if (CollectionUtils.isNotEmpty(sourceList)) {List<T> list = new ArrayList<T>(sourceList.size());
for (Object source : sourceList) {T target = copyProperties(source, targetClass);
list.add(target);
}
return list;
}
return Lists.newArrayList();}

/**
* 返回不同类型对象数据 copy, 应用此办法需注意不能笼罩默认的无参构造方法
*
* @param source
* @param targetClass
* @param <T>
* @return
*/
public static <T> T copyProperties(Object source, Class<T> targetClass) throws Exception {T target = targetClass.newInstance();
copyBean(source, target);
return target;
}

/**
* @param srcClazz 源 class
* @param tgtClazz 指标 class
* @return string
*/
private static String genKey(Class<?> srcClazz, Class<?> tgtClazz) {return srcClazz.getName() + tgtClazz.getName();}

mapstruct 反对多种形式对象的映射，次要有上面几种

根本映射
映射表达式
多个对象映射到一个对象
映射汇合
映射 map
映射枚举
嵌套映射

@Mapper(nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
public interface AirDepartTaskConvert {AirDepartTaskConvert INSTANCE = getMapper(AirDepartTaskConvert.class);

// a. 根本映射
@Mapping(target = "createTime", source = "updateTime")
// b. 映射表达式
@Mapping(target = "updateTimeStr", expression = "java(new SimpleDateFormat( \"yyyy-MM-dd\").format(airDepartTask.getCreateTime()))")
AirDepartTaskDto convertToDto(AirDepartTask airDepartTask);
}

@Mapper
public interface AddressMapper {AddressMapper INSTANCE = Mappers.getMapper(AddressMapper.class);

// c. 多个对象映射到一个对象
@Mapping(source = "person.description", target = "description")
@Mapping(source = "address.houseNo", target = "houseNumber")
DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Address address);
}

@Mapper
public interface CarMapper {
// d. 映射汇合
Set<String> integerSetToStringSet(Set<Integer> integers);

List<CarDto> carsToCarDtos(List<Car> cars);

CarDto carToCarDto(Car car);
// e. 映射 map
@MapMapping(valueDateFormat = "dd.MM.yyyy")
Map<String,String> longDateMapToStringStringMap(Map<Long, Date> source);

// f. 映射枚举
@ValueMappings({@ValueMapping(source = "EXTRA", target = "SPECIAL"),
@ValueMapping(source = "STANDARD", target = "DEFAULT"),
@ValueMapping(source = "NORMAL", target = "DEFAULT")
})
ExternalOrderType orderTypeToExternalOrderType(OrderType orderType);
// g. 嵌套映射
@Mapping(target = "fish.kind", source = "fish.type")
@Mapping(target = "fish.name", ignore = true)
@Mapping(target = "ornament", source = "interior.ornament")
@Mapping(target = "material.materialType", source = "material")
@Mapping(target = "quality.report.organisation.name", source = "quality.report.organisationName")
FishTankDto map(FishTank source);
}

以上就是我在应用对象拷贝过程中的一点浅谈。在日常零碎开发过程中，要深究底层逻辑，哪怕发现一小点的扭转可能使咱们的零碎更加稳固、顺畅，都是值得咱们去改良的。

最初，心愿随着咱们的退出，零碎会更加稳固、顺畅，咱们会变得越来越优良。

关于spring:Java对象拷贝原理剖析及最佳实践

1 前言

1.1 深拷贝

1.2 浅拷贝

2 罕用对象拷贝工具原理分析及性能比照

2.1 原理剖析

2.1.2 Spring BeanUtils

2.2 性能比照

2.3 拷贝选型

3 最佳实际

3.1 BeanCopier

3.2 mapstruct

4 总结