五分鐘說清楚 Spring Boot的自動配置原理
前言
Spring Boot沒有火起來之前，使用SSM架構的項目那是相當的多，現在也有不少項目還是使用這種架構。在使用SSM架構的時候，大家是否還記得大量配置的煩惱郁悶，各種配置，搞得人都不是很爽。各種配置掃描，如果想添加一個新的依賴，還得添加各種配置。這種大量配置的工作不進浪費時間，最主要的是會產生各種坑。
自從有了 Spring Boot 之后，咱們就爽爽的!各種零配置開箱即用，而我們之所以開發起來能夠這么爽，自動配置的功勞少不了，今天我們就一起來討論一下 SpringBoot 自動配置原理。
快速了解 SpringBoot 源碼常用注解
我們先對相關基本的注解進行說明，熟悉了這些注解，有利于我們后面更好的閱讀源碼。只要搞清楚了這些注解，遠嗎也就變得沒那么難了。加油!少年~
組合注解
當可能大量同時使用到幾個注解到同一個類上，就可以考慮將這幾個注解到別的注解上。被注解的注解我們就稱之為組合注解。
- 元注解：可以注解到別的注解上的注解。
- 組合注解：被注解的注解我們就稱之為組合注解。
@Value
@Value注解有Spring提供，并非是Spring Boot中的，該注解存在于spring-beans.jar中。
- @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface Value {
- /**
- * The actual value expression: for example {@code #{systemProperties.myProp}}.
- * 比如我們配置項address=ZhongguoGuizhou,這里的value=address
- */
- String value();
- }
@Value也相當于傳統 xml 配置文件中的 value 字段。
假設存在代碼：
- @Component
- public class Person {
- @Value("i am name")
- private String name;
- }
上面代碼等價于的配置文件：
- <bean class="Person">
- <property name ="name" value="i am name"></property>
- </bean>
我們知道配置文件中的 value 的取值可以是：
- 字面量
- 通過 ${key} 方式從環境變量中獲取值
- 通過 ${key} 方式全局配置文件中獲取值
- #{SpEL}
所以，我們就可以通過 @Value(${key}) 的方式獲取全局配置文件中的指定配置項。
使用@Value有三個缺點：
- 配置屬性不統一，沒有結構。
- 注入麻煩每個屬性都要寫配置名，和屬性名。(只要有重復的工作，就應該重構)
- 配置零散在項目中各處
@ConfigurationProperties 注解
該注解有Spring Boot提供，在spring-boot.jar包中
org.springframework.boot.context.properties;目錄下：
- @Target({ElementType.TYPE, ElementType.METHOD})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface ConfigurationProperties {
- //前綴
- @AliasFor("prefix")
- String value() default "";
- @AliasFor("value")
- String prefix() default "";
- //...
- }
如果我們要去獲取很多配置項，比如：賬號、密碼、地址等一堆配置項時，如果我們還是用@Value得一個一個去獲取配置項，是不是覺得很low呀，所以這時候我們就可以考慮使用@ConfigurationProperties。
標有 @ConfigurationProperties 的類的所有屬性和配置文件中相關的配置項進行綁定。(默認從全局配置文件中獲取配置值)，綁定之后我們就可以通過這個類去訪問全局配置文件中的屬性值了。
下面看一個實例：
第1步：在主配置文件中添加如下配置
- pay.account=java后端技術全棧
- pay.password=tj20120622
- pay.url=http://woaijava.cc
第2步：創建配置類，由于篇幅問題這里省略了 setter、getter 方法，但是實際開發中這個是必須的，否則無法成功注入。另外，@Component 這個注解也還是需要添加的。
- @Component
- @ConfigurationProperties(prefix = "pay")
- public class PayInfo {
- private String account;
- private Integer password;
- private String url;
- }
這里 @ConfigurationProperties 有一個 prefix 參數，主要是用來指定該配置項在配置文件中的前綴。
第3步：測試，在 Spring Boot 環境中，編寫個測試方法，注入PayInfo類，即可通過 PayInfo對象取到配置文件的值。
@Import 【Spring 提供】
@Import 是由Spring提供的注解，支持導入普通 java 類，并將其聲明成一個bean。主要用于將多個分散的 java config 配置類融合成一個更大的 config 類。
- @Import 注解在 4.2 之前只支持導入配置類。
- 在4.2之后 @Import 注解支持導入普通的 java 類,并將其聲明成一個 bean。
@Import 三種使用方式
- 直接導入普通的 Java 類。
- 配合自定義的 ImportSelector 使用。
- 配合 ImportBeanDefinitionRegistrar 使用。
第一種方式：直接導入普通的 Java 類
第1步：創建一個普通的 Java 類。
- public class Circle {
- public void sayHi() {
- System.out.println("Circle sayHi()");
- }
- }
第2步：創建一個配置類，里面沒有顯式聲明任何的 Bean，然后將剛才創建的 Circle 導入。
- @Import({Circle.class})
- @Configuration
- public class MainConfig {
- }
第3步：創建測試類。
- public static void main(String[] args) {
- ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
- Circle circle = context.getBean(Circle.class);
- circle.sayHi();
- }
第4步：運行結果：
- Circle sayHi()
可以看到我們順利的從 IOC 容器中獲取到了 Circle 對象，證明我們在配置類中導入的 Circle 類，確實被聲明為了一個 Bean。
第二種方式：配合自定義的 ImportSelector 使用
ImportSelector 是一個接口，該接口中只有一個 selectImports 方法，用于返回全類名數組。所以利用該特性我們可以給容器動態導入 N 個 Bean。
第1步：創建普通 Java 類 Triangle。
- public class Triangle {
- public void sayHi(){
- System.out.println("Triangle sayHi()");
- }
- }
第2步：創建 ImportSelector 實現類，selectImports 返回 Triangle 的全類名。
- public class MyImportSelector implements ImportSelector {
- @Override
- public String[] selectImports(AnnotationMetadata annotationMetadata) {
- return new String[]{"annotation.importannotation.waytwo.Triangle"};
- }
- }
第3步：創建配置類，在原來的基礎上還導入了 MyImportSelector。
- @Import({Circle.class,MyImportSelector.class})
- @Configuration
- public class MainConfigTwo {
- }
第4步：創建測試類
- public static void main(String[] args) {
- ApplicationContext context = new AnnotationConfigApplicationContext(MainConfigTwo.class);
- Circle circle = context.getBean(Circle.class);
- Triangle triangle = context.getBean(Triangle.class);
- circle.sayHi();
- triangle.sayHi();
- }
第5步：運行結果：
Circle sayHi()
Triangle sayHi()
可以看到 Triangle 對象也被 IOC 容器成功的實例化出來了。
第三種方式：配合 ImportBeanDefinitionRegistrar 使用
ImportBeanDefinitionRegistrar 也是一個接口，它可以手動注冊bean到容器中，從而我們可以對類進行個性化的定制。(需要搭配 @Import 與 @Configuration 一起使用。)
第1步：創建普通 Java 類 Rectangle。
- public class Rectangle {
- public void sayHi() {
- System.out.println("Rectangle sayHi()");
- }
- }
第2步：創建 ImportBeanDefinitionRegistrar 實現類，實現方法直接手動注冊一個名叫 rectangle 的 Bean 到 IOC 容器中。
- public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
- @Override
- public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
- RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Rectangle.class);
- // 注冊一個名字叫做 rectangle 的 bean
- beanDefinitionRegistry.registerBeanDefinition("rectangle", rootBeanDefinition);
- }
- }
第3步：創建配置類，導入 MyImportBeanDefinitionRegistrar 類。
- @Import({Circle.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class})
- @Configuration
- public class MainConfigThree {
- }
第4步：創建測試類。
- public static void main(String[] args) {
- ApplicationContext context = new AnnotationConfigApplicationContext(MainConfigThree.class);
- Circle circle = context.getBean(Circle.class);
- Triangle triangle = context.getBean(Triangle.class);
- Rectangle rectangle = context.getBean(Rectangle.class);
- circle.sayHi();
- triangle.sayHi();
- rectangle.sayHi();
- }
第5步：運行結果
Circle sayHi()
Triangle sayHi()
Rectangle sayHi()
由此看一看到，Rectangle 對象也被注冊進來了。
@Conditional 【Spring提供】
@Conditional 注釋可以實現只有在特定條件滿足時才啟用一些配置。
下面看一個簡單的例子：
第1步：創建普通 Java 類 ConditionBean，該類主要用來驗證 Bean 是否成功加載。
- public class ConditionBean {
- public void sayHi() {
- System.out.println("ConditionBean sayHi()");
- }
- }
第2步：創建 Condition 實現類，@Conditional 注解只有一個 Condition 類型的參數，Condition 是一個接口，該接口只有一個返回布爾值的 matches() 方法，該方法返回 true 則條件成立，配置類生效。反之，則不生效。在該例子中我們直接返回 true。
- public class MyCondition implements Condition {
- @Override
- public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
- return true;
- }
- }
第3步：創建配置類，可以看到該配置的 @Conditional 傳了我們剛才創建的 Condition 實現類進去，用作條件判斷。
- @Configuration
- @Conditional(MyCondition.class)
- public class ConditionConfig {
- @Bean
- public ConditionBean conditionBean(){
- return new ConditionBean();
- }
- }
第4步：編寫測試方法。
- public static void main(String[] args) {
- ApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class);
- ConditionBean conditionBean = context.getBean(ConditionBean.class);
- conditionBean.sayHi();
- }
第5步：結果分析
因為 Condition 的 matches 方法直接返回了 true，配置類會生效，我們可以把 matches 改成返回 false，則配置類就不會生效了。
除了自定義 Condition，Spring 還為我們擴展了一些常用的 Condition。常用注解，可以參考：
SpringBoot 啟動過程
在看源碼的過程中，我們會看到以下四個類的方法經常會被調用，我們需要對一下幾個類有點印象：
- ApplicationContextInitializer
- ApplicationRunner
- CommandLineRunner
- SpringApplicationRunListener
下面開始源碼分析，先從 SpringBoot 的啟動類的 run() 方法開始看，以下是調用鏈：SpringApplication.run() -> run(new Class[]{primarySource}, args) -> new SpringApplication(primarySources)).run(args)。
一直在run，終于到重點了，我們直接看 new SpringApplication(primarySources)).run(args) 這個方法。
上面的方法主要包括兩大步驟：
- 創建 SpringApplication 對象。
- 運行 run() 方法。
創建 SpringApplication 對象
- public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
- this.sources = new LinkedHashSet();
- this.bannerMode = Mode.CONSOLE;
- this.logStartupInfo = true;
- this.addCommandLineProperties = true;
- this.addConversionService = true;
- this.headless = true;
- this.registerShutdownHook = true;
- this.additionalProfiles = new HashSet();
- this.isCustomEnvironment = false;
- this.resourceLoader = resourceLoader;
- Assert.notNull(primarySources, "PrimarySources must not be null");
- // 保存主配置類（這里是一個數組，說明可以有多個主配置類）
- this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
- // 判斷當前是否是一個 Web 應用
- this.webApplicationType = WebApplicationType.deduceFromClasspath();
- // 從類路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationContextInitializer，然后保存起來
- this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
- // 從類路徑下找到 META/INF/Spring.factories 配置的所有 ApplicationListener，然后保存起來
- this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
- // 從多個配置類中找到有 main 方法的主配置類（只有一個）
- this.mainApplicationClass = this.deduceMainApplicationClass();
- }
運行 run() 方法
- public ConfigurableApplicationContext run(String... args) {
- // 創建計時器
- StopWatch stopWatch = new StopWatch();
- stopWatch.start();
- // 聲明 IOC 容器
- ConfigurableApplicationContext context = null;
- Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList();
- this.configureHeadlessProperty();
- // 從類路徑下找到 META/INF/Spring.factories 獲取 SpringApplicationRunListeners
- SpringApplicationRunListeners listeners = this.getRunListeners(args);
- // 回調所有 SpringApplicationRunListeners 的 starting() 方法
- listeners.starting();
- Collection exceptionReporters;
- try {
- // 封裝命令行參數
- ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
- // 準備環境，包括創建環境，創建環境完成后回調 SpringApplicationRunListeners#environmentPrepared()方法，表示環境準備完成
- ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments);
- this.configureIgnoreBeanInfo(environment);
- // 打印 Banner
- Banner printedBanner = this.printBanner(environment);
- // 創建 IOC 容器（決定創建 web 的 IOC 容器還是普通的 IOC 容器）
- context = this.createApplicationContext();
- exceptionReporters = this.getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[]{ConfigurableApplicationContext.class}, context);
- /*
- * 準備上下文環境，將 environment 保存到 IOC 容器中，并且調用 applyInitializers() 方法
- * applyInitializers() 方法回調之前保存的所有的 ApplicationContextInitializer 的 initialize() 方法
- * 然后回調所有的 SpringApplicationRunListener#contextPrepared() 方法
- * 最后回調所有的 SpringApplicationRunListener#contextLoaded() 方法
- */
- this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);
- // 刷新容器，IOC 容器初始化（如果是 Web 應用還會創建嵌入式的 Tomcat），掃描、創建、加載所有組件的地方
- this.refreshContext(context);
- // 從 IOC 容器中獲取所有的 ApplicationRunner 和 CommandLineRunner 進行回調
- this.afterRefresh(context, applicationArguments);
- stopWatch.stop();
- if (this.logStartupInfo) {
- (new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);
- }
- // 調用 所有 SpringApplicationRunListeners#started()方法
- listeners.started(context);
- this.callRunners(context, applicationArguments);
- } catch (Throwable var10) {
- this.handleRunFailure(context, var10, exceptionReporters, listeners);
- throw new IllegalStateException(var10);
- }
- try {
- listeners.running(context);
- return context;
- } catch (Throwable var9) {
- this.handleRunFailure(context, var9, exceptionReporters, (SpringApplicationRunListeners)null);
- throw new IllegalStateException(var9);
- }
- }
小結
run() 階段主要就是回調本節開頭提到過的4個監聽器中的方法與加載項目中組件到 IOC 容器中，而所有需要回調的監聽器都是從類路徑下的 META-INF/Spring.factories中獲取，從而達到啟動前后的各種定制操作。
SpringBoot 自動配置原理
@SpringBootApplication 注解
SpringBoot 項目的一切都要從 @SpringBootApplication 這個注解開始說起。
@SpringBootApplication 標注在某個類上說明：
- 這個類是 SpringBoot 的主配置類。
- SpringBoot 就應該運行這個類的 main 方法來啟動 SpringBoot 應用。
該注解的定義如下：
- @SpringBootConfiguration
- @EnableAutoConfiguration
- @ComponentScan(
- excludeFilters = {@Filter(
- type = FilterType.CUSTOM,
- classes = {TypeExcludeFilter.class}
- ), @Filter(
- type = FilterType.CUSTOM,
- classes = {AutoConfigurationExcludeFilter.class}
- )}
- )
- public @interface SpringBootApplication {
- }
可以看到SpringBootApplication 注解是一個組合注解(關于組合注解文章的開頭有講到)，其主要組合了一下三個注解：
- @SpringBootConfiguration：該注解表示這是一個 Spring Boot 的配置類，其實它就是一個 @Configuration 注解而已。
- @ComponentScan：開啟組件掃描。
- @EnableAutoConfiguration：從名字就可以看出來，就是這個類開啟自動配置的。嗯，自動配置的奧秘全都在這個注解里面。
@EnableAutoConfiguration 注解
先看該注解是怎么定義的：
- @AutoConfigurationPackage
- @Import({AutoConfigurationImportSelector.class})
- public @interface EnableAutoConfiguration {
- }
@AutoConfigurationPackage
從字面意思理解就是自動配置包。點進去可以看到就是一個 @Import 注解：@Import({Registrar.class})，導入了一個 Registrar 的組件。關于 @Import 的用法文章上面也有介紹哦。
我們在 Registrar 類中的 registerBeanDefinitions 方法上打上斷點，可以看到返回了一個包名，該包名其實就是主配置類所在的包。
一句話：@AutoConfigurationPackage 注解就是將主配置類(@SpringBootConfiguration標注的類)的所在包及下面所有子包里面的所有組件掃描到Spring容器中。所以說，默認情況下主配置類包及子包以外的組件，Spring 容器是掃描不到的。
@Import({AutoConfigurationImportSelector.class})
該注解給當前配置類導入另外的 N 個自動配置類。(該注解詳細用法上文有提及)。
配置類導入規則
那具體的導入規則是什么呢?我們來看一下源碼。在開始看源碼之前，先啰嗦兩句。就像小馬哥說的，我們看源碼不用全部都看，不用每一行代碼都弄明白是什么意思，我們只要抓住關鍵的地方就可以了。
我們知道 AutoConfigurationImportSelector 的 selectImports就是用來返回需要導入的組件的全類名數組的，那么如何得到這些數組呢?
在 selectImports 方法中調用了一個 getAutoConfigurationEntry() 方法。
由于篇幅問題我就不一一截圖了，我直接告訴你們調用鏈：在 `getAutoConfigurationEntry() -> getCandidateConfigurations() -> loadFactoryNames()``。
在這里 loadFactoryNames()方法傳入了 EnableAutoConfiguration.class 這個參數。先記住這個參數，等下會用到。
loadFactoryNames() 中關鍵的三步：
- 從當前項目的類路徑中獲取所有 META-INF/spring.factories 這個文件下的信息。
- 將上面獲取到的信息封裝成一個 Map 返回。
- 從返回的 Map 中通過剛才傳入的 EnableAutoConfiguration.class 參數，獲取該 key 下的所有值。
META-INF/spring.factories 探究
聽我這樣說完可能會有點懵，我們來看一下 META-INF/spring.factories 這類文件是什么就不懵了。當然在很多第三方依賴中都會有這個文件，一般每導入一個第三方的依賴，除了本身的jar包以外，還會有一個 xxx-spring-boot-autoConfigure，這個就是第三方依賴自己編寫的自動配置類。我們現在就以 spring-boot-autocongigure 這個依賴來說。
可以看到 EnableAutoConfiguration 下面有很多類，這些就是我們項目進行自動配置的類。
一句話：將類路徑下META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。
HttpEncodingAutoConfiguration
通過上面方式，所有的自動配置類就被導進主配置類中了。但是這么多的配置類，明顯有很多自動配置我們平常是沒有使用到的，沒理由全部都生效吧。
接下來我們以 HttpEncodingAutoConfiguration為例來看一個自動配置類是怎么工作的。為啥選這個類呢?主要是這個類比較的簡單典型。
先看一下該類標有的注解：
- @Configuration
- @EnableConfigurationProperties({HttpProperties.class})
- @ConditionalOnWebApplication(
- type = Type.SERVLET
- )
- @ConditionalOnClass({CharacterEncodingFilter.class})
- @ConditionalOnProperty(
- prefix = "spring.http.encoding",
- value = {"enabled"},
- matchIfMissing = true
- )
- public class HttpEncodingAutoConfiguration {
- }
- @Configuration：標記為配置類。
- @ConditionalOnWebApplication：web應用下才生效。
- @ConditionalOnClass：指定的類(依賴)存在才生效。
- @ConditionalOnProperty：主配置文件中存在指定的屬性才生效。
- @EnableConfigurationProperties({HttpProperties.class})：啟動指定類的ConfigurationProperties功能;將配置文件中對應的值和 HttpProperties 綁定起來;并把 HttpProperties 加入到 IOC 容器中。
因為@EnableConfigurationProperties({HttpProperties.class})把配置文件中的配置項與當前 HttpProperties 類綁定上了。
然后在HttpEncodingAutoConfiguration 中又引用了 HttpProperties ，所以最后就能在 HttpEncodingAutoConfiguration中使用配置文件中的值了。
最終通過 @Bean 和一些條件判斷往容器中添加組件，實現自動配置。(當然該Bean中屬性值是從 HttpProperties 中獲取)
HttpProperties
HttpProperties 通過 @ConfigurationProperties 注解將配置文件與自身屬性綁定。
所有在配置文件中能配置的屬性都是在 xxxProperties 類中封裝著;配置文件能配置什么就可以參照某個功能對應的這個屬性類。
- @ConfigurationProperties(
- prefix = "spring.http"
- )// 從配置文件中獲取指定的值和bean的屬性進行綁定
- public class HttpProperties {
- }
總結
- SpringBoot啟動會加載大量的自動配置類。
- 我們看需要的功能有沒有SpringBoot默認寫好的自動配置類。
- 我們再來看這個自動配置類中到底配置了那些組件(只要我們要用的組件有，我們就不需要再來配置了)。
- 給容器中自動配置類添加組件的時候，會從properties類中獲取某些屬性。我們就可以在配置文件中指定這些屬性的值。xxxAutoConfiguration：自動配置類給容器中添加組件。xxxProperties：封裝配置文件中相關屬性。
用心看的小伙伴應該發現了，其實很多需要待加載的類都放在類路徑下的META-INF/Spring.factories文件下，而不是直接寫死這代碼中，這樣做就可以很方便我們自己或第三方去z做擴展。
參考：
kil51.cn/JTg9D
blog.51cto.com/4247649/2118354
www.cnblogs.com/duanxz/p/3787757.html
www.jianshu.com/p/e22b9fef311c
blog.csdn.net/qq_26525215/article/details/53523970
http://www.woaijava.cc
本文轉載自微信公眾號「Java后端技術全棧」，可以通過以下二維碼關注。轉載本文請聯系Java后端技術全棧公眾號。
