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

gtxyzz 安全防护 2022-12-03 325浏览 0

starter背景

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

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

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

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

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

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，首选需要实现自动化配置，而要实现自动化配置需要满足以下两个条件：

能够自动配置项目所需要的配置信息，也就是自动加载依赖环境;

能够根据项目提供的信息自动生成Bean，并且注册到Bean管理容器中;

实现自定义starter

<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为例)：

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

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

TianProperties代码：

importorg.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix="spring.tian")
publicclassTianProperties{
privateStringname;
privateintage;
privateStringsex="M";
//省略getset方法
}

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

TianService代码：

publicclassTianService{

privateTianPropertiesproperties;

publicTianService(){
}

publicTianService(TianPropertiesuserProperties){
this.properties=userProperties;
}
publicvoidsayHello(){
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)
publicclassTianServiceAutoConfiguration{

@Autowired
privateTianPropertiesproperties;

@Bean
@ConditionalOnMissingBean(TianService.class)
publicTianServicetianService(){
returnnewTianService(properties);
}
}

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

「spring.factories中配置」

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

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

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

使用自定义starter

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

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

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

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

TestApplication启动类

@SpringBootApplication
@EnableEurekaServer
publicclassTestApplication{
publicstaticvoidmain(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")
publicclassTestController{

@Resource
privateTianServicetianService;

@PostMapping("/starter")
publicObjectstarter(){
tianService.sayHello();
return"ok";
}
}

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

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