徒手撸一个Spring Boot中的starter，解密自动化配置

骑猪看日落 2022-10-27 12:13 162阅读 0赞

![format_png][]

#### starter背景 ####

Spring Boot目前已经变成了后端开发这必备技能之一，其中一个主要原因是Spring Boot中有个非常重要的机制（starter机制）。

starter能够抛弃以前繁杂的配置，将其统一集成进starter，使用的时候只需要在maven中引入对应的starter依赖即可，Spring Boot就能自动扫描到要加载的信息并启动相应的默认配置。

starter让我们摆脱了各种依赖库的处理，以及各种配置信息的烦恼。SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。Spring Boot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

**\[**[**金三银四，如何涨薪看这里\]**][Link 1]

我们经常会看到或者使用到各种xxx-starter。比如下面几种：

![format_png 1][]

#### Spring Boot starter原理 ####

从总体上来看，无非就是将Jar包作为项目的依赖引入工程。而现在之所以增加了难度，是因为我们引入的是Spring Boot Starter，所以我们需要去了解Spring Boot对Spring Boot Starter的Jar包是如何加载的？下面我简单说一下。

SpringBoot 在启动时会去依赖的 starter 包中寻找 /META-INF/spring.factories 文件，然后根据文件中配置的 Jar 包去扫描项目所依赖的 Jar 包，这类似于 Java 的 SPI 机制。

细节上可以使用@Conditional 系列注解实现更加精确的配置加载Bean的条件。

JavaSPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制。

#### 自定义starter的条件 ####

如果想自定义Starter，首选需要实现自动化配置，而要实现自动化配置需要满足以下两个条件：

1.  能够自动配置项目所需要的配置信息，也就是自动加载依赖环境；
2.  能够根据项目提供的信息自动生成Bean，并且注册到Bean管理容器中；

#### 实现自定义starter ####

pom.xml依赖

<dependencies>
     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <version>2.0.0.RELEASE</version>
     </dependency>
     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <version>2.0.0.RELEASE</version>
        <optional>true</optional>
      </dependency>
    </dependencies>

根据需要自定义Starter的实现过程大致如下（以我定义的Starter为例）：

![format_png 2][]

定义XxxProperties类，属性配置类，完成属性配置相关的操作，比如设置属性前缀，用于在application.properties中配置。

TianProperties代码：

import org.springframework.boot.context.properties.ConfigurationProperties;
    @ConfigurationProperties(prefix = "spring.tian")
    public class TianProperties {
        private String name;
        private int age;
        private String sex = "M";
        //省略 get set 方法
    }

创建XxxService类，完成相关的操作逻辑 。

TianService代码：

public class TianService {
    
        private TianProperties properties;
    
        public TianService() {
        }
    
        public TianService(TianProperties userProperties) {
            this.properties = userProperties;
        }
        public void sayHello(){
            System.out.println("hi, 我叫: " + properties.getName() +
            ", 今年" + properties.getAge() + "岁"
             + ", 性别: " + properties.getSex());
        }
    }

定义XxxConfigurationProperties类，自动配置类，用于完成Bean创建等工作。

TianServiceAutoConfiguration代码：

@Configuration
    @EnableConfigurationProperties(TianProperties.class)
    @ConditionalOnClass(TianService.class)
    @ConditionalOnProperty(prefix = "spring.tian", value = "enabled", matchIfMissing = true)
    public class TianServiceAutoConfiguration {
    
        @Autowired
        private TianProperties properties;
    
        @Bean
        @ConditionalOnMissingBean(TianService.class)
        public TianService tianService() {
            return new TianService(properties);
        }
    }

在resources下创建目录META-INF，在 META-INF 目录下创建 spring.factories，在SpringBoot启动时会根据此文件来加载项目的自动化配置类。

**「spring.factories中配置」**

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tian.TianServiceAutoConfiguration

把上面这个starter工程打成jar包：

![format_png 3][]

#### 使用自定义starter ####

创建一个Spring Boot项目test，项目整体如下图：

![format_png 4][]

