MapStruct:一款java对象转换神器

当然,除了这些简单类以外,还有一些包含业务逻辑的实体类,比如 BO(Business Object):业务对象,由Service层输出的封装业务逻辑的对象。

常见的Object Mapping方式

比较常见的对象转换方式主要有两种,我们可以在很多老代码当中看到它们的身影。

  • 调用getter/setter方法手动硬编码属性赋值

  • 调用BeanUtil.copyProperties进行反射属性赋值

getter/setter手工硬编码的方式相信很多 Java 开发同学都异常熟练,它的痛点也非常明显,就是当一个类有几十个属性的时候,代码编写效率非常低下,而且丑陋,最重要的是,当新扩展一个字段以后,往往容易忽略在 mapping convert 文件中添加相应的属性映射,给业务带来一定的潜在风险(error-prone)。当然硬编码也不是一无是处的,它的执行效率非常高,这个后文会分析。

而使用BeanUtil.copyProperties的方式进行转换的话就要好一些了,我们可以在业务逻辑当中一行代码就解决掉对象转换的问题,不会使得代码非常冗长,但它的坑也不少,由于使用反射的方式去进行转换,如果涉及到频繁对象转换操作就会有性能问题(后文会有分析),同时对开发者定位问题也不友好,出问题后我们很难定位到字段是在哪里进行的赋值操作。

Object Mapping技术分类

Object Mapping 技术从大的角度来说分为两类,一类是运行期转换,另一类则是编译期转换,它们的区别主要是:

  • 运行期反射调用 set/get 或者是直接对成员变量赋值。这种方式通过invoke执行赋值,实现时一般会采用beanutil, Javassist等开源库。运行期对象转换的代表主要是Dozer和ModelMaper。

  • 编译期动态生成 set/get 代码的class文件,在运行时直接调用该class的 set/get 方法。该方式实际上仍会存在 set/get 代码,只是不需要开发人员自己写了。这类的代表是:MapStruct,Selma,Orika。

说完它们的区别,那么它们的Object Mapping表现差异究竟如何?我们可以写代码验证,这里方便起见就直接引用 GitHub 上面java-object-mapper-benchmark的项目结果说明,要转换的对象是 Order 实体与 OrderDTO,它们的关联关系如下图所示。

机器配置如下:

  • OS: macOS High Sierra

  • CPU: 3.1 GHz Intel Core i7, 2 cores, L2 Cache (per Core): 256 KB, L3 Cache: 4 MB

  • RAM: 16 GB 1867 MHz DDR3

  • JVM: Oracle 1.8.0_74-b02 64 bits

运行结果如下:

感兴趣的同学可以去把代码下载下来亲自验证一下。从图中可以很明显感受到的是,反射 Object Mapping 确实比 get/set 的方式慢很多。另外,综合比较性能、问题排查、文档、成熟度、扩展性等因素,MapStruct 是一个不错的 Object Mapping 选择。

MapStruct如何使用

  1. 引入Maven依赖。

… <org.mapstruct.version>1.3.1.Final</org.mapstruct.version>… org.mapstruct mapstruct o r g . m a p s t r u c t . v e r s i o n < / v e r s i o n > < / d e p e n d e n c y > < / d e p e n d e n c i e s > . . . < b u i l d > < p l u g i n s > < p l u g i n > < g r o u p I d > o r g . a p a c h e . m a v e n . p l u g i n s < / g r o u p I d > < a r t i f a c t I d > m a v e n − c o m p i l e r − p l u g i n < / a r t i f a c t I d > < v e r s i o n > 3.5.1 < / v e r s i o n > < c o n f i g u r a t i o n > < s o u r c e > 1.6 < / s o u r c e > < ! − − o r h i g h e r , d e p e n d i n g o n y o u r p r o j e c t − − > < t a r g e t > 1.6 < / t a r g e t > < ! − − o r h i g h e r , d e p e n d i n g o n y o u r p r o j e c t − − > < a n n o t a t i o n P r o c e s s o r P a t h s > < p a t h > < g r o u p I d > o r g . m a p s t r u c t < / g r o u p I d > < a r t i f a c t I d > m a p s t r u c t − p r o c e s s o r < / a r t i f a c t I d > < v e r s i o n > {org.mapstruct.version}</version> </dependency></dependencies>...<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.5.1</version> <configuration> <source>1.6</source><!-- or higher, depending on your project --> <target>1.6</target><!-- or higher, depending on your project --> <annotationProcessorPaths> <path> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-processor</artifactId> <version> org.mapstruct.version</version></dependency></dependencies>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>mavencompilerplugin</artifactId><version>3.5.1</version><configuration><source>1.6</source><!orhigher,dependingonyourproject><target>1.6</target><!orhigher,dependingonyourproject><annotationProcessorPaths><path><groupId>org.mapstruct</groupId><artifactId>mapstructprocessor</artifactId><version>{org.mapstruct.version}

  1. 定义实体对象。

