Spring Boot 中 MapStruct 注入失败问题排查与解决

本文旨在解决 Spring Boot 项目中使用 MapStruct 时遇到的 `Autowired` 注入失败问题。我们将分析导致该问题的常见原因，并提供详细的排查步骤和解决方案，确保 MapStruct 能够正确生成映射器 Bean 并注入到 Spring 容器中。

问题分析

在 Spring Boot 项目中，当使用 MapStruct 进行对象映射时，可能会遇到类似如下的错误：

Description:

Parameter 1 of constructor in api.loteria.loteriaapi.services.Mysql.BetServiceMysql required a bean of type 'api.loteria.loteriaapi.dtos.mappers.BetMapper' that could not be found.

这个错误表明 Spring 容器无法找到 BetMapper 接口的 Bean 实例，导致无法注入到 BetServiceMysql 中。这通常是由于以下原因造成的：

1. MapStruct 处理器未正确配置： MapStruct 需要一个编译器插件 (mapstruct-processor) 来生成映射器的实现类。如果该插件没有正确配置，则不会生成 Bean，导致注入失败。
2. Mapper 接口配置错误： Mapper 接口的注解 (@Mapper) 配置不正确，导致 MapStruct 无法识别并生成实现类。
3. 依赖冲突： 项目中可能存在与 MapStruct 相关的依赖冲突，导致 MapStruct 无法正常工作。
4. IDE 问题： 在某些情况下，IDE 可能无法正确识别 MapStruct 生成的代码，导致编译错误或运行时问题。

解决方案

针对上述可能的原因，我们可以采取以下步骤进行排查和解决：

1. 检查 MapStruct 处理器配置

确保在 pom.xml 或 build.gradle 文件中正确配置了 mapstruct-processor 插件。

Maven (pom.xml):

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>1.5.5.Final</version>
                    </path>
                    <!-- other annotation processors -->
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>1.5.5.Final</version>
    </dependency>
    <!-- other dependencies -->
</dependencies>

Gradle (build.gradle):

dependencies {
    implementation 'org.mapstruct:mapstruct:1.5.5.Final'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.5.Final'

    // For Java 9 and later, you might need to add the following:
    annotationProcessor "org.projectlombok:lombok"
    compileOnly "org.projectlombok:lombok"
    testImplementation "org.projectlombok:lombok"
    testAnnotationProcessor "org.projectlombok:lombok"
}

注意:

• 确保 mapstruct-processor 的版本与 mapstruct 的版本一致。
• 如果使用 Lombok，还需要添加 Lombok 的依赖和 annotationProcessor。

2. 检查 Mapper 接口配置

确保 Mapper 接口使用了 @Mapper 注解，并且 componentModel 属性设置为 "spring"。

AI建筑知识问答

用人工智能ChatGPT帮你解答所有建筑问题

22

查看详情

@Mapper(componentModel = "spring")
public interface BetMapper {
    @Mapping(target = "id", source = "betRequest.betId") // 修改了 mapping
    Bet betResquetToEntity(BetRequest betRequest);

    @Mapping(source = "id", target = "betId") // 修改了 mapping
    BetResponse entityToBetResponse(Bet bet);
}

注意:

• componentModel = "spring" 告诉 MapStruct 生成的实现类应该是一个 Spring Bean，可以被自动注入。
• 检查 @Mapping 注解的 target 和 source 属性是否正确，确保映射的字段名称正确。 在提供的代码中，@Mapping(target = "bet.id", source = "betId") 和 @Mapping(source = "bet.id", target = "betId")可能是不正确的。 target 应该直接指向目标对象中的字段，而不是 bet.id。 source 应该指向源对象的属性。根据代码逻辑，这里可能需要修改为@Mapping(target = "id", source = "betRequest.betId") 和 @Mapping(source = "id", target = "betId")。

3. 清理和重新构建项目

在修改了配置后，需要清理和重新构建项目，以确保 MapStruct 处理器能够正确生成映射器的实现类。

• Maven: mvn clean install
• Gradle: gradle clean build

4. 检查依赖冲突

使用 Maven 或 Gradle 的依赖分析工具，检查是否存在与 MapStruct 相关的依赖冲突。如果存在冲突，需要解决冲突，确保 MapStruct 的版本正确。

• Maven: mvn dependency:tree
• Gradle: gradle dependencies

5. 检查 IDE 配置

确保 IDE 正确配置了 annotation processing。

• IntelliJ IDEA: 在 "Settings" -> "Build, Execution, Deployment" -> "Compiler" -> "Annotation Processors" 中，确保 "Enable annotation processing" 选项已选中。

6. 验证注入

在 BetServiceMysql 中，确保 BetMapper 使用构造器注入，并且 @AllArgsConstructor 注解正确配置。

@Service
@AllArgsConstructor(onConstructor_ = @Autowired) // 确保Autowired注解在构造器上
public class BetServiceMysql implements BetService {

    private BetRepository betRepository;
    private BetMapper betMapper;

    // ...
}

注意:

• @AllArgsConstructor(onConstructor_ = @Autowired) 确保 Lombok 生成的构造器会使用 @Autowired 注解，从而实现自动注入。 onConstructor_ = @Autowired 是 Lombok 的语法，用于在生成的构造器上添加 @Autowired 注解。

7. 运行时 Mapper 为 Null 的问题

如果移除了 @Autowired 注解后，代码可以运行，但是运行时 Mapper 为 Null，这说明 MapStruct 处理器没有正确生成 Mapper 的实现类，或者 Spring 容器没有正确管理 Mapper 的 Bean。 请仔细检查上述步骤，特别是 MapStruct 处理器的配置和 Mapper 接口的配置。

总结

解决 Spring Boot 中 MapStruct 注入失败的问题，需要仔细检查 MapStruct 处理器的配置、Mapper 接口的配置、依赖冲突和 IDE 配置。 通过以上步骤，可以确保 MapStruct 能够正确生成映射器的实现类，并将其注入到 Spring 容器中。 如果问题仍然存在，请提供更详细的错误信息和配置信息，以便更好地进行分析和解决。

以上就是Spring Boot 中 MapStruct 注入失败问题排查与解决的详细内容，更多请关注php中文网其它相关文章！