logo
Redian新闻
>公众号
>
Java对象拷贝原理剖析及最佳实践

Java对象拷贝原理剖析及最佳实践

公众号新闻

来源 | OSCHINA 社区
作者 | 京东云开发者-宁海翔
原文链接：https://my.oschina.net/u/4090830/blog/5598304

1 前言

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

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

1.1 深拷贝

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

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

  • 构造函数

  • Serializable 序列化

  • 实现 Cloneable 接口

  • JSON 序列化

1.2 浅拷贝

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


2 常用对象拷贝工具原理剖析及性能对比

目前常用的属性拷贝工具，包括 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 原理分析

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];
}
}
}

2.1.2 Spring BeanUtils

使用方式: 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;
}
}

2.2 性能对比

以航空业务系统中发货任务 po 到 dto 转换为例，随着拷贝数据量的增大，研究拷贝数据耗时情况

2.3 拷贝选型

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

  • 整体情况下，Apache BeanUtils 的性能最差，日常使用过程中不建议使用

  • 在数据规模不大的情况下，spring、cglib、mapstruct 差异不大，spring 框架下建议使用 spring 的 beanUtils，不需要额外引入依赖包

  • 数据量大的情况下，建议使用 cglib 和 mapstruct

  • 涉及大量数据转换，属性映射，格式转换的，建议使用 mapstruct

3 最佳实践

3.1 BeanCopier

使用时可以使用 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();
}

3.2 mapstruct

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 );
}

4 总结

以上就是我在使用对象拷贝过程中的一点浅谈。在日常系统开发过程中，要深究底层逻辑，哪怕发现一小点的改变能够使我们的系统更加稳定、顺畅，都是值得我们去改进的。

最后，希望随着我们的加入，系统会更加稳定、顺畅，我们会变得越来越优秀。


你参与开源吗？

扫描下方二维码

抽开源中国周边啦~


END



开发者必备的Firfox插件

这里有最新开源资讯、软件更新、技术干货等内容

点这里 ↓↓↓ 记得 关注✔ 标星⭐ 哦~

微信扫码关注该文公众号作者

戳这里提交新闻线索和高质量文章给我们。
来源: qq
点击查看作者最近其他文章
相关阅读
一文读懂零拷贝技术｜splice 原理与实现一文学会 ByteHouse 搭建数仓最佳实践PD-L1/PD-1研究2022丨诺奖加持，论文和基金均火箭速度增长；成果及转化正在其时！大数据分析及19篇论文帮你理清思路天价联动！Off-White x AJ1「巴黎」限定特别配色 - 拷贝AI推理加速原理解析与工程实践分享 | Q推荐科技企业资本市场上市系列：港交所18C章上市规则咨询文件公布及最新解读一文读懂零拷贝技术｜splice 使用设计模式最佳实践探索—策略模式应采儿晒小儿子「拷贝爸五官」意外曝豪宅装潢！42岁林峰披荆斩棘 少年感不输小鲜肉！C++ 类设计和实现的十大最佳实践工科跨申BA、经济学，如何弥补专业知识、数据分析及实践经历的空缺？直播：希腊购房移民变政全解析及优质房源介绍高性能计算：RoCE技术分析及应用AI 训练加速原理解析与工程实践分享 | Q推荐菠萝炒饭和菠萝酒以色列粮食养活欧洲？？？2022金字招牌最佳实践典范Python 项目工程化最佳实践指南多伦多穿越民国,走进电影小镇|实景沉浸式剧场|5000尺超大场景,瞬间回到民国 - 拷贝直播预告：动力电池的冰与火之歌，最佳实践方向在哪里？双11熊猫外卖下血本了 史上最大优惠！！- 拷贝 - 拷贝俄乌冲突对航天国际合作的影响分析及启示Prompt总结 | 从MLM预训任务到Prompt Learning原理解析与Zero-shot分类、NER简单实践为业务场景打造技术矩阵，网易智企畅谈融合通信与 AI 商业化最佳实践 | Q推荐Kubernetes上千规模Pod最佳实践C-Section，处女膜和女权运动干货 | 高频多因子存储的最佳实践京东位列2022新型实体企业100强第二，创造供应链数实融合最佳实践使用AppSync为在Dell PowerFlex上运行的应用程序提供拷贝数据管理香港联交所特专科技公司上市制度咨询文件简析及与上交所科创板规则对比一颗心可以分成几瓣政策+航线双重惊喜，服务+价格双倍体验。回国？找平安就对了！走！回家过年 - 拷贝国产CPU及最新规格概述活着（四）绿研院日报 | 新奥股份获“ESG年度最佳实践上市公司”
logo
联系我们隐私协议©2024 redian.news
Redian新闻
Redian.news刊载任何文章，不代表同意其说法或描述，仅为提供更多信息，也不构成任何建议。文章信息的合法性及真实性由其作者负责，与Redian.news及其运营公司无关。欢迎投稿，如发现稿件侵权，或作者不愿在本网发表文章，请版权拥有者通知本网处理。