锐客网

  1. 首页 > 睿知 > it技术 > >

Java对象转换与mapstruct实践

IT知识MapStruct对象转换

男儿欲遂平生志，五经勤向窗前读。这篇文章主要讲述Java对象转换与mapstruct实践相关的知识，希望能为你提供帮助。
1 前言在日常开发中，我们经常需要给对象进行赋值，通常会调用其set/get方法，有些时候，如果我们要转换的两个对象之间属性大致相同，会考虑使用属性拷贝工具进行。
如我们经常在代码中会对一个数据结构封装成 DO、PO、DTO、VO等，而这些Bean中的大部分属性都是一样的，所以使用属性拷贝类工具可以帮助我们节省大量的set和get操作。
2 常用工具类市面上有很多类似的工具类，比较常用的有如下图：

 
 
  那么，我们到底应该选择哪种工具类更加合适呢？为什么阿里巴巴java开发手册中提到禁止使用Apache BeanUtils呢？

  3 性能测试对比在 Java 系统工程开发过程中，都会有各个层之间的对象转换，比如 VO、DTO、PO、VO 等，而如果都是手动??get、set??又太浪费时间，还可能操作错误，所以选择一个自动化工具会更加方便。
目前整理出用于对象属性转换有12种，包括：普通的getset、json2Json、Apache属性拷贝、Spring属性拷贝、bean-mapping、bean-mapping-asm、BeanCopier、Orika、Dozer、ModelMapper、JMapper、MapStruct 接下来我们分别测试这11种属性转换操作分别在??一百次???、??一千次???、??一万次???、??十万次???、??一百万次??时候的性能时间对比。


  • ??BeanUtils.copyProperties???  是大家代码里最常出现的工具类，但只要你不把它用错成??Apache??  包下的，而是使用 Spring 提供的，就基本还不会对性能造成多大影响。
  • 但如果说性能更好，可替代手动??get、set???的，还是??MapStruct???  更好用，因为它本身就是在编译期生成??get、set???代码，和我们写??get、set??一样。
  • 其他一些组件包主要基于??AOP???、??ASM???、??CGlib??，的技术手段实现的，所以也会有相应的性能损耗。
4 案例介绍4.1 get\\set
@Component
public class GetSetAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
UserDTO userDTO = new UserDTO();
userDTO.setUserId(var.getUserId());
userDTO.setUserNickName(var.getUserNickName());
userDTO.setCreateTime(var.getCreateTime());
return userDTO;



  • 推荐：★★★☆☆
  • 性能：★★★★★
  • 手段：手写
  • 点评：其实这种方式也是日常使用的最多的，性能肯定是杠杠的，就是操作起来有点麻烦。尤其是一大堆属性的 VO 对象转换为 DTO 对象时候。但其实也有一些快捷的操作方式，比如你可以通过 Shift+Alt 选中所有属性，Shift+Tab 归并到一列，接下来在使用 Alt 选中这一列，批量操作粘贴??userDTO.set??  以及快捷键大写属性首字母，最后切换到结尾补充括号和分号，最终格式化一下就搞定了
4.2. fastjson
这种方案因为通过生成中间json格式字符串，然后再转化成目标对象，性能非常差，同时因为中间会生成json格式字符串，如果转化过多，gc会非常频繁，同时针对复杂场景支持能力不足，基本很少用。
@Component
public class Json2JsonAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
String strJson = JSON.toJSONString(var);
return JSON.parseObject(strJson, UserDTO.class);



  • 推荐：☆☆☆☆☆
  • 性能：★☆☆☆☆
  • 手段：把对象转JSON串，再把JSON转另外一个对象
  • 点评：这么写多半有点烧！
4.3  Apache copyProperties
BeanUtil.copyProperties()结合手写get、set，对于简单的转换直接使用BeanUtil，复杂的转换自己手工写get、set。该方案的痛点就在于代码编写效率低、冗余繁杂还略显丑陋，并且BeanUtil因为使用了反射invoke去赋值性能不高。只能适合bean数量较少、内容不多、转换不频繁的场景。
@Component
public class ApacheCopyPropertiesAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
UserDTO userDTO = new UserDTO();
try
BeanUtils.copyProperties(userDTO, var);
catch (IllegalAccessException | InvocationTargetException e)
e.printStackTrace();

