一、MapStruct是什么?
在Java代码开发中,我们经常会需要进行对象的属性拷贝,常常会用到Spring的BeanUtils,但是也会有遇到相关的性能问题,这里介绍一款高性能的属性拷贝工具------MapStruct。
先放上官网链接,我们先看下官方对MapStruct的介绍和认识。
MapStruct is a code generator that greatly simplifies the implementation of mappings between Java bean types based on a convention over configuration approach. The generated mapping code uses plain method invocations and thus is fast, type-safe and easy to understand.
MapStruct 是一个代码生成器,它基于约定而不是配置方法,极大地简化了 Java Bean 类型之间映射的实现。生成的映射代码使用普通方法调用,因此快速、类型安全且易于理解。
二、为什么要用MapStruct?
前面对MapStruct有了一个简单的认知后,我们再看看官网为什么推荐用到MapStruct工具。
简单来说,就是在多层应用程序通常需要在不同的对象模型(例如实体和 DTO)之间进行映射。编写此类映射代码是一项繁琐且容易出错的任务。MapStruct 旨在通过尽可能地自动化来简化这项工作。
与其他映射框架相比,MapStruct 在编译时生成 Bean 映射,这确保了高性能,允许快速的开发人员反馈和彻底的错误检查。
三、怎么使用MapStruct?
看到这里,此时的你估计有些跃跃欲试了,那么我们怎么去使用MapStruct呢?再次官网也给我们讲述了具体的使用方法。
MapStruct 是一个插入 Java 编译器的注释处理器,可用于命令行构建(Maven、Gradle 等)以及您喜欢的 IDE 中。
MapStruct 使用合理的默认值,但在配置或实现特殊行为时会不顾一切。
四、MapStruct集成步骤
- 1.SpringBoot项目引入MapStruct依赖,这里用的版本是1.3.0.Final
xml
<!-- mapStruct 对象转换 -->
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-jdk8</artifactId>
<version>1.3.0.Final</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.3.0.Final</version>
</dependency>
- 2.准备一个Car类和一个CarDto类
java
public class Car {
private String make;
private int numberOfSeats;
private CarType type;
//constructor, getters, setters etc.
}
java
1. public class CarDto {
1.
1. private String make;
1. private int seatCount;
1. private String type;
1.
1. //constructor, getters, setters etc.
1. }
- 3.创建一个CarMapper接口
java
@Mapper
public interface CarMapper {
CarMapper INSTANCE = Mappers.getMapper( CarMapper.class );
@Mapping(source = "numberOfSeats", target = "seatCount")
CarDto carToCarDto(Car car);
}
- 4.创建一个MapStruct的测试类,校验映射的结果
Java
@Test
public void shouldMapCarToDto() {
//given
Car car = new Car( "Morris", 5, CarType.SEDAN );
//when
CarDto carDto = CarMapper.INSTANCE.carToCarDto( car );
//then
assertThat( carDto ).isNotNull();
assertThat( carDto.getMake() ).isEqualTo( "Morris" );
assertThat( carDto.getSeatCount() ).isEqualTo( 5 );
assertThat( carDto.getType() ).isEqualTo( "SEDAN" );
}