单体仓库跨模块无法自动注入StorageService接口问题求助

问题现象 #

启动Spring应用时出现如下错误：

Error starting ApplicationContext. To display the condition evaluation report re-run your application with 'debug' enabled.
2024-01-25 13:46:56,985 [ERROR] o.s.b.d.LoggingFailureAnalysisReporter --

APPLICATION FAILED TO START

Description:

Parameter 4 of constructor in com.recruitnow.tenant.user.service.UserService required a bean of type 'com.recruitnow.api.StorageService' that could not be found.

Action:

Consider defining a bean of type 'com.recruitnow.api.StorageService' in your configuration.

排查与解决方案 #

1. 检查Spring组件扫描范围 #

Spring默认仅扫描启动类所在包及其子包下的组件。若S3StorageService所在模块的包路径不在主应用的扫描范围内，Spring无法识别该@Service注解类，也就无法创建对应bean。

解决方法：
在Spring Boot启动类上添加@ComponentScan注解，明确包含StorageService接口所在包和S3StorageService实现类所在包：

@SpringBootApplication
@ComponentScan(basePackages = {"com.recruitnow.api", "com.recruitnow.storage"}) // 替换为实际包路径
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

2. 确认模块间依赖配置 #

在monorepo结构下，UserService所在模块必须依赖S3StorageService所在模块，否则编译和运行时无法找到实现类。

Maven依赖配置（在UserService模块的pom.xml中添加）：

<dependency>
    <groupId>com.recruitnow</groupId> <!-- 替换为实际groupId -->
    <artifactId>storage-module</artifactId> <!-- 替换为存储模块的artifactId -->
    <version>1.0.0</version> <!-- 替换为对应版本 -->
</dependency>

Gradle依赖配置（在UserService模块的build.gradle中添加）：

implementation project(':storage-module') // 替换为存储模块的项目名称

3. 验证@Service注解的正确性 #

确保S3StorageService上的@Service注解是Spring官方提供的，避免导入其他框架的同名注解：

// 正确的导入路径
import org.springframework.stereotype.Service;

@Service
public class S3StorageService implements StorageService {
    // ... 实现代码
}

4. 确认UserService被Spring管理 #

若UserService未被Spring标记为组件（如@Service、@Component），即使通过其他方式纳入容器，也可能导致注入失败。确保UserService上添加正确的Spring组件注解：

@Service
public class UserService {
    // ... 构造器及业务代码
}

内容的提问来源于stack exchange，提问作者Chida Nanda