MapStruct使用

MapStruct 是一个代码生成器，它基于约定优于配置方法极大地简化了 Java bean 类型之间映射的实现。自动生成的映射转换代码只使用简单的方法调用，因此速度快、类型安全而且易于理解阅读，源码仓库 Github 地址 MapStruct。总的来说，有如下三个特点：

1. 基于注解
2. 在编译期自动生成映射转换代码
3. 类型安全、高性能、无依赖性

一, 引入依赖

...
<properties>
    <org.mapstruct.version>1.4.2.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.8.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>
            <!-- due to problem in maven-compiler-plugin, for verbose mode add showWarnings -->
                <showWarnings>true</showWarnings>
                <compilerArgs>
                    <arg>
                        -Amapstruct.suppressGeneratorTimestamp=true
                    </arg>
                    <arg>
                        -Amapstruct.suppressGeneratorVersionInfoComment=true
                    </arg>
                    <arg>
                        -Amapstruct.verbose=true
                    </arg>
                </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>
...

二, 定义Mapper接口

@Mapper
public interface CarMapper {
    @Mapping(source = "make", target = "manufacturer")
    @Mapping(source = "numberOfSeats", target = "seatCount")
    CarDto carToCarDto(Car car);
    @Mapping(source = "name", target = "fullName")
    PersonDto personToPersonDto(Person person);
}
或
@Mapper
public interface StorageMapper {
    StorageMapper INSTANCE = Mappers.getMapper( StorageMapper.class );
    @ToEntity
    @Mapping( target = "weightLimit", source = "maxWeight")
    ShelveEntity map(ShelveDto source);
    @ToEntity
    @Mapping( target = "label", source = "designation")
    BoxEntity map(BoxDto source);
}
或 多个合并成一个对象
@Mapper
public interface AddressMapper {
    @Mapping(source = "person.description", target = "description")
    @Mapping(source = "address.houseNo", target = "houseNumber")
    DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Address address);
}

三, 使用

Target target = DoctorMapper.INSTANCE.toDTO(source);

四，常见问题

1，NullPointerException at org.mapstruct.ap.internal.processor.DefaultVersionInformation.createManifest

解决： 需要在idea的settings-》编译 去设置，添加参数：-Djps.track.ap.dependencies=false

参照：NullPointerException at org.mapstruct.ap.internal.processor.DefaultVersionInformation.createManifest-CSDN博客

官网地址:

MapStruct 1.5.5.Final Reference Guide