MapStruct是一个Java注解处理器,它可以简化Java bean之间的转换。它使用基于生成器的方法创建类型安全的映射代码,这些代码在编译时生成,并且比反射更快、更可靠。使用MapStruct可以避免手动编写大量重复的转换代码,从而提高生产力和代码质量。
MapStruct通过使用注解,在源代码中指定映射规则,MapStruct可以自动生成转换器代码。MapStruct支持各种转换场景,包括简单类型、集合、继承、日期、枚举、嵌套映射等等。同时,它还能够与Spring和CDI等IoC容器无缝集成,方便地将MapStruct转换器注入到应用程序中。
MapStruct的官网:MapStruct – Java bean mappings, the easy way!
在开发中比较常用的用来实现JavaBean之间的转换应该就是org.springframework.beans.BeanUtils
,它俩有以下区别:
MapStruct
生成的映射代码是在编译时生成的,而BeanUtils
则是在运行时使用反射机制实现转换。在一些高并发的场景,性能是开发者十分重视的,BeanUtils
虽然也可以方便地完成JavaBean之间的转换,但是由于其底层是基于反射实现的,在高并发场景下难免会出现大规模的数据处理和转换操作,这时候还是用BeanUtils
会导致接口响应速度有所下降。
这时候,最最最高效的方法就是手动get/set,但是这种需要反复写大量重复的转换代码,并且这些代码难以被反复利用,于是就考虑使用MapStruct。
MapStruct是一种基于注解的代码生成器,它通过生成优化的映射代码来实现高性能的Bean映射。与BeanUtils相比,MapStruct在生成的映射代码中使用了更少的反射调用,并且在类型转换时可以直接使用Javac编译器已经提供的类型转换逻辑,从而避免了额外的性能开销。此外,由于MapStruct是基于注解的,它还可以提供更好的类型检查和编译时错误提示。
以下是当前比较常用的JavaBean之间转化的工具的性能对比:
可见,随着转化次数的增加只有
MapStruct
的性能最接近get/set的效率。
因此,在高并发场景下,使用MapStruct可以更有效地利用系统资源,提高系统的吞吐量和响应速度。
接下来用一个案例来说说如何使用MapStruct
,更多详细的用法可以查看官方文档。
温馨提示:在生成get/set方法的时候,最好不要用lombok,不然有可能会出现一些奇奇怪怪的问题
先引入依赖:
<dependency>
<groupId>org.mapstructgroupId>
<artifactId>mapstructartifactId>
dependency>
<dependency>
<groupId>org.mapstructgroupId>
<artifactId>mapstruct-processorartifactId>
dependency>
Student类:
public class Student {
private String sId;
private String sName;
private String sSex;
public String getsId() {
return sId;
}
public void setsId(String sId) {
this.sId = sId;
}
public String getsName() {
return sName;
}
public void setsName(String sName) {
this.sName = sName;
}
public String getsSex() {
return sSex;
}
public void setsSex(String sSex) {
this.sSex = sSex;
}
}
StudentVo类:
public class StudentVo {
private String id;
private String name;
private String sSex;
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getsSex() {
return sSex;
}
public void setsSex(String sSex) {
this.sSex = sSex;
}
}
现在模拟两个业务:
首先,需要定义一个对象接口映射的接口
/**
* @description:对象接口映射
* @author:lrk
* @date: 2023/6/2
*/
@MapperConfig
public interface IMapping<SOURCE, TARGET> {
/**
* 映射同名属性
* @param var1 源
* @return 结果
*/
@Mapping(target = "createTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
TARGET sourceToTarget(SOURCE var1);
/**
* 映射同名属性,反向
* @param var1 源
* @return 结果
*/
@InheritInverseConfiguration(name = "sourceToTarget")
SOURCE targetToSource(TARGET var1);
/**
* 映射同名属性,集合形式
* @param var1 源
* @return 结果
*/
@InheritConfiguration(name = "sourceToTarget")
List<TARGET> sourceToTarget(List<SOURCE> var1);
/**
* 反向,映射同名属性,集合形式
* @param var1 源
* @return 结果
*/
@InheritConfiguration(name = "targetToSource")
List<SOURCE> targetToSource(List<TARGET> var1);
/**
* 映射同名属性,集合流形式
* @param stream 源
* @return 结果
*/
List<TARGET> sourceToTarget(Stream<SOURCE> stream);
/**
* 反向,映射同名属性,集合流形式
* @param stream 源
* @return 结果
*/
List<SOURCE> targetToSource(Stream<TARGET> stream);
}
这个接口上需要加org.mapstruct.MapperConfig
的注解,表示这是一个构造器。
接下来,就需要构造一个具体类的转换配置了,需要继承IMapping
接口
这里就模拟转换两个类的相互转化,其他比如List的转换可以自主实现
/**
* @description:学生类转换配置
* @author:lrk
* @date: 2023/6/2
*/
@Mapper(
// 指定依赖注入框架
componentModel = "spring",
unmappedTargetPolicy = ReportingPolicy.IGNORE,
unmappedSourcePolicy = ReportingPolicy.IGNORE
)
public interface StudentMapping extends IMapping<Student, StudentVo>{
/**
* Student 转 StudentVo
* @param var1 源
* @return
*/
@Mapping(target = "id", source = "sId")
@Mapping(target = "name", source = "sName")
@Override
StudentVo sourceToTarget(Student var1);
/**
* StudentVo 转 Student
* @param var1 源
* @return
*/
@Mapping(target = "sId", source = "id")
@Mapping(target = "sName", source = "name")
@Override
Student targetToSource(StudentVo var1);
}
,指定了Student
是源,StudentVo
是目标。org.mapstruct.Mapper
注解,注解里面有三个参数
componentModel
:指定依赖注入框架,目前只支持spring
与CDI
unmappedTargetPolicy
:在映射方法的目标对象的属性未填充源值时应用的默认报告策略。
ERROR
:任何未映射的目标属性都将导致映射代码生成失败WARN
:任何未映射的目标属性都将在构建时导致警告IGNORE
:忽略未映射的目标属性unmappedSourcePolicy
:同上sSex
一样外,其余的成员变量属性均不一样,这时候可以使用org.mapstruct.Mapping
注解在接口方法上
Mapping
:当属性在目标实体中具有不同的名称时,可以通过注释指定其名称编写测试代码
@Resource
private IMapping<Student, StudentVo> studentMapping;
@Test
public void test_mapstruct() {
Student student = new Student();
student.setsId("10086");
student.setsName("张三");
student.setsSex("男");
StudentVo studentVo = studentMapping.sourceToTarget(student);
log.info("Student:{} 转 StudentVo:{}", JSONUtil.toJsonStr(student), JSONUtil.toJsonStr(studentVo));
Student student1 = studentMapping.targetToSource(studentVo);
log.info("StudentVo:{} 转 Student:{}", JSONUtil.toJsonStr(studentVo), JSONUtil.toJsonStr(student1));
}
细心的你估计已经发现了,为什么这里可以用
@Resource
将IMapping
注入,代码中并没有看见将其放进Spring
容器呀?别急,前面说到MapStruct的转换代码是在编译时生成的,查看编译生成的代码可以发现其中已经加入了
@Component
注解并实现了StudentMapping
@Component public class StudentMappingImpl implements StudentMapping { public StudentMappingImpl() { } public List<StudentVo> sourceToTarget(List<Student> var1) { if (var1 == null) { return null; } else { List<StudentVo> list = new ArrayList(var1.size()); Iterator var3 = var1.iterator(); while(var3.hasNext()) { Student student = (Student)var3.next(); list.add(this.sourceToTarget(student)); } return list; } } public List<Student> targetToSource(List<StudentVo> var1) { if (var1 == null) { return null; } else { List<Student> list = new ArrayList(var1.size()); Iterator var3 = var1.iterator(); while(var3.hasNext()) { StudentVo studentVo = (StudentVo)var3.next(); list.add(this.targetToSource(studentVo)); } return list; } } public List<StudentVo> sourceToTarget(Stream<Student> stream) { return stream == null ? null : (List)stream.map((student) -> { return this.sourceToTarget(student); }).collect(Collectors.toCollection(ArrayList::new)); } public List<Student> targetToSource(Stream<StudentVo> stream) { return stream == null ? null : (List)stream.map((studentVo) -> { return this.targetToSource(studentVo); }).collect(Collectors.toCollection(ArrayList::new)); } public StudentVo sourceToTarget(Student var1) { if (var1 == null) { return null; } else { StudentVo studentVo = new StudentVo(); studentVo.setId(var1.getsId()); studentVo.setName(var1.getsName()); studentVo.setsSex(var1.getsSex()); return studentVo; } } public Student targetToSource(StudentVo var1) { if (var1 == null) { return null; } else { Student student = new Student(); student.setsId(var1.getId()); student.setsName(var1.getName()); student.setsSex(var1.getsSex()); return student; } } }
这是因为前面在
StudentMapping
指定了依赖注入框架为Spring
的原因,所以生成的代码自动将其放进容器,方便我们开发者使用。