在项目中把自定义starter添加pom依赖

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

TestApplication启动类

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

application.properties中配置

spring.tian.name=tian
    spring.tian.age=22
    spring.tian.sex=M

写一个TestController.java类

RestController
    @RequestMapping("/my")
    public class TestController {
    
        @Resource
        private TianService tianService;
    
        @PostMapping("/starter")
        public Object starter() {
            tianService.sayHello();
            return "ok";
        }
    }

把我们自定义的starter打成的jar依赖进来后，

![format_png 5][]

可以看到其中多了一个json的文件。

![format_png 6][]

最后启动项目，输入

`http://localhost:9091/my/starter`

![format_png 7][]

controller成功返回ok，再看后台打印

hi, 我叫: tian, 今年22岁, 性别: M

这就成功的现实了自定义的starter。

关键词：`开箱即用、减少大量的配置项、约定大于配置`。

#### 总结 ####

1.  Spring Boot在启动时扫描项目所依赖的JAR包，寻找包含`spring.factories`文件的JAR包，
2.  然后读取`spring.factories`文件获取配置的自动配置类AutoConfiguration\`，
3.  然后将自动配置类下满足条件(`@ConditionalOnXxx`)的@Bean放入到Spring容器中(Spring Context)
4.  这样使用者就可以直接用来注入，因为该类已经在容器中了。

**「只要我们的方向对了，就不怕路远！」**

推荐阅读

[面试：Zookeeper常见11个连环炮][Zookeeper_11]

[金三银四，准备跳槽的看这里！][Link 1]

[面试：说说几个常见的Linux性能调优命令][Linux]

[《程序员面试宝典》.pdf下载][.pdf]

[JVM真香系列：如何判断对象是否可被回收？][JVM]

![format_png 8][]

**码字不易，点个赞呗**

[format_png]: /images/20221024/1eea8c74b8f44ecfa4d0b7fb454cd0a3.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd555034ca22d9227a63f380444a6cbed806d8096af39e478a0bf1b7a9d674f3a72928844f6c&idx=1&mid=2247497951&scene=21&sn=070d021f91f3c202b8f7ad4d9ec38c9d#wechat_redirect
[format_png 1]: /images/20221024/b3540c3516d94b58be2f77315c66ae64.png
[format_png 2]: /images/20221024/4c5b7a8bec7649f48740a3c7ff62d935.png
[format_png 3]: /images/20221024/8019dfa5b32c4998b42862f1802b4faa.png
[format_png 4]: /images/20221024/0960a02683d942ffae52e67c215f118b.png
[format_png 5]: /images/20221024/cf01f64814a7485983ea4213ce9dcb74.png
[format_png 6]: /images/20221024/65851d44989f47ccbe707a8a799b2ca8.png
[format_png 7]: /images/20221024/b440ddda1b68405891cb4ab83b462dcc.png
[Zookeeper_11]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd555e59ca22d74f75b6188877be2370a1b36d193e579cc7831b6c005454fc4efa787932dbb9&idx=1&mid=2247497394&scene=21&sn=649b5e470c4d1c4e0addca6c187d0771#wechat_redirect
[Linux]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5544a4ca22cdb2d0d3524822cdb9bcac75dfb5d6fd5a1eaf65c7f65bfdd2e83f601f4eb179&idx=1&mid=2247494735&scene=21&sn=f82250247c3eb781e54ad8d1d3ca5dde#wechat_redirect
[.pdf]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5540c2ca22c9d43adaea71eac78fd27ccbc395d86ab9a0bd7058ec846752854ba6891c29aa&idx=2&mid=2247493673&scene=21&sn=56f250a42913fed1b56fe6be41810b56#wechat_redirect
[JVM]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5540c2ca22c9d40f0d49f9af7081dd14656a8a1d184d934a0b50adb22b0a7ffe0233cbdcf3&idx=1&mid=2247493673&scene=21&sn=b302f71066ab185fe00aa0f75ce570c4#wechat_redirect
[format_png 8]: /images/20221024/55360318b2fb4596a497ef7a9ce8638f.png