SpringBoot原理之自動配置機(jī)制詳解
前言
在當(dāng)下的java生態(tài)里,SpringBoot已經(jīng)成為事實(shí)上的開發(fā)標(biāo)準(zhǔn),絕大多數(shù)人現(xiàn)在都是面向SpringBoot編程。SpringBoot是對Spring的進(jìn)一步封裝,整合了分布式系統(tǒng)上下游所需的各種類庫和組件,并且實(shí)現(xiàn)了開箱即用,而這一切的底層基礎(chǔ)就是SpringBoot的自動配置機(jī)制。
Spring配置類
Spring引入配置類是為了:1)替換冗長繁瑣的配置文件,2)提供更靈活的bean定義方式。使用@Configuration注解去標(biāo)記一個配置類,通過其中含有@Bean注解的方法去創(chuàng)建一個bean,如下代碼
@Configuration
public class HelloAutoConfiguration {
@Bean
HelloService helloService() {
return new HelloService;
}
}
即為一個簡單的配置類,并且定義了一個HelloService的bean。在此之上,Spring還提供了一套條件加載機(jī)制,可以去動態(tài)控制一個配置類是否被加載。通過實(shí)現(xiàn)org.springframework.context.annotation.Condition接口,開發(fā)者就可以自己控制配置類的加載條件,滿足很多復(fù)雜的場景
SpringBoot自動配置
介紹完了Spring的配置類,我們來看看SpringBoot是怎么利用這套機(jī)制去實(shí)現(xiàn)自動配置的。
自動配置的概念
首先,什么是自動配置?我們看一下SpringBoot對于自動配置類的定義:
Auto-configuration classes are regular Spring @Configuration beans. They are located using the SpringFactoriesLoader mechanism (keyed against this class). Generally auto-configuration beans are @Conditional beans (most often using @ConditionalOnClass and @ConditionalOnMissingBeanannotations).
自動配置類就是一個普通的@Configuration配置類,通常會帶有一些@Conditional條件注解,并且使用SpringFactoriesLoader機(jī)制去定位加載它們(并非都是如此,還有其他一些Spring固有的加載方式,比如通過@ComponentScan包掃描或者顯式@Import方式都可以讓它們被發(fā)現(xiàn))。
自動配置的運(yùn)行機(jī)制
加載方式
自動配置機(jī)制的啟用是通過@EnableAutoConfiguration注解去控制的,因此需要在SpringBoot工程的入口類上啟用該注解,但是通常,我們一般使用@SpringBootApplication來代替,后者是一個注解的合集,包含了一些必要的默認(rèn)配置,其中就有@EnableAutoConfiguration注解,其類的注釋上是這么描述的:
Indicates a Configuration class that declares one or more @Bean methods and also triggers auto-configuration and component scanning. This is a convenience annotation that is equivalent to declaring @Configuration, @EnableAutoConfiguration and @ComponentScan.
它本身既標(biāo)識一個配置類,同時也開啟了自動配置和組件掃描。
回到@EnableAutoConfiguration注解上,我們看一下該注解的定義
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
其中@Import(AutoConfigurationImportSelector.class)是功能生效的關(guān)鍵,該注解導(dǎo)入了AutoConfigurationImportSelector組件到Spring環(huán)境中,開啟自動配置類的掃描加載工作,該類實(shí)現(xiàn)了接口org.springframework.context.annotation.ImportSelector
public interface ImportSelector {
/**
* Select and return the names of which class(es) should be imported based on
* the {@link AnnotationMetadata} of the importing @{@link Configuration} class.
* @return the class names, or an empty array if none
*/
String[] selectImports(AnnotationMetadata importingClassMetadata);
....其他省略
}
其中selectImports方法會在Spring啟動時被調(diào)用,用于返回所有的自動配置類,調(diào)用入口在org.springframework.context.annotation.ConfigurationClassParser類中,該類是Spring專門用來加載處理所有@Configuration配置類的,具體的加載細(xì)節(jié),限于篇幅問題,就不在本文中展開說明了,讀者們可自行去閱讀源碼,本人也許會在后續(xù)再另開一篇詳細(xì)說明。接著說selectImports方法,我們來看一下自動配置類的加載過程,AutoConfigurationImportSelector對于該方法的具體實(shí)現(xiàn)為
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
isEnabled方法是一個開關(guān),用于控制是否啟用自動配置,邏輯很簡單,略過不提,往下看,關(guān)鍵邏輯在getAutoConfigurationEntry方法中,跟下去
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
AnnotationAttributes attributes = getAttributes(annotationMetadata);
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = getConfigurationClassFilter().filter(configurations);
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
很容易看到加載邏輯在getCandidateConfigurations方法中,后續(xù)代碼是去重和過濾的過程,再往下看
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
getBeanClassLoader());
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
+ "are using a custom packaging, make sure that file is correct.");
return configurations;
}
這個方法就很簡單明顯了,直接調(diào)用SpringFactoriesLoader去加載對應(yīng)的內(nèi)容,接下來我們再聊聊SpringFactoriesLoader機(jī)制是怎么回事。
SpringFactoriesLoader機(jī)制
SpringFactoriesLoader直譯過來就是工廠加載機(jī)制,是Spring仿照J(rèn)ava的SPI機(jī)制實(shí)現(xiàn)的一套類加載機(jī)制,通過讀取模塊內(nèi)的META-INF/spring.factories文件來加載類,該文件為Properties格式,其中key部分是一個Class全限定名稱,可以是一個接口、抽象類或者注解等,而value部分是一個支持逗號分割的實(shí)現(xiàn)類列表,比如

