Java中的MapStruct實現(xiàn)詳解

更新時間：2023年11月27日 10:20:12 作者：一碼評川

這篇文章主要介紹了Java中的MapStruct實現(xiàn)詳解,MapStruct 是一個代碼生成器,它基于約定優(yōu)先于配置的方法大大簡化了 JavaBean 類型之間映射的實現(xiàn),生成的映射代碼使用普通方法調用,需要的朋友可以參考下

簡單實現(xiàn)

引入依賴

<dependency>
 <groupId>org.mapstruct</groupId>
 <artifactId>mapstruct-jdk8</artifactId>
 <version>1.3.0.Final</version>
</dependency>
//注解處理器，根據注解自動生成mapper的實現(xiàn)
<dependency>
 <groupId>org.mapstruct</groupId>
 <artifactId>mapstruct-processor</artifactId>
 <version>1.2.0.Final</version>
</dependency>

我們在編譯時會報 java: No property named “numberOfSeats” exists in source parameter(s). Did you mean “null”? 錯誤，經過查閱資料發(fā)現(xiàn) mapstruct-processor 和 Lombok 的版本需要統(tǒng)一一下：mapstruct-processor：1.2.0.Final ， Lombok：1.16.14。

準備實體類

Car.java 和數據傳輸類 CarDto.java

@NoArgsConstructor
@AllArgsConstructor
@Data
public class Car {
    private String make;
    private int numberOfSeats;
    private CarType type;
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public class CarDto {
    private String make;
    private int seatCount;
    private String type;

}

創(chuàng)建映射器接口

定義映射方法

@Mapper
public interface CarMapper {
 
    CarMapper INSTANCE = Mappers.getMapper( CarMapper.class );

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

解析分析：

@Mapper 將接口標記為映射接口，并允許 MapStruct 處理器在編譯期間啟動。這里的 @Mapper 注解不是 mybatis 的注解，而是 org.mapstruct.Mapper 的；
實際映射方法 carToCarDto() 期望源對象 Car 作為參數，并返回目標對象 CarDto ，方法名可以自由選擇；
對于源對象和目標對象中具有不同名稱的屬性，可以使用 @Mapping 注釋來配置名稱；
對于源對象和目標對象中具有不同類型的屬性，也可以使用 @Mapping 注釋來進行轉換，比如：類型屬性將從枚舉類型轉換為字符串；
一個接口中可以有多個映射方法，對于所有的這些方法，MapStruct 將生成一個實現(xiàn)；
該接口的實現(xiàn)實例可以從 Mappers 中獲得，接口聲明一個 INSTANCE，為客戶端提供對映射器實現(xiàn)的訪問。

實現(xiàn)類

我們可以將代碼進行編譯，然后會發(fā)現(xiàn)在 target 文件中生成了 CarMapperImpl.class 文件：

在這里插入圖片描述

從代碼中可以看出 MapStruct 為我們自動生成了 set/get 代碼，并且對枚舉類進行了特殊處理。

客戶端

@Test
public void shouldMapCarToDto() {

    Car car = new Car( "Morris", 5, CarType.SEDAN );
    CarDto carDto = CarMapper.INSTANCE.carToCarDto( car );
    System.out.println(carDto);
    
}

執(zhí)行結果：

在這里插入圖片描述