如何自定义spring-boot-starter

SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。官方建议自定义的starter使用xxx-spring-boot-starter命名规则。以区分SpringBoot生态提供的starter。

1.resouces文件夹下创建spring.factories

META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    org.example.myservice.MyAutoConfig

MyAutoConfig为自定义的自动配置类

2.添加maven依赖

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
    </dependency>
    
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>

3.定义属性配置类MyProperties

@ConfigurationProperties("mytest.prop")
public class MyProperties {
        private xxx;
}

4.定义实现功能的处理类MyService

public class MyTestService {
    public MyTestService(MyProperties myProperties){
        // todo sth
    }
}

5.定义自动配置类MyAutoConfig

@Configuration
@ConditionalOnClass(MyTestService.class)  // 只有在 classpath 中找到 MyTestService 类的情况下，才会解析此自动配置类，否则不解析。
@EnableConfigurationProperties(MyProperties.class) // 启用配置类： 使 使用 @ConfigurationProperties 注解的MyProperties类生效。
public class MyAutoConfig {

      @Autowired
      private MyProperties myProperties;

      @Bean
      @ConditionalOnMissingBean(MyTestService.class) // 与 @Bean 配合使用，只有在当前上下文中不存在某个 bean 的情况下才会执行所注解的代码块，也就是当前上下文还没有 MyTestService 的 bean 实例的情况下，才会执行 myTestService() 方法，从而实例化一个 bean 实例出来。
      @ConditionalOnProperty(prefix = "mytest.prop", value = "open", havingValue = "true") //当应用配置文件中有相关的配置才会执行其所注解的代码块。
      public MyTestService myTestService(){
             return new MyTestService(myProperties);
      }
}

这个类的整体含义就是: 当 classpath 中存在 MyTestService 类时解析此配置类，什么情况下才会在 classpath 中存在呢，就是项目引用了相关的 jar 包。并且在上下文中没有 MyTestService 的 bean 实例的情况下，new 一个实例出来，并且将应用配置中的相关配置值传入。