MapStruct 的安装及简单使用
MapStruct是一个Java注释处理器,用于为Java Bean类生成类型安全和高性能的映射器。它使您不必手工编写映射代码,这是一个繁琐且容易出错的任务。该生成器具有合理的默认值和许多内置的类型转换,但是在配置或实现特殊行为时,它会自动退出。
与在运行时工作的映射框架相比,MapStruct具有以下优点:
- 通过使用普通方法调用而不是反射来快速执行
- 编译时类型安全。只能映射彼此映射的对象和属性,因此不会将订单实体意外映射到客户DTO等。
- 独立的代码-没有运行时依赖
- 如果发生以下情况,则在构建时清除错误报告:
- 映射不完整(并非所有目标属性都被映射)
- 映射不正确(找不到正确的映射方法或类型转换)
- 易于调试的映射代码(或手动编辑,例如在生成器中有错误的情况下)
一、配置依赖(项目中使用了swagger的情况)
1. 导入mapstruct包
<org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
<!--Bean映射工具mapstruct-->
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
2. 引入swagger,再引入mapstruct,需要在swagger依赖下添加如下文所示(先把swagger下的MapStruct包排除掉)
<!--Swagger-UI API文档生产工具-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
<exclusions>
<exclusion>
<artifactId>mapstruct</artifactId>
<groupId>org.mapstruct</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
<exclusions>
<exclusion>
<artifactId>mapstruct</artifactId>
<groupId>org.mapstruct</groupId>
</exclusion>
</exclusions>
</dependency>
3.mapstruct和lombok同时引入,可能会出现生成不了get、set方法(compile生成接口的实现类),解决方法的配置如下![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/5b16d32df11b8fc2a1e4c0b0b43a9368.png)
二、简单使用(结合spring一起使用)
1.使用所需的映射方法定义一个Java接口,并用注解对其进行org.mapstruct.Mapper标注
2.我们对所在的项目进行编译,会发现目标文件同目录下回生成一个对应的实现类
3.在所需要的地方注入对应接口类,就可以调用方法使用
高级用法请参考:https://mapstruct.org/documentation/stable/reference/html/#defining-mapper