MapStruct升級遇到的問題及解決方案

更新時間：2024年12月06日 09:25:15 作者：小白學架構(gòu)

MapStruct是一個用于生成類型安全,本文來介紹一下MapStruct升級遇到的問題及解決方案,具有一定的參考價值,感興趣的可以了解一下

問題：

1..升級mapstruct到1.3.0版本之后，當target類使用lombok的@Builder注解，并且source類和target類的首字母不同的字段沒有被正確轉(zhuǎn)換（1.2.0版本可以正常轉(zhuǎn)換）。

2.升級mapstruct到1.3.0版本之后，當target類使用lombok的@Builder注解，并且需要映射到父類的屬性，則編譯時會報 Unknown property

分析：

MapStruct 和lombok 的相遇，如果版本不一致，就會帶來一定的問題。

MapStruct是一個用于生成類型安全，高性能和無依賴的bean映射代碼的注釋處理器；

而LombokLombok是一款Java開發(fā)插件，使得Java開發(fā)者可以通過其定義的一些注解來消除業(yè)務工程中冗長和繁瑣的代碼，比如get set等，尤其對于簡單的Java模型對象（POJO）。

兩者都是通過注解處理器在編譯期生成對應的代碼。

舉例如下：

下圖為基于Lombok注解的POJO類：

這個是基于MapStruct注解定義的mapper接口

經(jīng)過lombok的注解處理器，編譯后的class如下：

經(jīng)過mapstruct的注解處理器，對UserDTOMapper自動生成了接口實現(xiàn)類：

結(jié)論：

可見，mapstruct 的注解處理器必須晚于 lombok的注解處理器執(zhí)行，才能保證bean 屬性能被正確映射。而出現(xiàn)上述問題的原因就在于lombok 和 mapstruct的執(zhí)行順序被打亂了。

解決方案：

在編譯插件中控制注解處理器的順序。

pom 如下：

       <plugin> 
          <groupId>org.apache.maven.plugins</groupId>  
          <artifactId>maven-compiler-plugin</artifactId>  
          <version>${maven-compiler-plugin.version}</version>  
          <configuration> 
            <source>${java.version}</source>  
            <target>${java.version}</target>
<!--            <release>${java.version}</release>-->
            <annotationProcessorPaths> 
              <path> 
                <groupId>org.projectlombok</groupId>  
                <artifactId>lombok</artifactId>  
                <version>${lombok-plugin.version}</version> 
              </path>  
              <path> 
                <groupId>org.mapstruct</groupId>  
                <artifactId>mapstruct-processor</artifactId>  
                <version>${mapstruct-plugin.version}</version> 
              </path>  
              <path> 
                <groupId>org.projectlombok</groupId>  
                <artifactId>lombok-mapstruct-binding</artifactId>  
                <version>${lombok-mapstruct-binding-plugin.version}</version> 
              </path> 
            </annotationProcessorPaths> 
          </configuration> 
        </plugin>

其中 lombok-mapstruct-binding 的包正是為了協(xié)調(diào)lombok和mapstruct的處理過程的。

這里仍然有個細節(jié)大家可以關注下：

（1）在annotationProcessorPaths 中去掉lombok-mapstruct-binding 這個包，其實也可以正確執(zhí)行的。只要lombok的path 聲明在 mapstruct之前。

（2）上述的annotationProcessorPaths配置，如果顛倒了lombok和mapstruct的順序，其實也是可以正確執(zhí)行的，只要同時引入了lombok-mapstruct-binding