mapstruct工具包的使用

一、 工具介绍
一个用于对象转换为另外一个对象的java工具类，主要适用于两个对象的大部分属性名称都相同的场景。相比于Spring的BeanUtils.copyProperties()方法，还可以实现不同名称字段之间的属性赋值

二、使用步骤
以maven工程为例，引入如下依赖：

<properties>
    <mapstruct.version>1.2.0.Final</mapstruct.version>
</properties>
<dependencies>
   <dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-jdk8</artifactId>
    <version>${mapstruct.version}</version>
   </dependency>
   <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct-processor</artifactId>
        <version>${mapstruct.version}</version>
   </dependency>
</dependencies>

1. 基本使用，不同的名称字段可以通过@Mapping或者@Mappings来映射

@Mapper
public interface CarMapper {
    // Car.make属性映射为CarDto.manufacturer，以此类推
    @Mappings({
        @Mapping(source = "make", target = "manufacturer"),
        @Mapping(source = "numberOfSeats", target = "seatCount")
    })
    CarDto carToCarDto(Car car);

    @Mapping(source = "name", target = "fullName")
    PersonDto personToPersonDto(Person person);
}

原理就是通过@Mapper注解的类会自动生成相应的实现类，根据方法上的注解生成对应的对象

2. 函数参数可以是多个对象，每个对象的一部分映射到返回的对象中

@Mapper
public interface AddressMapper {

    @Mappings({
        @Mapping(source = "person.description", target = "description"),
        @Mapping(source = "address.houseNo", target = "houseNumber")
    })
    DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Address address);
}

注意：如果输入的多个对象有相同属性名的参数，且返回对象也刚好有相同属性名的参数，则必须指明哪个对象的相同属性名参数映射到返回对象中，否则会报错。

3. 上述都是映射成一个新对象，如果需要将某个已存在的对象映射到一个已存在的对象中，可以采用@MappingTarget注解实现。

@Mapper
public interface CarMapper {
    void updateCarFromDto(CarDto carDto, @MappingTarget Car car);
}

---

4. mapstruct集成依赖注入，比如集成spring,可以通过如下方式集成: @Mapper(componentModel = "spring")

@Mapper(componentModel = "spring")
public interface CarMapper {
    CarDto carToCarDto(Car car);
}

然后其他地方引用时，可以通过如下方式直接注入使用：

@Autowired
private CarMapper carMapper;

5. 对象里面嵌套对象的属性也是可以指定映射的

@Mapper
public interface FishTankMapperWithDocument {

    @Mappings({
        @Mapping(target = "fish.kind", source = "fish.type"),
        @Mapping(target = "quality.document", source = "quality.report")
    })
    FishTankWithNestedDocumentDto map( FishTank source );

}

6. 当某些属性名相同时，我们并不想自动映射，可以通过ignore来标志, 如下忽略type属性的映射

@Mapper(componentModel = "spring")
public interface CarMapper {
    @Mappings({
            @Mapping(source = "manufacturer", target = "make"),
            @Mapping(source = "seatCount", target = "numberOfSeats"),
            @Mapping(target = "type",ignore = true)
    })
    void updateCarFromDto(CarDto carDto, @MappingTarget Car car);
}

7. Collection也是可以直接映射的
   注意点：下面carListToCarDtoList会直接遍历List, 然后调用carToCarDto单个完成映射；如果没有carToCarDto函数则会自动生成一个，只不过不同属性的值无法映射

@Mapper(componentModel = "spring")
public interface CarMapper {

    @Mappings({
            @Mapping(source = "make", target = "manufacturer"),
            @Mapping(source = "numberOfSeats", target = "seatCount")
    })
    CarDto carToCarDto(Car car);

    List<CarDto> carListToCarDtoList(List<Car> cars);
}

参考：http://mapstruct.org/documentation/stable/reference/html/