
本文旨在解决 spring Boot 项目中使用 MapStruct 时遇到的无法自动注入 `Mapper` 接口的问题。我们将深入分析问题原因,提供详细的解决方案,并分享使用 MapStruct 的最佳实践,帮助开发者更高效地进行对象转换。
在使用 spring boot 和 MapStruct 进行对象映射时,可能会遇到 BetMapper 无法注入的问题,导致应用程序启动失败。以下将详细分析问题的原因并提供解决方案。
问题分析
错误信息表明 Spring 容器无法找到 BetMapper 类型的 Bean,导致 BetServicemysql 构造函数注入失败。这通常是因为 MapStruct 处理器没有正确生成 BetMapper 接口的实现类,或者 Spring 容器没有扫描到该实现类。
解决方案
以下是解决此问题的步骤:
-
确认 MapStruct 依赖已添加:
确保你的 pom.xml 文件中包含了 MapStruct 的核心依赖和处理器依赖。
<dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct</artifactId> <version>${org.mapstruct.version}</version> </dependency> <dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-processor</artifactId> <version>${org.mapstruct.version}</version> <scope>provided</scope> </dependency>请替换 ${org.mapstruct.version} 为你想要使用的 MapStruct 版本,例如 1.5.5.Final。
-
配置 maven Compiler Plugin:
确保 maven-compiler-plugin 插件配置正确,并且包含了 MapStruct 处理器。 将以下内容添加到你的 pom.xml 文件中的 <build> -> <plugins> 节点中:
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <!-- 或者更新的版本 --> <configuration> <source>${Java.version}</source> <target>${java.version}</target> <annotationProcessorPaths> <path> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-processor</artifactId> <version>${org.mapstruct.version}</version> </path> </annotationProcessorPaths> </configuration> </plugin>
确保 ${java.version} 与你的项目使用的 Java 版本一致,例如 17 或 1.8。
-
检查 MapStruct 注解是否正确:
确保 BetMapper 接口使用了 @Mapper 注解,并且 componentModel 设置为 “spring”,这告诉 MapStruct 生成的实现类应该作为一个 Spring Bean。
@Mapper(componentModel = "spring") public interface BetMapper { @Mapping(target = "id", source = "betRequest.betId") Bet betResquetToEntity(BetRequest betRequest); @Mapping(source = "id", target = "betId") BetResponse entityToBetResponse(Bet bet); }注意: @Mapping 注解中的 target 和 source 属性需要正确指定目标属性和源属性。根据提供的代码,betResquetToEntity 方法中,betRequest 对象本身并没有名为 betId 的属性,而 BetRequest 对象有一个 betId 属性,需要将 source 修改为 betRequest.betId。 另外,target指向的是Bet实体类的id属性,所以target改为”id”。
-
清理并重新构建项目:
在 IDE 中或者通过 Maven 命令清理并重新构建项目,确保 MapStruct 处理器能够正确生成 BetMapper 接口的实现类。
mvn clean install
-
检查 Spring Bean 扫描:
确保 Spring Boot 能够扫描到 BetMapper 接口的实现类。通常情况下,如果 BetMapper 接口和 BetServiceMysql 类位于 Spring Boot 应用的根包或其子包中,Spring Boot 会自动扫描到它们。 如果不在,需要通过 @ComponentScan 注解显式指定扫描路径。
-
检查构造函数注入:
@AllArgsConstructor(onConstructor = @__(@Autowired)) 注解可以简化构造函数注入。 确保lombok配置正确,并且项目中引入了lombok依赖。
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
完整示例
以下是一个完整的示例,展示了如何使用 MapStruct 进行对象映射:
- BetRequest.java
public class BetRequest { private Long betId; private Integer maxNumbersByUsers; // Getters and setters public Long getBetId() { return betId; } public void setBetId(Long betId) { this.betId = betId; } public Integer getMaxNumbersByUsers() { return maxNumbersByUsers; } public void setMaxNumbersByUsers(Integer maxNumbersByUsers) { this.maxNumbersByUsers = maxNumbersByUsers; } }
- BetResponse.java
public class BetResponse { private Long betId; private Integer maxNumbersByUsers; // Getters and setters public Long getBetId() { return betId; } public void setBetId(Long betId) { this.betId = betId; } public Integer getMaxNumbersByUsers() { return maxNumbersByUsers; } public void setMaxNumbersByUsers(Integer maxNumbersByUsers) { this.maxNumbersByUsers = maxNumbersByUsers; } }
- Bet.java
import javax.persistence.Entity; import javax.persistence.Id; @Entity public class Bet { @Id private Long id; private Integer maxNumbersByUsers; // Getters and setters public Long getId() { return id; } public void setId(Long id) { this.id = id; } public Integer getMaxNumbersByUsers() { return maxNumbersByUsers; } public void setMaxNumbersByUsers(Integer maxNumbersByUsers) { this.maxNumbersByUsers = maxNumbersByUsers; } }
- BetMapper.java
import org.mapstruct.Mapper; import org.mapstruct.Mapping; @Mapper(componentModel = "spring") public interface BetMapper { @Mapping(target = "id", source = "betRequest.betId") Bet betResquetToEntity(BetRequest betRequest); @Mapping(source = "id", target = "betId") BetResponse entityToBetResponse(Bet bet); }
- BetServiceMysql.java
import lombok.AllArgsConstructor; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import java.util.List; import java.util.stream.Collectors; @Service @AllArgsConstructor(onConstructor = @__(@Autowired)) public class BetServiceMysql implements BetService { private BetRepository betRepository; private BetMapper betMapper; @Override public List<BetResponse> list() { List<Bet> bets = betRepository.findAll(); return bets.stream().map(bet -> betMapper.entityToBetResponse(bet)).collect(Collectors.toList()); } @Override public BetResponse save(BetRequest betRequest) { Bet bet = betMapper.betResquetToEntity(betRequest); betRepository.save(bet); return betMapper.entityToBetResponse(bet); } @Override public BetResponse update(Long id, BetRequest betRequest) { Bet bet = verifyIfExist(id); updateData(bet, betRequest); betRepository.save(bet); return betMapper.entityToBetResponse(bet); } @Override public BetResponse delete(Long id) { Bet bet = verifyIfExist(id); betRepository.delete(bet); return betMapper.entityToBetResponse(bet); } @Override public BetResponse getBetById(Long id) { // TODO Auto-generated method stub return null; } @Override public List<BetResponse> getBets() { // TODO Auto-generated method stub return null; } protected Bet verifyIfExist(Long id){ return betRepository.findById(id).orElseThrow(() -> new EntityNotFoundException(String.format("ID: %s || Não foi encontrado nenhuma entidade para o id fornecido", id))); } protected void updateData(Bet bet, BetRequest betRequest){ bet.setMaxNumbersByUsers(betRequest.getMaxNumbersByUsers()); } }
注意事项
- 确保 MapStruct 版本与 Spring Boot 版本兼容。
- 如果仍然遇到问题,可以尝试在 IDE 中启用 Annotation Processing 功能。
- 仔细检查错误日志,了解更多详细信息。
总结
通过以上步骤,你应该能够解决 Spring Boot 中 MapStruct 无法自动注入的问题。 关键在于正确配置 MapStruct 依赖和处理器,并确保 Spring 容器能够扫描到 MapStruct 生成的实现类。 正确使用 MapStruct 可以大大简化对象映射的代码,提高开发效率。


