MapStruct Java Bean 快速拷贝，属于编译型工具，非反射方式

 

MapStruct是一个用于生成类型安全，高性能和无依赖的bean映射代码的注释处理器，属于编译型工具

简介

MapStruct是一个Java 注释处理器，用于生成类型安全的bean映射类。

需要做的就是定义一个mapper接口，该接口声明任何所需的映射方法。在编译期间，MapStruct将生成此接口的实现。此实现使用普通的Java方法调用来在源对象和目标对象之间进行映射，即没有反射或类似。

与手工编写映射代码相比，MapStruct通过生成繁琐且易于编写的代码来节省时间。遵循约定优于配置方法，MapStruct使用合理的默认值，但在配置或实现特殊行为时会采取措施。

与动态映射框架相比，MapStruct具有以下优势：

• 通过使用普通方法调用而不是反射来快速执行
• 编译时类型安全：只能映射相互映射的对象和属性，不会将订单实体意外映射到客户DTO等。
• 在构建时清除错误报告，如果 映射不完整（并非所有目标属性都已映射） 映射不正确（找不到合适的映射方法或类型转换）

MapStruct 支持JVM相关的编程语言如Scala ，Kotlin ，Lvy,Groovy Grape等

依赖

包含Mapping注释

Maven

<dependency>
  <groupId>org.mapstruct</groupId>
  <artifactId>mapstruct</artifactId>
  <version>1.3.1.Final</version>
</dependency>

Gradle

implementation 'org.mapstruct:mapstruct:1.3.1.Final'

processor 依赖

<dependency>
  <groupId>org.mapstruct</groupId>
  <artifactId>mapstruct-processor</artifactId>
  <version>1.3.1.Final</version>
</dependency>

下载情况

IntelliJ IDEA 插件

在plugins中搜索‘mapstruct’

processor 注解处理器中的选项

...
<properties>
    <org.mapstruct.version>1.3.1.Final</org.mapstruct.version>
</properties>
...
<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
</dependencies>
...
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.5.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                </annotationProcessorPaths>
              <compilerArgs>
            <compilerArg>
                -Amapstruct.suppressGeneratorTimestamp=true
            </compilerArg>
            <compilerArg>
                -Amapstruct.suppressGeneratorVersionInfoComment=true
            </compilerArg>
        </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>

检索映射器

实战

public class Car {
 
    private String make;
    private int numberOfSeats;
    private CarType type;
 
    //constructor, getters, setters etc.
}

public class CarDto {
 
    private String make;
    private int seatCount;
    private String type;
 
    //constructor, getters, setters etc.
}

配置Mapping

@Mapper 
public interface CarMapper {
 
    CarMapper INSTANCE = Mappers.getMapper( CarMapper.class ); 3
 
    @Mapping(source = "numberOfSeats", target = "seatCount")
    CarDto carToCarDto(Car car); 2
}

@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" );


}

总结

类似转换的工具还有一些，大家可以比对下。根据自身的需求选择合适的实现方式。

头条号

微信号