本文使用 Zhihu On VSCode 创作并发布
在日常开发中,我们会定义多种不通的Javabean,比如DTO(Data Transfer Object:数据传输对象),DO(Data Object:数据库映射对象,与数据库一一映射),VO(View Object:显示层对象,通常是 Web 向模板渲染引擎层传输的对象)等等这些对象。在这些对象与对象之间转换通常是调对象的set和get方法进行复制,这种转换通常也是很无聊的操作,因此就需要有一个专门的工具来解决Javabean之间的转换问题,让我们从这种无聊的转换操作中解放出来。
MapStruct就是这样一个属性映射工具,用于解决上述对象之间转换问题。MapStruct官网。官网给出的MapStruct定义:MapStruct是一个Java注释处理器,用于生成类型安全的bean映射类。
我们要做的就是定义一个映射器接口,声明任何必需的映射方法。在编译的过程中,MapStruct会生成此接口的实现。该实现使用纯java方法调用的源对象和目标对象之间的映射。对比手写这些映射方法,MapStruct通过自动生成代码完成繁琐和手写容易出错的代码逻辑从而节省编码时间。遵循配置方法上的约定,MapStruct使用合理的默认值,但在配置或实现特殊行为时不加理会。
与动态映射框架相比,MapStruct具有以下优点:
- 速度快:使用普通的方法代替反射
- 编译时类型安全性 : 只能映射彼此的对象和属性,不会将商品实体意外映射到用户DTO等
- 在build时期有明确的错误报告,主要有下面俩种
- 映射不完整,目标对象中有些属性没有被映射
- 映射不正确,找不到一个合适的映射方法或者类型转换方法
简单使用
maven配置
通常在项目中,mapStruct和lombox会同时使用,具体的maven配置如下,如果只是用Mapstruct,只需将和Lombox有关的内容删除掉即可。
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<org.mapstruct.version>1.4.0.Beta3</org.mapstruct.version>
<org.projectlombok.version>1.18.12</org.projectlombok.version>
</properties>
<dependencies>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${org.projectlombok.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
<version>4.12</version>
</dependency>
</dependencies>
<!-- 配置lombok 和mapStruct注解处理器 -->
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>m