自定义Spring Boot Starter/AutoConfiguration创建失败问题排查

可能的原因及修复步骤 #

1. 检查spring.factories配置正确性 #

• 确认spring.factories文件位于Starter项目的src/main/resources/META-INF目录下，路径不能出错
• 文件内容必须准确指定自动配置类的全限定名，格式示例：

  org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.javadevjournal.helloservicespringbootstart.config.HelloServiceAutoConfiguration
  

  注意：类名要和实际自动配置类完全一致（包括包名）；多行配置的反斜杠后不能有多余空格。

2. 验证自动配置类的Bean注册逻辑 #

• 确保HelloServiceAutoConfiguration类添加了@Configuration注解
• 检查是否通过@Bean注解正确注册HelloService实现类，示例代码：

  @Configuration
  public class HelloServiceAutoConfiguration {
  
      @Bean
      public HelloService helloService() {
          return new HelloServiceImpl();
      }
  }
  

• 如果使用了@ConditionalOnMissingBean这类条件注解，确认custom-app中没有手动注册同类型Bean，否则自动配置会被跳过。

3. 确认Maven打包与依赖引入正确性 #

• 执行mvn clean install重新打包Starter项目，确保打包无报错，本地Maven仓库中存在该依赖
• 在custom-app的pom.xml中，确认依赖坐标（groupId、artifactId、version）与Starter项目的pom.xml完全匹配，示例：

  <dependency>
      <groupId>com.javadevjournal</groupId>
      <artifactId>hello-service-spring-boot-start</artifactId>
      <version>1.0.0-SNAPSHOT</version>
  </dependency>
  

4. 排查自动配置生效问题 #

• 确认custom-app的启动类添加了@SpringBootApplication注解（该注解包含@EnableAutoConfiguration，会自动加载spring.factories中的配置）
• 若Starter包路径与custom-app包路径无父子关系，无需额外配置包扫描，Spring Boot自动配置机制会处理，只需确保自动配置类未被错误的条件注解限制。

测试验证 #

修复后，在custom-app中注入HelloService并测试：

@RestController
public class TestController {

    private final HelloService helloService;

    public TestController(HelloService helloService) {
        this.helloService = helloService;
    }

    @GetMapping("/hello")
    public String hello() {
        return helloService.sayHello();
    }
}

启动应用后访问/hello接口，即可正常返回Starter中定义的hello消息。

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