深入剖析MapStruct未生成实现类问题

发布时间：2023-05-24

一、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的文档并正确地配置代码。我们可以使用一些提示来帮助我们避免常见的问题。

推荐文章