[Java知识库]自定义springboot-starter

前言

1. 为什么要自定义starter？

   日常开发过程中，有一些独立于业务之外的配置模块，我们经常将其放在一个特定的包下。如果其他工程要复用这个模块的功能，需要硬拷贝，重新集成。我们将这些可独立于业务代码之外的模块封装成strter，复用时引入pom依赖，由springboot完成自动装配即可。

2. 应用场景

   • 登录模块
   • 动态数据源
   • AOP实现日志切面

一、自定义starter的命名规则

官方建议使用xxx-spring-boot-starter命名规则。

二、使用步骤

1. 创建普通java工程作为父工程，删除src目录

2. 创建zdy-spring-boot-starter的maven模块

   1. 导入springboot自动配置的相关jar包

              <dependency>
                  <groupId>org.springframework.boot</groupId>
                  <artifactId>spring-boot-autoconfigure</artifactId>
                  <version>2.2.9.RELEASE</version>
              </dependency>
      

   2. 创建所要导入的bean对象，用@ConfigurationProperties和@EnableConfigurationProperties标记

      @EnableConfigurationProperties(SimpleBean.class)
      @ConfigurationProperties(prefix = "simplebean")
      public class SimpleBean {
      
          private int id;
      
          private String name;
      
          public int getId() {
              return id;
          }
      
          public void setId(int id) {
              this.id = id;
          }
      
          public String getName() {
              return name;
          }
      
          public void setName(String name) {
              this.name = name;
          }
      
          @Override
          public String toString() {
              return "SimpleBean{" +
                      "id=" + id +
                      ", name='" + name + '\'' +
                      '}';
          }
      }
      

   3. 创建自动配置类MyAutoConfiguration，使用@Bean进行自动导入

      @Configuration
      public class MyAutoConfiguration {
      
          static {
              System.out.println("MyAutoConfiguration init...");
          }
      
          @Bean
          public SimpleBean simpleBean(){
              return new SimpleBean();
          }
      }
      

   4. 在resources下创建META-INF/spring.factories，编辑所需扫描的自动配置类

      org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
        com.lb.config.MyAutoConfiguration
      

3. 创建测试模块spring-boot-mytest的springboot工程

   1. 导入starter的相关依赖

              <dependency>
                  <groupId>com.lb</groupId>
                  <artifactId>zdy-spring-boot-starter</artifactId>
                  <version>1.0-SNAPSHOT</version>
              </dependency>
      

   2. 在properties中配置相应的属性

      simplebean.id=1
      simplebean.name=李
      

   3. 编写测试方法

      @SpringBootTest
      class SpringBootMytestApplicationTests {
      
          @Autowired
          private SimpleBean simpleBean;
      
          @Test
          void contextLoads() {
              System.out.println(simpleBean);
      
          }
      
      }
      
      

4. 为了方便自定义starter是否被自动装配，考虑使用热插拔技术

   在zdy-spring-boot-starter上

   1. 创建标记类ConfigMarker

      public class ConfigMarker {
      }
      
      

   2. 创建注解类EnableRegisterServer注解，需要使用@Import注解导入标记类的bean对象

      @Target({ElementType.TYPE})
      @Retention(RetentionPolicy.RUNTIME)
      @Import({ConfigMarker.class})
      public @interface EnableRegisterServer {
      }
      

   3. 在自动配置类MyAutoConfiguration中添加@ConditonalOnBean(ConfigMarker.class)注解，只有上下文中含有标记类的实体对象，被标注的类才会被实例化

      @Configuration
      @ConditionalOnBean(ConfigMarker.class)
      public class MyAutoConfiguration {
      
          static {
              System.out.println("MyAutoConfiguration init...");
          }
      
          @Bean
          public SimpleBean simpleBean(){
              return new SimpleBean();
          }
      }
      

      在spring-boot-mytest上

   4. 在启动类上新增@EnableImRegisterServer注解

      @SpringBootApplication
      @EnableRegisterServer
      public class SpringBootMytestApplication {
      
          public static void main(String[] args) {
              SpringApplication.run(SpringBootMytestApplication.class, args);
          }
      
      }
      

   5. 测试

      • 当添加了@EnableRegisterServer注解：

        

        正常输出。

      • 注释掉注解后：

        

      找不到bean。

总结

• 自定义starter可以快速的移植非业务的功能模块，如：登录模块、动态切换数据库、aop实现日志横切逻辑等等
• 自定义starter需要导入autoconfig的依赖jar包、创建所需导入的类以及AutoConfig类，用@bean标签导入
• 使用端需要导入自定义starter的pom依赖，并在application.properties配置好对应的属性即可
• 热插拔技术可以方便的导入所需的自定义starter，主要是在自定义starter工程中设置标记类、添加注解类引入标记类的bean对象、在AutoConfig类上添加@ConditionalOnBean注解，当标记类存在时，才能使用自定义starter。