Spring Boot Starter模块化Gradle构建中Bean依赖缺失的排查方案

针对Spring Boot Starter Bean无法被应用模块发现的问题，按以下步骤逐一排查：

1. 验证spring.factories配置的正确性 #

• 确认文件路径为**src/main/resources/META-INF/spring.factories**，注意路径和文件名的大小写（Linux/macOS环境下大小写敏感，容易写错为Spring.factories或路径层级错误）
• 检查文件内容格式：必须准确指定自动配置类的全限定名，示例正确格式：

  org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.starter.GreeterAutoConfiguration
  

  确保类名、包名没有拼写错误

2. 检查自动配置类GreeterAutoConfiguration的注解 #

• 必须添加@Configuration注解，否则Spring不会将其识别为配置类
• 确认Greeter Bean的声明：返回Greeter实例的方法必须添加@Bean注解，且方法为public访问权限，示例：

  @Configuration
  public class GreeterAutoConfiguration {
      @Bean
      public Greeter greeter() {
          return new Greeter();
      }
  }
  

• 排查是否存在条件注解导致Bean不生效：比如@ConditionalOnMissingBean、@ConditionalOnClass等，如果有，确认条件是否满足（例如@ConditionalOnClass依赖的类是否存在）

3. 确认Starter模块的构建输出 #

• 查看event-starter模块的构建产物（build/libs目录下的jar包），解压后检查：
  • 是否包含META-INF/spring.factories文件
  • com/example/starter目录下是否存在Greeter.class和GreeterAutoConfiguration.class文件
• 如果文件缺失，检查Starter模块的Gradle配置，确保资源文件和编译后的class文件被正确打包

4. 验证版本兼容性 #

• 确认event-starter和application模块使用的Spring Boot版本完全一致，避免因版本差异导致自动配置机制不兼容
• 检查io.spring.dependency-management插件是否正确管理了Spring Boot的依赖版本，确保Starter模块依赖的Spring Boot版本与应用模块同步

5. 排查不必要的组件扫描干扰 #

• 不要在GreeterAutoConfiguration中添加@ComponentScan注解，这会破坏Starter的自动配置逻辑（自动配置类通过spring.factories加载，无需组件扫描）
• 应用模块的@SpringBootApplication注解的扫描范围不影响Starter自动配置的加载，无需刻意调整扫描包路径

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