return userDTO;



  • 推荐：☆☆☆☆☆
  • 性能：★☆☆☆☆
  • 手段：Introspector 机制获取到类的属性来进行赋值操作
  • 点评：有坑，兼容性交差，不建议使用
4.4  Spring copyProperties
这种方案针对apache的BeanUtils做了很多优化，整体性能提升不少，不过还是使用反射实现比不上原生代码处理，其次针对复杂场景支持能力不足。
@Component
public class SpringCopyPropertiesAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
UserDTO userDTO = new UserDTO();
BeanUtils.copyProperties(var, userDTO);
return userDTO;



  • 推荐：★★★☆☆
  • 性能：★★★★☆
  • 手段：Introspector机制获取到类的属性来进行赋值操作
  • 点评：同样是反射的属性拷贝，Spring 提供的 copyProperties 要比 Apache 好用的多，只要你不用错，基本不会有啥问题。
4.5    Bean Mapping
@Component
public class BeanMappingAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
UserDTO userDTO = new UserDTO();
BeanUtil.copyProperties(var, userDTO);
return userDTO;



  • 推荐：★★☆☆☆
  • 性能：★★★☆☆
  • 手段：属性拷贝
  • 点评：性能一般
4.6    Bean Mapping ASM
@Component
public class BeanMappingAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
UserDTO userDTO = new UserDTO();
BeanUtil.copyProperties(var, userDTO);
return userDTO;



  • 推荐：★★★☆☆
  • 性能：★★★★☆
  • 手段：基于ASM字节码框架实现
  • 点评：与普通的 Bean Mapping 相比，性能有所提升，可以使用。
4.7    BeanCopier
这种方案动态生成一个要代理类的子类,其实就是通过字节码方式转换成性能最好的get和set方式,重要的开销在创建BeanCopier，整体性能接近原生代码处理，比BeanUtils要好很多，尤其在数据量很大时，但是针对复杂场景支持能力不足。
@Component
public class BeanCopierAssembler implements IAssembler

@Override
public UserDTO sourceToTarget(UserVO var)
UserDTO userDTO = new UserDTO();
BeanCopier beanCopier = BeanCopier.create(var.getClass(), userDTO.getClass(), false);
beanCopier.copy(var, userDTO, null);
return userDTO;



  • 推荐：★★★☆☆
  • 性能：★★★★☆
  • 手段：基于CGlib字节码操作生成get、set方法
  • 点评：整体性能很不错，使用也不复杂，可以使用
4.8    Orika
@Component
public class OrikaAssembler implements IAssembler

/**
* 构造一个MapperFactory
*/
private static MapperFactory mapperFactory = new DefaultMapperFactory.Builder().build();

static
mapperFactory.classMap(UserDTO.class, UserVO.class)
.field("userId", "userId")// 字段不一致时可以指定
.byDefault()
.register();


@Override
public UserDTO sourceToTarget(UserVO var)
return mapperFactory.getMapperFacade().map(var, UserDTO.class);



  • 官网：??https://orika-mapper.github.io/orika-docs/??
  • 推荐：★★☆☆☆
  • 性能：★★★☆☆
  • 手段：基于字节码生成映射对象
  • 点评：测试性能不是太突出，如果使用的话需要把 MapperFactory 的构建优化成 Bean 对象
4.9  Dozer
@Component
public class DozerAssembler implements IAssembler

private static DozerBeanMapper mapper = new DozerBeanMapper();

@Override
public UserDTO sourceToTarget(UserVO var)
return mapper.map(var, UserDTO.class);



  • 官网：??http://dozer.sourceforge.net/documentation/gettingstarted.html??
  • 推荐：★☆☆☆☆
  • 性能：★★☆☆☆
  • 手段：属性映射框架，递归的方式复制对象
  • 点评：性能有点差，不建议使用
