MapStruct使用

解释和用途

MapStruct是一种注释处理器，用于生成类型安全，高性能和无依赖的Bean映射代码
需要做的是定义一个映射接口，将各个字段的属性匹配上，在编译期间会自动实现接口生成对象映射方法
优点：
1.通过简单的（get,set）进行实现简单映射，而不是反射
2.编译时检验映射对应是否正确，映射不完整和映射不正确均会抛出异常
3.可以通过freemarker定制化开发

使用实例

配置

Maven基本配置：

...
<properties>
    <org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
    <org.projectlombok.version>1.18.12</org.projectlombok.version>
</properties>
...
<dependencies>
	<dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${org.projectlombok.version}</version>
        <scope>provided</scope>
     </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>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>${org.projectlombok.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>
...

基本使用：

要创建映射器，只需使用所需的映射方法定义一个Java接口，并用注释对其进行org.mapstruct.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);
}

在生成的方法实现中，源类型（例如Car）中的所有可读属性都将被复制到目标类型（例如CarDto）中的相应属性中：

当一个属性与其目标实体对应的名称相同时，它将被隐式映射。

当属性在目标实体中具有不同的名称时，可以通过@Mapping注释指定其名称。

// GENERATED CODE
public class CarMapperImpl implements CarMapper {

    @Override
    public CarDto carToCarDto(Car car) {
        if ( car == null ) {
            return null;
        }

        CarDto carDto = new CarDto();

        if ( car.getFeatures() != null ) {
            carDto.setFeatures( new ArrayList<String>( car.getFeatures() ) );
        }
        carDto.setManufacturer( car.getMake() );
        carDto.setSeatCount( car.getNumberOfSeats() );
        carDto.setDriver( personToPersonDto( car.getDriver() ) );
        carDto.setPrice( String.valueOf( car.getPrice() ) );
        if ( car.getCategory() != null ) {
            carDto.setCategory( car.getCategory().toString() );
        }
        carDto.setEngine( engineToEngineDto( car.getEngine() ) );

        return carDto;
    }

    @Override
    public PersonDto personToPersonDto(Person person) {
        //...
    }

    private EngineDto engineToEngineDto(Engine engine) {
        if ( engine == null ) {
            return null;
        }

        EngineDto engineDto = new EngineDto();

        engineDto.setHorsePower(engine.getHorsePower());
        engineDto.setFuel(engine.getFuel());

        return engineDto;
    }
}

生成的代码就跟平时我们编写的代码一样

注意：@Mapping注解可以将名字不一致的字段进行映射，不加的话默认映射字段名字相同的字段，忽略名字不一致的字段
如果想忽略某个字段不进行映射也可以

@Mapping(target = "id", ignore = true) // 忽略id，不进行映射

指定字段

在@Mapper接口类里面的转换方法上添加@Mapping注解
target() 必须添加，source()可以不添加，则直接使用默认值

@Mapping(target = "describe", source = "describe", defaultValue = "默认值")
PersonDto personToPersonDto(Person person);

使用表达式

表达式要用java表达式的形式
注意： 这个属性不能与source()、defaultValue()、defaultExpression()、qualifiedBy()、qualifiedByName()或constant()一起使用。

@Mapping(target = "describe", source = "describe", defaultValue = "默认值")
@Mapping(target = "createTime",expression = "java(new java.util.Date())")
PersonDto personToPersonDto(Person person);

时间日期处理dateFormat()

如果字符串映射到格式化日期，则该格式字符串可由SimpleDateFormat处理

@Mapping(target = "createTime",source = "createTime",dateFormat("yyyy-MM-dd"))
PersonDto personToPersonDto(Person person);

多对象映射

多个对象可以映射给一个单独的对象，如果出现多个对象的字段名字相同会编译异常，@Mapping（source = “指定某个对象.参数”, target = “”）

    @Mappings({
            @Mapping(source = "fundAccount.personUuid", target = "personUuid"),
            @Mapping(source = "gafferCommonInfo.floorNum", target = "regionName"),
    })
    AccountListVO convertToAccountListVO(GafferCommonInfo gafferCommonInfo, FundAccount fundAccount)；

也可以指定引用类型或者将引用类型名称与映射字段名称相同

    @Mappings({
            @Mapping(source = "gafferFileDTO.provinceName",target = "provinceCode"),
            @Mapping(source = "gafferFileDTO.cityName",target = "cityCode"),
            @Mapping(source = "gafferFileDTO.areaName",target = "areaCode"),

    })
    GafferBase convertToGafferBase(GafferFileDTO gafferFileDTO,String tenantUuid,String residentialAddress);

嵌套映射

对象里的对象可以映射给另一个对象

@Data
public class Test {
	...
	private TestChild testChild;
	...
}
@Data
public class TestDTO {
	...
    private Test test1;
    private TestChild test2;
    ...
}
// mapper
@Mapper(uses =DateFormtUtil.class)
public interface TestMapper {

    TestMapper INSTANCT = Mappers.getMapper(TestMapper.class);

    @Mapping(target = "testChild", source = "testChild.test2")
    TestDTO conver(TestChild testChild);

}

numberFormat()

number类型与字符串直接的转换是通过valueOf()，如果字符串格式不正确会抛出java.lang.NumberFormatException异常,例如：Integer.valueOf(“10.2”)
使用numberFormat()之后DecimalFormat格式转换，也会抛出异常

@Mapping(target = "age",source = "age", numberFormat = "#0.00")
PersonDTO conver(Person person);

逆映射@InheritInverseConfiguration

可以将正映射的逻辑进行继承相应反向方法的反向配置，进行反方向映射

继承与共享配置

如果所有类型的A（源类型和结果类型）都可以分配给B的相应类型，则一个方法A可以从另一种方法B继承配置。
如果可以使用多个方法作为继承的源，则必须在注释中指定方法名称：@InheritConfiguration( name = “方法=名” )。

    GafferCheckInVO convertToGafferCheckInVO(GafferCheckIn gafferCheckIn);

    @Mappings({
            @Mapping(source = "department.departmentName",target = "nursingGroupName")
    })
    void convertToGafferCheckInDTO(PersonBaseVO personBase, DepartmentBaseVO department, @MappingTarget GafferCheckInVO gafferCheckInVO);

自定义类型转换方法

可以自定义一些字段的转换逻辑，比如日期等格式化，然后在接口注明即可使用

@Mapper(uses=自定义.class)

或者指定某个方法

public class DateFormtUtil {

    @Named("自定义")
    public static String dateToString(Date date){
        return date == null ? "": new SimpleDateFormat("yyyy-MM-dd").format(date);
    }
}

@Mapper(uses =DateFormtUtil.class)
public interface PersonMapper {

    PersonMapper INSTANCT = Mappers.getMapper(PersonMapper.class);

   @Mapping(target = "createTime",source = "createTime",qualifiedByName = "自定义")
    PersonDTO conver(Person person);
}

官网学习

官网高级用法