阿拉丁和灯

Thoughts, stories and ideas.



业务代码的救星——Java对象转换框架MapStruct


介绍

在业务项目的开发中,我们经常需要将Java对象进行转换,比如从外部HSF服务得到的对象转换为本域的业务对象domain object,将Domain Object转为数据持久层的data Object,将domain object 转给dto以便返回给外部调用方等。在转换时大部分属性都是相同的,只有少部分的不同,如果手工编写转换代码,会很繁琐。这时我们可以通过一些对象转换框架来更方便的做这件事情。

这样的对象转换框架有不少,比较有名的有ModelMapper和MapStruct。它们所使用的实现技术不同,ModelMapper是基于反射的,通过反射来查找实体对象的字段,并读取或写入值,这样的方式实现原理简单,但性能很差。与ModelMapper框架不同的是,MapStruct是基于编译阶段代码生成的,生成的转换代码在运行的时候跟一般的代码一样,没有额外的性能损失。本文重点介绍MapStruct。

原理

image.png

使用方法

1. Mapper声明

image.png

MapStruct提供IDE插件,能够在编写映射的时候提供辅助,比如自动代码提示,重构辅助等。

2. 调用Mapper

image.png

3. 整合进Maven

添加dependency
image.png

为Maven compile plugin设置annotation processor
image.png

4. 整合进IDE

Enable annotation processor
image.png

安装插件
使用MapStruct,有一个缺点就是,当属性改名的时候,因为在Mapper上注解中配置的名字,是在字符串里面,是不会自动同步的。但是MapStruct提供了插件来做到这一点,同时还提供代码自动提示,跳转到实现等功能。关于插件的更多信息,见 MapStruct support for IntelliJ IDEA
image.png

5. Trouble Shooting

找不到注释处理程序:在pom.xml中增加mapstruct-processor的依赖
没有找到实现类:在pom.xml中加入对mapstruct-processor的依赖
在IDEA里面enable Annotation Processor

参考资料

MapStruct实体间转换快速入门
https://blog.csdn.net/lx_yoyo/article/details/75061614

JDK IO 2017 - Thomas Much - Easy Bean Mappings with MapStruct 1.2
https://www.youtube.com/watch?v=kKK9SczGa3I

MapStruct 1.2.0.Final Reference Guide
http://mapstruct.org/documentation/stable/reference/html

JAVA Annotation Processing技术——Lombok & MapStruct 介绍与使用
https://www.atatech.org/articles/45619

是时候去掉set/get了---浅谈data mapping技术
https://www.atatech.org/articles/45456



View or Post Comments