而SpringFactoriesLoader就是Spring提供的一個用于讀取解析META-INF/spring.factories文件的工具類,通過傳入一個Class類型加載其對應(yīng)的實(shí)現(xiàn)類列表。
SpringFactoriesLoader如何應(yīng)用在自動配置中
介紹完了SpringFactoriesLoader,我們來研究一下SpringBoot的自動配置機(jī)制中是怎么使用它的,回到上面的getCandidateConfigurations方法中,我們看一下這一行
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
getBeanClassLoader());
其中第一個參數(shù)是key對應(yīng)Class類型,第二個參數(shù)是用哪個ClassLoader去加載配置文件,我們看一下getSpringFactoriesLoaderFactoryClass這個方法返回的具體Class是什么
protected Class<?> getSpringFactoriesLoaderFactoryClass() {
return EnableAutoConfiguration.class;
}
很簡單,直接返回@EnableAutoConfiguration注解對應(yīng)的class類型,那么自動配置類在META-INF/spring.factories文件中的配置方式就顯而易見了,上面截圖中最前面的部分
# AutoConfiguration org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.cloud.autoconfigure.ConfigurationPropertiesRebinderAutoConfiguration,\ org.springframework.cloud.autoconfigure.LifecycleMvcEndpointAutoConfiguration,\ org.springframework.cloud.autoconfigure.RefreshAutoConfiguration,\ org.springframework.cloud.autoconfigure.RefreshEndpointAutoConfiguration,\ org.springframework.cloud.autoconfigure.WritableEnvironmentEndpointAutoConfiguration
就是對應(yīng)的自動配置類了。這些被配置在此處的類都會被作為自動配置類加載到Spring中,然后進(jìn)行相應(yīng)的處理,發(fā)揮出每個類的功能作用。
小結(jié)
SpringBoot的自動配置機(jī)制就簡單介紹到這里了,相信看官們看完了之后也都有了一些了解,當(dāng)然這篇文章里還有很多相關(guān)內(nèi)容沒有涉及到,包括自動配置類的條件加載方式、多個類之間的加載順序控制、排除和過濾機(jī)制,以及如何自定義自動配置類、重寫框架默認(rèn)行為等等,這些內(nèi)容筆者會在后續(xù)的文章中再進(jìn)行詳細(xì)探討。
到此這篇關(guān)于SpringBoot原理之自動配置機(jī)制的文章就介紹到這了,更多相關(guān)SpringBoot自動配置機(jī)制內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Mybatis實(shí)現(xiàn)動態(tài)SQL編寫的示例詳解
這篇文章主要為大家詳細(xì)介紹了mybatis中的動態(tài)sql的使用以及緩存的相關(guān)知識,文中的示例代碼講解詳細(xì),具有一定的學(xué)習(xí)價值,需要的可以參考一下2023-02-02
Java8時間接口LocalDateTime詳細(xì)用法
最近看別人項(xiàng)目源碼,發(fā)現(xiàn)Java8新的日期時間API很方便強(qiáng)大,所以整理了這篇文章,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)java的小伙伴們有很好的幫助,需要的朋友可以參考下2021-05-05
解決mybatis分頁插件PageHelper導(dǎo)致自定義攔截器失效
這篇文章主要為大家介紹了解決mybatis分頁插件PageHelper導(dǎo)致自定義攔截器失效方案示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-08-08
Spring boot JPA實(shí)現(xiàn)分頁和枚舉轉(zhuǎn)換代碼示例
這篇文章主要介紹了Spring boot JPA實(shí)現(xiàn)分頁和枚舉轉(zhuǎn)換代碼示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-09-09
JS求多個數(shù)組的重復(fù)數(shù)據(jù)
這篇文章主要介紹了JS求多個數(shù)組的重復(fù)數(shù)據(jù)的辦法,具有一定的參考價值,感興趣的小伙伴們可以參考一下2016-09-09
JavaWeb開發(fā)之使用jQuery與Ajax實(shí)現(xiàn)動態(tài)聯(lián)級菜單效果
這篇文章主要介紹了JavaWeb開發(fā)之使用jQuery與Ajax實(shí)現(xiàn)動態(tài)聯(lián)級菜單效果的相關(guān)資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2016-10-10