下面两个类非常相似,有一个号码属性名不一样,同时在 PeopleDTO 中有个 User 对象,而在 PeopleEntity 中则是两个单独属性。

PeopleEntity.java:

publicclass PeopleEntity { private Integer age; private String name; private String callNumber; private String address; private String emile; //constructor, getters, setters etc.}

PeopleDTO.java:

publicclass PeopleDTO { private String phoneNumber; private String address; private String emile; private User user; //constructor, getters, setters etc.}

User.java:

publicclass User { private Integer age; private String name; //constructor, getters, setters etc.}

  1. 定义Mapper接口 要生成一个PeopleDTO与PeopleEntity对象相互转换的映射器,我们需要定义一个mapper接口。当实体类有些属性不一样时,我们可以通过@Mapping注解来进行转换。
  • @Mapper注解标记这个接口作为一个映射接口,并且是编译时 MapStruct 处理器的入口。

  • @Mapping解决源对象和目标对象中属性名字不同的情况。

PeopleMapper.java:

@Mapperpublicinterface PeopleMapper { PeopleMapper INSTANCE = Mappers.getMapper(PeopleMapper.class); /** * PO转DTO * * @param entity PO * @return DTO / @Mapping(target = “phoneNumber”, source = “callNumber”) @Mapping(target = “user.name”, source = “name”) @Mapping(target = “user.age”, source = “age”) PeopleDTO entityToDTO(PeopleEntity entity); /* * DTO转PO * * @param peopleDTO DTO * @param entity PO */ @Mapping(target = “callNumber”, source = “phoneNumber”) @Mapping(target = “name”, source = “user.name”) @Mapping(target = “age”, source = “user.age”) void updateEntityFromDto(PeopleDTO peopleDTO, @MappingTarget PeopleEntity entity);}

  1. 使用Mapper。

使用Mapper有两种方式,第一种我们不需要做过多的配置,直接使用Mappers通过工厂完成Mapper实现类的获取。

//Mapper接口内部定义publicstatic GoodInfoMapper MAPPER = Mappers.getMapper(GoodInfoMapper.class);//外部调用GoodInfoMapper.MAPPER.from(goodBean,goodTypeBean);

第二种方式是使用Spring的配置方式,我们需要在@Mapper注解内添加componentModel属性值,配置后在外部可以采用@Autowired方式注入Mapper实现类完成映射方法调用。

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)

img

最后

小编精心为大家准备了一手资料

以上Java高级架构资料、源码、笔记、视频。Dubbo、Redis、设计模式、Netty、zookeeper、Spring cloud、分布式、高并发等架构技术

【附】架构书籍

  1. BAT面试的20道高频数据库问题解析
  2. Java面试宝典
  3. Netty实战
  4. 算法

BATJ面试要点及Java架构师进阶资料

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
面试宝典
3. Netty实战
4. 算法

[外链图片转存中…(img-EfPJ9yIv-1713472892495)]

BATJ面试要点及Java架构师进阶资料

[外链图片转存中…(img-hlsrZwnz-1713472892497)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

  • 13
    点赞
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值