【Java】实体类转换框架 MapStruct
简单尝试了下发现比Dozer还有BeanUtil还方便小巧
注解的作用是在生成字节码文件时实现具体GetterSetter方法，实际转换时就是赋值操作，嘎嘎快
参考文章：
https://juejin.cn/post/7140149801991012365
引入必须的依赖：
lombok一般项目都会添加，这里我就只放这两个
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.5.0.Final</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.5.0.Final</version>
</dependency>
一、入门案例：
两个需要相互转换的实体类，演示用：
DTO
package cn.cloud9.server.test.mapstruct; import lombok.*;
import lombok.experimental.Accessors; @Data
@Builder
@ToString
@Accessors(chain = true)
@AllArgsConstructor
@NoArgsConstructor
public class DemoDTO {
private Integer fieldA;
private Boolean fieldB;
private String fieldC;
}
Entity
package cn.cloud9.server.test.mapstruct; import lombok.*;
import lombok.experimental.Accessors; @Data
@Builder
@ToString
@Accessors(chain = true)
@AllArgsConstructor
@NoArgsConstructor
public class DemoEntity {
private Integer fieldD;
private Boolean fieldE;
private String fieldF;
}
转换器接口编写：
如果需要转换更多的实体类，都可以在接口声明方法，然后声明映射的字段
package cn.cloud9.server.test.mapstruct; import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers; /**
* 转换器接口
*/
@Mapper
public interface DemoConverter {
DemoConverter INSTANCE = Mappers.getMapper(DemoConverter.class); /* DTO -> ENTITY */
@Mappings(value = {
@Mapping(source = "fieldA", target = "fieldD"),
@Mapping(source = "fieldB", target = "fieldE"),
@Mapping(source = "fieldC", target = "fieldF"),
})
DemoEntity dto2entity(DemoDTO demoDTO); /* ENTITY -> DTO */
@Mappings(value = {
@Mapping(source = "fieldD", target = "fieldA"),
@Mapping(source = "fieldE", target = "fieldB"),
@Mapping(source = "fieldF", target = "fieldC"),
})
DemoDTO entity2dto(DemoEntity demoEntity);
}
测试方法：
@Test
public void converterTest() {
DemoDTO build = DemoDTO.builder()
.fieldA(1001)
.fieldB(Boolean.TRUE)
.fieldC("TEST")
.build(); DemoEntity demoEntity = DemoConverter.INSTANCE.dto2entity(build);
DemoDTO demoDTO = DemoConverter.INSTANCE.entity2dto(demoEntity);
log.info("demoEntity -> {}", demoEntity);
log.info("demoDTO -> {}", demoDTO);
}
执行结果：
22:52:20.079 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoEntity -> DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
22:52:20.083 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoDTO -> DemoDTO(fieldA=1001, fieldB=true, fieldC=TEST) Process finished with exit code 0
二、集合转换支持
也是根据参数类型推断，自动生成了迭代集合
/* List<ENTITY -> DTO> */
@Mappings(value = {
@Mapping(source = "fieldD", target = "fieldA"),
@Mapping(source = "fieldE", target = "fieldB"),
@Mapping(source = "fieldF", target = "fieldC"),
})
List<DemoDTO> entity2dto(List<DemoEntity> demoEntity); /* List<DTO -> ENTITY> */
@Mappings(value = {
@Mapping(source = "fieldA", target = "fieldD"),
@Mapping(source = "fieldB", target = "fieldE"),
@Mapping(source = "fieldC", target = "fieldF"),
})
List<DemoEntity> dto2entity(List<DemoDTO> demoDTO);
测试方法：
ArrayList<DemoDTO> objects = new ArrayList<>();
for (int i = 0; i < 10; i++) {
objects.add(DemoDTO.builder()
.fieldA(1001)
.fieldB(Boolean.TRUE)
.fieldC("TEST")
.build());
}
List<DemoEntity> demoEntityList = DemoConverter.INSTANCE.dto2entity(objects);
demoEntityList.forEach(d -> log.info("de {}", d));
执行结果：
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
23:16:13.845 [main] INFO cn.cloud9.spring.BeanFactoryTest - de DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST)
三、映射配置继承与反向继承
只需要提供一份映射注解信息即可，其他方法通过继承注解获取映射信息
同理，要反向转换时，提供了一个反向注解：
两个注解都需要你提供方法名来查找映射配置
package cn.cloud9.server.test.mapstruct; import org.mapstruct.*;
import org.mapstruct.factory.Mappers; import java.util.List; /**
* 转换器接口
*/
@Mapper
public interface DemoConverter {
DemoConverter INSTANCE = Mappers.getMapper(DemoConverter.class); /* DTO -> ENTITY */
@Mappings(value = {
@Mapping(source = "fieldA", target = "fieldD"),
@Mapping(source = "fieldB", target = "fieldE"),
@Mapping(source = "fieldC", target = "fieldF"),
})
DemoEntity dto2entity(DemoDTO demoDTO); /* ENTITY -> DTO */
// @Mappings(value = {
// @Mapping(source = "fieldD", target = "fieldA"),
// @Mapping(source = "fieldE", target = "fieldB"),
// @Mapping(source = "fieldF", target = "fieldC"),
// })
// DemoDTO entity2dto(DemoEntity demoEntity);
@InheritInverseConfiguration(name = "dto2entity")
DemoDTO entity2dto(DemoEntity demoEntity); /* List<ENTITY -> DTO> */
// @Mappings(value = {
// @Mapping(source = "fieldD", target = "fieldA"),
// @Mapping(source = "fieldE", target = "fieldB"),
// @Mapping(source = "fieldF", target = "fieldC"),
// })
@InheritConfiguration(name = "entity2dto")
List<DemoDTO> entity2dto(List<DemoEntity> demoEntity); /* List<DTO -> ENTITY> */
// @Mappings(value = {
// @Mapping(source = "fieldA", target = "fieldD"),
// @Mapping(source = "fieldB", target = "fieldE"),
// @Mapping(source = "fieldC", target = "fieldF"),
// })
@InheritInverseConfiguration(name = "entity2dto")
List<DemoEntity> dto2entity(List<DemoDTO> demoDTO);
}
四、是否阻止默认映射
默认同名同类型字段直接映射
这里对两个实体类新加了同一个字段：
private Long filedG;
测试时添加该属性：
@Test
public void converterTest() {
DemoDTO build = DemoDTO.builder()
.fieldA(1001)
.fieldB(Boolean.TRUE)
.fieldC("TEST")
.filedG(3003L)
.build();
DemoEntity demoEntity = DemoConverter.INSTANCE.dto2entity(build);
DemoDTO demoDTO = DemoConverter.INSTANCE.entity2dto(demoEntity);
log.info("demoEntity -> {}", demoEntity);
log.info("demoDTO -> {}", demoDTO);
}
执行结果可以发现，默认赋值上去了
23:34:51.780 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoEntity -> DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST, filedG=3003)
23:34:51.787 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoDTO -> DemoDTO(fieldA=1001, fieldB=true, fieldC=TEST, filedG=3003) Process finished with exit code 0
使用@BeanMapping注解可以阻止这种赋值行为：
/**
* 转换器接口
*/
@Mapper
public interface DemoConverter {
DemoConverter INSTANCE = Mappers.getMapper(DemoConverter.class); /* @BeanMapping(ignoreByDefault = true) 阻止MapStruct默认同名字段赋值行为 */
@BeanMapping(ignoreByDefault = true)
/* DTO -> ENTITY */
@Mappings(value = {
@Mapping(source = "fieldA", target = "fieldD"),
@Mapping(source = "fieldB", target = "fieldE"),
@Mapping(source = "fieldC", target = "fieldF"),
})
DemoEntity dto2entity(DemoDTO demoDTO); /* ENTITY -> DTO */
@InheritInverseConfiguration(name = "dto2entity")
DemoDTO entity2dto(DemoEntity demoEntity); /* List<ENTITY -> DTO> */
@InheritConfiguration(name = "entity2dto")
List<DemoDTO> entity2dto(List<DemoEntity> demoEntity); /* List<DTO -> ENTITY> */
@InheritInverseConfiguration(name = "entity2dto")
List<DemoEntity> dto2entity(List<DemoDTO> demoDTO);
}
再次执行发现不再能够进行赋值处理了：
23:38:03.011 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoEntity -> DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST, filedG=null)
23:38:03.015 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoDTO -> DemoDTO(fieldA=1001, fieldB=true, fieldC=TEST, filedG=null)
是否不继承@BeanMapping忽略默认映射的配置？
https://www.bilibili.com/video/BV1E5411n7HR?p=9
在视频中提到是不继承的，这里我加上了字段的赋值，并且调用反向转换的方法：
DemoDTO build = DemoDTO.builder()
.fieldA(1001)
.fieldB(Boolean.TRUE)
.fieldC("TEST")
.fieldG(3003L)
.build();
DemoEntity demoEntity = DemoConverter.INSTANCE.dto2entity(build);
demoEntity.setFieldG(3003L);
DemoDTO demoDTO = DemoConverter.INSTANCE.entity2dto(demoEntity);
log.info("demoEntity -> {}", demoEntity);
log.info("demoDTO -> {}", demoDTO);
可以从执行结果发现，实际上是没有赋值的，说明是继承了@BeanMapping的效果了
23:41:02.989 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoEntity -> DemoEntity(fieldD=1001, fieldE=true, fieldF=TEST, fieldG=3003)
23:41:02.994 [main] INFO cn.cloud9.spring.BeanFactoryTest - demoDTO -> DemoDTO(fieldA=1001, fieldB=true, fieldC=TEST, fieldG=null) Process finished with exit code 0
五、注册成SpringBean
在前面的用法中都是直接声明一个单例使用，这里可以交给Spring处理：
@Mapper(componentModel = "spring")
package cn.cloud9.server.test.mapstruct; import org.mapstruct.*;
import org.mapstruct.factory.Mappers; import java.util.List; /**
* 转换器接口
*/
@Mapper(componentModel = "spring")
public interface DemoConverter {
DemoConverter INSTANCE = Mappers.getMapper(DemoConverter.class); /* @BeanMapping(ignoreByDefault = true) 阻止MapStruct默认同名字段赋值行为 */
// @BeanMapping(ignoreByDefault = true)
/* DTO -> ENTITY */
@Mappings(value = {
@Mapping(source = "fieldA", target = "fieldD"),
@Mapping(source = "fieldB", target = "fieldE"),
@Mapping(source = "fieldC", target = "fieldF"),
})
DemoEntity dto2entity(DemoDTO demoDTO); /* ENTITY -> DTO */
@InheritInverseConfiguration(name = "dto2entity")
DemoDTO entity2dto(DemoEntity demoEntity); /* List<ENTITY -> DTO> */
@InheritConfiguration(name = "entity2dto")
List<DemoDTO> entity2dto(List<DemoEntity> demoEntity); /* List<DTO -> ENTITY> */
@InheritInverseConfiguration(name = "entity2dto")
List<DemoEntity> dto2entity(List<DemoDTO> demoDTO);
}
在需要调用的地方声明即可：
package cn.cloud9.server.test.controller; import cn.cloud9.server.test.mapstruct.DemoConverter;
import cn.cloud9.server.test.mapstruct.DemoDTO;
import cn.cloud9.server.test.mapstruct.DemoEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController; import javax.annotation.Resource; @RestController
@RequestMapping("/test/map-struct")
public class MapStructController { @Resource
private DemoConverter demoConverter; @GetMapping("/get")
public DemoEntity converterTest() {
DemoDTO build = DemoDTO.builder()
.fieldA(1001)
.fieldB(Boolean.TRUE)
.fieldC("TEST")
.fieldG(3003L)
.build();
return demoConverter.dto2entity(build);
}
}
测试结果：
【Java】实体类转换框架 MapStruct的更多相关文章
- Java实体映射工具MapStruct的使用
官网地址:http://mapstruct.org/ MapStruct 是一个代码生成器,简化了不同的 Java Bean 之间映射的处理,所谓的映射指的就是从一个实体变化成一个实体.例如我们在实际 ...
- 利用在线工具根据JSon数据自动生成对应的Java实体类
如果你希望根据JSon数据自动生成对应的Java实体类,并且希望能进行变量的重命名,那么“JSON To Java”一定适合你.(下面的地址需要FQ) https://jsontojava.appsp ...
- 我写了一个java实体类,implements了Serializable接口,然后我如何让serialversionUID自动生成
写了一个java实体类,implements了Serializable接口,让serialversionUID自动生成方法: 1.点击类旁边的警告符号: 2.选择Add generated seria ...
- 利用JAXB实现java实体类和xml互相转换
1.应用场景 在使用WebService实现数据上传下载,数据查询时,可以利用JAXB实现java实体类和xml互相转换 2.Demo 2.1 student.java 实体类,包含list(set同 ...
- MyEclipse 利用反向功能生成Java 实体类
1.Window -> Open Perspective -> MyEclipse Database Explorer 到DB Broswer界面 2.右键 -> New,新建一个数 ...
- 在线数据库表(sql语句)生成java实体类工具
相信每个做java开发的读者,都接触过SQL建表语句,尤其是在项目开发初期,因为数据库是项目的基石. 在现代项目开发中,出现了许多ORM框架,通过简单的实体映射,即可实现与数据库的交互,然而我们最初设 ...
- Mysql逆向工程效率神器之使用IDE自动生成Java实体类
Mysql逆向工程效率神器之使用IDE自动生成Java实体类 简介:实战使用IDE根据Mysql自动生成java pojo实体类 1.IDEA连接数据库 菜单View→Tool Windows→Dat ...
- JAVA实体类不要使用基本类型，基本类型包含byte、int、short、long、float、double、char、boolean
由于JAVA的基本类型会有默认值,例如当某个类中存在private int age;字段时,创建这个类时,age会有默认值0.当使用age属性时,它总会有值.因此在某些情况下,便无法实现age为nu ...
- xml文档的解析并通过工具类实现java实体类的映射：XML工具-XmlUtil
若有疑问,可以联系我本人微信:Y1141100952 声明:本文章为原稿,转载必须说明 本文章地址,否则一旦发现,必追究法律责任 1:本文章显示通过 XML工具-XmlUtil工具实现解析soap报文 ...
- 小D课堂-SpringBoot 2.x微信支付在线教育网站项目实战_2-6.Mysql逆向工程效率神器之使用IDE自动生成Java实体类
笔记 6.Mysql逆向工程效率神器之使用IDE自动生成Java实体类 简介:实战使用IDE根据Mysql自动生成java pojo实体类 1.IDEA连接数 ...
随机推荐
- kettle从入门到精通 第十六课 kettle 映射 (子转换)02
1.上节讲的子映射里面只有一个转换(类似一个java类里面只有一个公共方法),本次讲解的有两个,实际上可以有任意多个(一个java类里面有多个公共方法).两个转换分别计算x+y和x*y. 2.命名参数 ...
- SRE Google 运维解密读书笔记一：SRE 方法论概述
SRE Google 运维解密,是 SRE 领域的启蒙之作,讲述了 Google 的 SRE 实践,SRE 就是从 Google 流传出来的.本文是读书笔记,第一篇,概述 SRE 方法论.帮大家把书读 ...
- 在MySQL中INNER JOIN、LEFT JOIN、RIGHT JOIN 和 FULL JOIN 有什么区别？
我们有两张表: TableA:id firstName lastName.......................................1 aru ...
- 「C++」简单模拟
这是一个公式: \[F_n=\dfrac{\left(\frac{1+\sqrt{5}}{2}\right)^n-\left(\frac{1-\sqrt{5}}{2}\right)^n}{\sqrt{ ...
- Vue微前端架构与Qiankun实践理论指南
title: Vue微前端架构与Qiankun实践理论指南 date: 2024/6/15 updated: 2024/6/15 author: cmdragon excerpt: 这篇文章介绍了微前 ...
- linux日志查询less及堡垒机查询日志方法
方法1tail -f orderFile.log | grep "关键字" postman接口请求的时候,关注控制台对关键字过滤的打印输出. 方法2less 文件名称/ 关键字n ...
- CNN --入门MNIST识别
Smiling & Weeping ---- 下次你撑伞低头看水洼, 就会想起我说雨是神的烟花. 简介:主要是看刘二大人的视频讲解:https://www.bilibili.com/video ...
- 3年Java阿里跳字节的面试心得总结
中厂->阿里->字节,成都->杭州->成都 系列文章目录和关于我 0.前言 笔者在不足两年经验的时候从成都一家金融科技中厂跳槽到杭州阿里淘天集团,又于今年5月份从杭州淘天跳槽到 ...
- kylin-3.1.1-bin-hadoop3搭建，构建cube报的错误，Cannot modify dfs.replication at runtime. It is not in list of params that are allowed to be modified at runtime
主要是每次构建cube时会去读取kylin安装目录下的conf/kylin_hive_conf.xml文件, 副本是无法在hive查询时修改的,注释掉这两项 这个其实还有一些参数的控制: 添加这俩个参 ...
- Masonry在视图相对关系处理中的各种“offset”
如果我们需要设置一个view在另一个view的右边缘距离一定距离的地方,利用Masonry这么写: [a mas_makeConstraints:^(MASConstraintMaker *make) ...