【Java对象转换与mapstruct实践】具体实现参考：?
4.10    ModelMapper
@Component
public class ModelMapperAssembler implements IAssembler

private static ModelMapper modelMapper = new ModelMapper();

static
modelMapper.addMappings(new PropertyMap()
@Override
protected void configure()
// 属性值不一样可以自己操作
map().setUserId(source.getUserId());

);


@Override
public UserDTO sourceToTarget(UserVO var)
return modelMapper.map(var, UserDTO.class);



  • 官网：??http://modelmapper.org??
  • 推荐：★★★☆☆
  • 性能：★★★☆☆
  • 手段：基于ASM字节码实现
  • 点评：转换对象数量较少时性能不错，如果同时大批量转换对象，性能有所下降
4.11  JMapper
JMapper jMapper = new JMapper< > (UserDTO.class, UserVO.class, new JMapperAPI()
.add(JMapperAPI.mappedClass(UserDTO.class)
.add(JMapperAPI.attribute("userId")
.value("userId"))
.add(JMapperAPI.attribute("userNickName")
.value("userNickName"))
.add(JMapperAPI.attribute("createTime")
.value("createTime"))
));

  • 官网：??https://github.com/jmapper-framework/jmapper-core/wiki??
  • 推荐：★★★★☆
  • 性能：★★★★★
  • 手段：Elegance, high performance and robustness all in one java bean mapper
  • 点评：速度真心可以，不过结合 SpringBoot 感觉有的一点点麻烦，可能姿势不对
4.12  MapStruct
maven依赖：

1.3.1.Final




org.mapstruct
mapstruct-processor
$org.mapstruct.version
provided






org.apache.maven.plugins
maven-compiler-plugin



org.projectlombok
lombok
$lombok.version


org.mapstruct
mapstruct-processor
$org.mapstruct.version






注意这里配置一下lombok, 否则启动会冲突。
代码实现：
@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE, unmappedSourcePolicy = ReportingPolicy.IGNORE)
public interface UserDTOMapping extends IMapping

/** 用于测试的单例 */
IMapping INSTANCE = Mappers.getMapper(UserDTOMapping.class);

@Mapping(target = "userId", source = "userId")
@Mapping(target = "createTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
@Override
UserDTO sourceToTarget(UserVO var1);

@Mapping(target = "userId", source = "userId")
@Mapping(target = "createTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
@Override
UserVO targetToSource(UserDTO var1);




注意：
1：可以在Mapping类上加@Mapper(componentModel = "spring"), 通过注入的方式引入Mapper接口
2：可以通过Mappers.getMapper(UserDTOMapping.class) 的方式获取Mapper接口


  • 官网：??https://github.com/mapstruct/mapstruct???、??ModelMapper - Getting Started??
  • 推荐：★★★★★
  • 性能：★★★★★
  • 手段：直接在编译期生成对应的get、set，像手写的代码一样
  • 点评：速度很快，不需要到运行期处理，结合到框架中使用方便
5 总结
  • 其实对象属性转换的操作无非是基于反射、AOP、CGlib、ASM、Javassist 在编译时和运行期进行处理，再有好的思路就是在编译前生成出对应的get、set，就像手写出来的一样。
  • 所以我更推荐我喜欢的 MapStruct，用起来还是比较舒服的，一种是来自于功能上的拓展性，易用性和兼容性。
参考：??12种 vo2dto 方法 (qq.com)??
??Java对象转换方案分析与mapstruct实践-阿里云开发者社区 (aliyun.com)???
?
??MapStruct 1.4.2.Final Reference Guide??
??mapstruct/mapstruct-examples: Examples for using MapStruct (github.com)??
??为什么阿里巴巴禁止使用Apache Beanutils进行属性的copy？ (qq.com)??
??干掉 BeanUtils！试试这款 Bean 自动映射工具，真心强大！ - SegmentFault 思否??
??Performance of Java Mapping Frameworks | Baeldung??


    推荐阅读


    上一篇：springboot 全局异常捕获

    下一篇：springboot 文件上传和下载