使用springboot開發(fā)應(yīng)用已經(jīng)有一段時(shí)間了鹅搪，我們都沉醉于它簡(jiǎn)潔的配置和平滑的上手曲線。
在springboot的開發(fā)中遭铺，starter是一個(gè)核心的配置丽柿，只需要引入對(duì)應(yīng)模塊的starter，然后在application.properties中引入對(duì)應(yīng)的配置項(xiàng)魂挂，就可以開發(fā)業(yè)務(wù)邏輯了甫题。
這一切都?xì)w功于springboot的自動(dòng)配置的能力。
那么本文就讓我們基于Jedis客戶端封裝一個(gè)我們自己的簡(jiǎn)易版starter涂召，較為深入的了解一下springboot的自動(dòng)配置魔法坠非。
新建原型項(xiàng)目
首先讓我們新建一個(gè)maven項(xiàng)目，引入基礎(chǔ)依賴果正，核心依賴為
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
該依賴中包含的spring-boot-autoconfigure提供了自動(dòng)配置的功能炎码。
完整pom如下
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.snowalker</groupId>
<artifactId>my-redis-starter</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<name>my-redis-starter</name>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/redis.clients/jedis -->
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
1.配置參數(shù)映射RedisProperties
這里我們新建一個(gè)類，類名為RedisProperties秋泳，就是一個(gè)POJO類潦闲，目的是映射配置文件application.properties到實(shí)體的字段中。
@ConfigurationProperties(prefix = "redis.starter")
public class RedisProperties {
private String host;
private int port;
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public int getPort() {
return port;
}
public void setPort(int port) {
this.port = port;
}
}
可以看到就是一個(gè)普通的POJO類迫皱，在類上添加注解 @ConfigurationProperties(prefix = “redis.starter”) 標(biāo)記當(dāng)前類為一個(gè)配置屬性類歉闰，對(duì)應(yīng)的配置文件中配置項(xiàng)的前綴為：redis.starter。
對(duì)于本例來講卓起，配置文件中對(duì)應(yīng)的完整配置項(xiàng)為：
redis.starter.host=xxx.xxx.xxx.xxx
redis.starter.port=xxxx
2.實(shí)現(xiàn)自動(dòng)化配置RedisAutoConfiguration.java
自動(dòng)化配置的核心就是提供實(shí)體bean的組裝和初始化和敬，對(duì)于本starter而言，我們主要組裝的核心bean就是 Jedis 這個(gè)實(shí)體戏阅。
@Configuration
@ConditionalOnClass(Jedis.class) // 存在Jedis這個(gè)類才裝配當(dāng)前類
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {
@Bean
@ConditionalOnMissingBean // 沒有Jedis這個(gè)類才進(jìn)行裝配
public Jedis jedis(RedisProperties redisProperties) {
return new Jedis(redisProperties.getHost(), redisProperties.getPort());
}
}
可以看到昼弟，我們這里通過@Bean注解組裝了一個(gè)Jedis的Bean，外界只需要通過注入即可使用饲握。
先解釋下幾個(gè)核心的注解：
@Configuration: 聲明當(dāng)前類為一個(gè)配置類
@ConditionalOnClass(Jedis.class)：當(dāng)SpringIoc容器內(nèi)存在Jedis這個(gè)Bean時(shí)才裝配當(dāng)前配置類
@EnableConfigurationProperties(RedisProperties.class)：這是一個(gè)開啟使用配置參數(shù)的注解私杜，value值就是我們配置實(shí)體參數(shù)映射的ClassType，將配置實(shí)體作為配置來源救欧。
@ConditionalOnMissingBean：當(dāng)SpringIoc容器內(nèi)不存在Jedis這個(gè)Bean的時(shí)候才進(jìn)行裝配，否則不裝配锣光。
Starter自動(dòng)化運(yùn)作原理
我們開發(fā)springboot應(yīng)用的時(shí)候都知道要在啟動(dòng)類加注解：@SpringBootApplication
在注解@SpringBootApplication上存在一個(gè)開啟自動(dòng)化配置的注解@EnableAutoConfiguration來完成自動(dòng)化配置笆怠，注解源碼如下所示：
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({EnableAutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
在@EnableAutoConfiguration注解內(nèi)使用到了@import注解來完成導(dǎo)入配置的功能，
而EnableAutoConfigurationImportSelector內(nèi)部則是使用了SpringFactoriesLoader.loadFactoryNames方法進(jìn)行掃描具有META-INF/spring.factories文件的jar包誊爹。
先來看下spring-boot-autoconfigure包內(nèi)的spring.factories文件內(nèi)容蹬刷，如下所示：
# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer
# Auto Configuration Import Listeners
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener
# Auto Configuration Import Filters
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
org.springframework.boot.autoconfigure.condition.OnClassCondition
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
.....省略
可以看到配置的結(jié)構(gòu)形式是Key/Value形式瓢捉，如果存在多個(gè)Value時(shí)則使用,隔開，那我們?cè)谧远xstarter內(nèi)也可以使用這種形式來完成办成，因?yàn)槲覀兊哪康氖菫榱送瓿勺詣?dòng)化配置泡态，所以我們這里Key則是需要使用org.springframework.boot.autoconfigure.EnableAutoConfiguration
3.自定義spring.factories
自定義spring.factories的步驟很簡(jiǎn)單，只需要在src/main/resource目錄下創(chuàng)建META-INF目錄,并在該目錄下添加文件spring.factories迂卢，文件內(nèi)容為：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.snowalker.demo.redis.RedisAutoConfiguration
到這里某弦，我們自定義my-redis-starter的步驟已經(jīng)完成，那么就讓我們建立一個(gè)測(cè)試項(xiàng)目來測(cè)試一下這個(gè)starter是否有效而克。
