深入剖析MapStruct未生成實現類問題

一、MapStruct簡介

MapStruct是一個Java bean映射器，它通過註解和代碼生成來在Java bean之間轉換成本類代碼，實現類型安全，簡單而不失靈活。

作為一個輕量級工具，它不依賴於反射和運行時庫，因此啟動時間很快。它的主要優勢在於消除了需要編寫的類型轉換代碼。每次添加新屬性或更新現有屬性時，它可以自動更新此代碼。

二、MapStruct生成未實現類的原因

一些使用MapStruct的用戶會遇到問題：在使用MapStruct創建映射器時，可能會出現未生成實現類的情況。下面我們將深入了解該問題的原因。

三、缺少依賴

這是最常見的問題之一，很可能會導致MapStruct未能正常生成實現。使用標準（已預定義）Mapper實現時，如果找不到差異分析器、映射器或目標進行映射，則可能發生此問題。為了解決這個問題，我們可以添加缺少的依賴。

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-jdk8</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.1.0.Final</version>
    <scope>provided</scope>
</dependency>

四、非公共類型的映射問題

當我們使用MapStruct創建一個映射器以映射非公共類型或帶有任何鏈接深度時，可能會遇到此類問題。當我們使用@Mapper註解並指定提供自定義實現的類時，必須確保該類與要映射的類型一起打包。這可以通過添加以下配置來實現：

@Mapper(componentModel = "spring", uses = CustomMapper.class)
public interface UserMapper {

    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);

    UserDTO toDTO(User user);
}

五、隱式映射缺失

另一個被報告的問題是無法生成映射器的非顯式映射。MapStruct要求所有字段都得是顯式映射。當屬性名稱相同時，映射才會發生。即應用程序中所有屬性都需要顯式映射，並將其添加到映射器的源和目標之間。否則，它將無法找到它要映射的字段。

六、未定義或在映射器中找不到映射

在MapStruct中，當源和目標之間存在未定義的字段時，將無法創建映射器。這意味着如果我們更新某個字段的名稱或刪除某個參數，必須將其刪除或重新映射到新名稱。映射表達式必須明確列出所有可能的情況。

七、總結

在使用MapStruct時，有時可能會遇到未生成實現類的問題。最常見的原因包括缺少依賴、映射問題和隱式映射。為了避免這些問題，我們需要仔細閱讀MapStruct的文檔並正確地配置代碼。我們可以使用一些提示來幫助我們避免常見的問題。