springboot自動配置原理以及spring.factories文件的作用詳解
一、springboot 自動配置原理
先說說我們自己的應用程序中Bean加入容器的辦法：
package com.ynunicom.dc.dingdingcontractapp;
import com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceAutoConfigure;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author jinye.Bai
*/
@SpringBootApplication(
scanBasePackages ={"com.ynunicom.dc.dingdingcontractapp"}
)
public class DingdingContractAppApplication {
public static void main(String[] args) {
SpringApplication.run(DingdingContractAppApplication.class, args);
}
}
我們在應用程序的入口設置瞭 @SpringBootApplication標簽，默認情況下他會掃描所有次級目錄。
如果增加瞭 scanBasePackages屬性，就會掃描所有被指定的路徑及其次級目錄。
那麼它在掃描的是什麼東西呢？
是這個：@Component
所有被掃描到的 @Component，都會成為一個默認的singleton（單例，即一個容器裡隻有一個對象實體）加入到容器中。
認識到以上這點，便於我們理解springboot自動配置的機制。
接下來讓我們看看在自己的應用程序中實現配置的方法。
如圖：
package com.ynunicom.dc.dingdingcontractapp.configuration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
/**
* @author: jinye.Bai
* @date: 2020/5/22 15:51
*/
@Configuration
public class RestTemplateConfig {
@Bean
public RestTemplate restTemplate(){
return new RestTemplate();
}
}
這裡我們設置瞭一個配置，往容器中加入瞭一個RestTemplate。
首先說 @Configuration，這個標簽繼承瞭 @Component標簽，我們可以在標簽內容看到：
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
@AliasFor(
annotation = Component.class
)
String value() default "";
}
可以看到其中是有 @Component標簽的，所以，@Configuration會被 @SpringBootApplication掃描到，進而把它和它下面的 @Bean加入容器，於是我們 RestTemplate的內容就配置完成瞭，在後續的使用中，我們就可以直接從容器中拿出RestTemplate使用它。
對於在maven中引用的其他外部包加入容器的過程，需要用到spring.factories。
二、spring.factories文件的作用
在springboot運行時，SpringFactoriesLoader 類會去尋找
public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
我們以mybatis-plus為例。
首先我們引入：
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
然後去maven的依賴裡看它的自動配置類MybatisPlusAutoConfiguration
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties({MybatisPlusProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisPlusLanguageDriverAutoConfiguration.class})
public class MybatisPlusAutoConfiguration implements InitializingBean {
可以看到有上文提到的 @Configuration，還有從application.yml載入自動配置的 @EnableConfigurationProperties({MybatisPlusProperties.class})
這個註解的具體內容請查看我另一篇博文，對其進行瞭解釋：
迅速學會@ConfigurationProperties的使用
也就是說，springboot隻要能掃描到MybatisPlusAutoConfiguration類的 @Configuration註解，其中的所有配置就能自動加入到容器中，這一過程由上面提到的SpringFactoriesLoader 起作用，它會去尋找 “META-INF/spring.factories” 文件，我們可以在 mybatis-plus的依賴中找到它：
SpringFactoriesLoader為什麼要讀取它呢？因為它內部是這樣的
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration,\ com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration
spring.factories用鍵值對的方式記錄瞭所有需要加入容器的類，EnableAutoConfigurationImportSelector的selectImports方法返回的類名，來自spring.factories文件內的配置信息，這些配置信息的key等於EnableAutoConfiguration，因為spring boot應用啟動時使用瞭EnableAutoConfiguration註解，所以EnableAutoConfiguration註解通過import註解將EnableAutoConfigurationImportSelector類實例化，並且將其selectImports方法返回的類名實例化後註冊到spring容器。
以上內容是springboot獲得這些類的方式，如果你想要實現自己的自動配置，就將你的類通過鍵值對的方式寫在你的spring.factories即可，註意，值是你的自動配置類，鍵必須是org.springframework.boot.autoconfigure.EnableAutoConfiguration
spring.factories 的妙用
現象
在閱讀 Spring-Boot 相關源碼時，常常見到 spring.factories 文件，裡面寫瞭自動配置（AutoConfiguration）相關的類名，因此產生瞭一個疑問：“明明自動配置的類已經打上瞭 @Configuration 的註解，為什麼還要寫 spring.factories 文件？
用過 Spring Boot 的都知道
@ComponentScan 註解的作用是掃描 @SpringBootApplication 所在的 Application 類所在的包（basepackage）下所有的 @component 註解（或拓展瞭 @component 的註解）標記的 bean，並註冊到 spring 容器中。
那麼問題來瞭
在 Spring Boot 項目中，如果你想要被 Spring 容器管理的 bean 不在 Spring Boot 包掃描路徑下，怎麼辦？
解決 Spring Boot 中不能被默認路徑掃描的配置類的方式，有 2 種：
（1）在 Spring Boot 主類上使用 @Import 註解
（2）使用 spring.factories 文件
以下是對 使用 spring.factories 文件的簡單理解
Spring Boot 的擴展機制之 Spring Factories
Spring Boot 中有一種非常解耦的擴展機制：Spring Factories。這種擴展機制實際上是仿照Java中的SPI擴展機制來實現的。
什麼是 SPI 機制？
SPI 的全名為 Service Provider Interface.大多數開發人員可能不熟悉，因為這個是針對廠商或者插件的。在java.util.ServiceLoader的文檔裡有比較詳細的介紹。
簡單的總結下 java SPI 機制的思想。我們系統裡抽象的各個模塊，往往有很多不同的實現方案，比如日志模塊的方案，xml解析模塊、jdbc模塊的方案等。面向的對象的設計裡，我們一般推薦模塊之間基於接口編程，模塊之間不對實現類進行硬編碼。一旦代碼裡涉及具體的實現類，就違反瞭可拔插的原則，如果需要替換一種實現，就需要修改代碼。為瞭實現在模塊裝配的時候能不在程序裡動態指明，這就需要一種服務發現機制。
java SPI 就是提供這樣的一個機制：為某個接口尋找服務實現的機制。有點類似IOC的思想，就是將裝配的控制權移到程序之外，在模塊化設計中這個機制尤其重要。
Spring Boot 中的 SPI 機制
在 Spring 中也有一種類似與 Java SPI 的加載機制。它在 resources/META-INF/spring.factories 文件中配置接口的實現類名稱，然後在程序中讀取這些配置文件並實例化。
在 Spring 中也有一種類似與 Java SPI 的加載機制。它在 resources/META-INF/spring.factories 文件中配置接口的實現類名稱，然後在程序中讀取這些配置文件並實例化。
這種自定義的SPI機制是 Spring Boot Starter 實現的基礎。
Spring Factories 實現原理是什麼？
spring-core 包裡定義瞭 SpringFactoriesLoader 類，這個類實現瞭檢索 META-INF/spring.factories 文件，並獲取指定接口的配置的功能。在這個類中定義瞭兩個對外的方法：
loadFactories 根據接口類獲取其實現類的實例，這個方法返回的是對象列表。 loadFactoryNames 根據接口獲取其接口類的名稱，這個方法返回的是類名的列表。
上面的兩個方法的關鍵都是從指定的 ClassLoader 中獲取 spring.factories 文件，並解析得到類名列表，具體代碼如下
public final class SpringFactoriesLoader {
public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
private static final Log logger = LogFactory.getLog(SpringFactoriesLoader.class);
private static final Map<ClassLoader, MultiValueMap<String, String>> cache = new ConcurrentReferenceHashMap();
private SpringFactoriesLoader() {}
public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) {
Assert.notNull(factoryClass, "'factoryClass' must not be null");
ClassLoader classLoaderToUse = classLoader;
if (classLoader == null) {
classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
}
List<String> factoryNames = loadFactoryNames(factoryClass, classLoaderToUse);
if (logger.isTraceEnabled()) {
logger.trace("Loaded [" + factoryClass.getName() + "] names: " + factoryNames);
}
List<T> result = new ArrayList(factoryNames.size());
Iterator var5 = factoryNames.iterator();
while(var5.hasNext()) {
String factoryName = (String)var5.next();
result.add(instantiateFactory(factoryName, factoryClass, classLoaderToUse));
}
AnnotationAwareOrderComparator.sort(result);
return result;
}
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
String factoryClassName = factoryClass.getName();
return (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);
if (result != null) {
return result;
} else {
try {
Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
LinkedMultiValueMap result = new LinkedMultiValueMap();
while(urls.hasMoreElements()) {
URL url = (URL)urls.nextElement();
UrlResource resource = new UrlResource(url);
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
Iterator var6 = properties.entrySet().iterator();
while(var6.hasNext()) {
Entry<?, ?> entry = (Entry)var6.next();
String factoryClassName = ((String)entry.getKey()).trim();
String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
int var10 = var9.length;
for(int var11 = 0; var11 < var10; ++var11) {
String factoryName = var9[var11];
result.add(factoryClassName, factoryName.trim());
}
}
}
cache.put(classLoader, result);
return result;
} catch (IOException var13) {
throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
}
}
}
private static <T> T instantiateFactory(String instanceClassName, Class<T> factoryClass, ClassLoader classLoader) {
try {
Class<?> instanceClass = ClassUtils.forName(instanceClassName, classLoader);
if (!factoryClass.isAssignableFrom(instanceClass)) {
throw new IllegalArgumentException("Class [" + instanceClassName + "] is not assignable to [" + factoryClass.getName() + "]");
} else {
return ReflectionUtils.accessibleConstructor(instanceClass, new Class[0]).newInstance();
}
} catch (Throwable var4) {
throw new IllegalArgumentException("Unable to instantiate factory class: " + factoryClass.getName(), var4);
}
}
}
從代碼中我們可以知道，在這個方法中會遍歷整個 spring-boot 項目的 classpath 下 ClassLoader 中所有 jar 包下的 spring.factories文件。也就是說我們可以在自己的 jar 中配置 spring.factories 文件，不會影響到其它地方的配置，也不會被別人的配置覆蓋。
Spring Factories 在 Spring Boot 中的應用
在 Spring Boot 的很多包中都能夠找到 spring.factories 文件，接下來我們以 spring-boot-autoconfigure 包為例進行介紹
# Initializers org.springframework.context.ApplicationContextInitializer=\ org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\ org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener # 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.OnBeanCondition,\ org.springframework.boot.autoconfigure.condition.OnClassCondition,\ org.springframework.boot.autoconfigure.condition.OnWebApplicationCondition # Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\ org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\ org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\ org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
結合前面的內容，可以看出 spring.factories 文件可以將 spring-boot 項目包以外的 bean（即在 pom 文件中添加依賴中的 bean）註冊到 spring-boot 項目的 spring 容器。
由於@ComponentScan 註解隻能掃描 spring-boot 項目包內的 bean 並註冊到 spring 容器中，因此需要 @EnableAutoConfiguration 註解來註冊項目包外的bean。
而 spring.factories 文件，則是用來記錄項目包外需要註冊的bean類名。
以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。
推薦閱讀：
- Spring中的spring.factories文件用法(Spring如何加載第三方Bean)
- SpringBoot自動配置深入探究實現原理
- SpringBoot原理之自動配置機制詳解
- Springboot自動加載配置的原理解析
- Java SpringBoot自動裝配原理詳解及源碼註釋