這樣講 SpringBoot 自動配置原理，你應該能明白了吧

你在我家門口發表於2019-05-23
Spring Boot

前言

小夥伴們是否想起曾經被 SSM 整合支配的恐懼？相信很多小夥伴都是有過這樣的經歷的，一大堆配置問題，各種排除掃描，匯入一個新的依賴又得新增新的配置。自從有了 SpringBoot 之後，咋們就起飛了！各種零配置開箱即用，而我們之所以開發起來能夠這麼爽，自動配置的功勞少不了，今天我們就一起來討論一下 SpringBoot 自動配置原理。

本文主要分為三大部分：

  1. SpringBoot 原始碼常用註解拾遺

  2. SpringBoot 啟動過程

  3. SpringBoot 自動配置原理

1. SpringBoot 原始碼常用註解拾遺

這部分主要講一下 SpringBoot 原始碼中經常使用到的註解，以掃清後面閱讀原始碼時候的障礙。

組合註解

當可能大量同時使用到幾個註解到同一個類上，就可以考慮將這幾個註解到別的註解上。被註解的註解我們就稱之為組合註解。

  • 元註解：可以註解到別的註解上的註解。

  • 組合註解：被註解的註解我們就稱之為組合註解。

@Value 【Spring 提供】

@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}) 的方式獲取全域性配置檔案中的指定配置項。

@ConfigurationProperties 【SpringBoot 提供】

如果我們需要取 N 個配置項，通過 @Value 的方式去配置項需要一個一個去取，這就顯得有點 low 了。我們可以使用 @ConfigurationProperties 。

標有 @ConfigurationProperties 的類的所有屬性和配置檔案中相關的配置項進行繫結。（預設從全域性配置檔案中獲取配置值），繫結之後我們就可以通過這個類去訪問全域性配置檔案中的屬性值了。

下面看一個例項：

  1. 在主配置檔案中新增如下配置
person.name=kundy 
person.age=13 
person.sex=male 
複製程式碼
  1. 建立配置類，由於篇幅問題這裡省略了 setter、getter 方法，但是實際開發中這個是必須的，否則無法成功注入。另外，@Component 這個註解也還是需要新增的。
@Component 
@ConfigurationProperties(prefix = "person") 
public class Person { 

private String name; 
private Integer age; 
private String sex; 

} 
複製程式碼

這裡 @ConfigurationProperties 有一個 prefix 引數，主要是用來指定該配置項在配置檔案中的字首。

  1. 測試，在 SpringBoot 環境中，編寫個測試方法，注入 Person 類，即可通過 Person 物件取到配置檔案的值。

@Import 【Spring 提供】

@Import 註解支援匯入普通 java 類，並將其宣告成一個bean。主要用於將多個分散的 java config 配置類融合成一個更大的 config 類。

  • @Import 註解在 4.2 之前只支援匯入配置類。

  • 在4.2之後 @Import 註解支援匯入普通的 java 類,並將其宣告成一個 bean。

**@Import 三種使用方式 **

  • 直接匯入普通的 Java 類。

  • 配合自定義的 ImportSelector 使用。

  • 配合 ImportBeanDefinitionRegistrar 使用。

1. 直接匯入普通的 Java 類

  1. 建立一個普通的 Java 類。
public class Circle { 

public void sayHi() { 
System.out.println("Circle sayHi()"); 
} 

} 
複製程式碼
  1. 建立一個配置類，裡面沒有顯式宣告任何的 Bean，然後將剛才建立的 Circle 匯入。
@Import({Circle.class}) 
@Configuration 
public class MainConfig { 

} 
複製程式碼
  1. 建立測試類。
public static void main(String[] args) { 

ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class); 
Circle circle = context.getBean(Circle.class); 
circle.sayHi(); 

} 
複製程式碼
  1. 執行結果：

Circle sayHi()

可以看到我們順利的從 IOC 容器中獲取到了 Circle 物件，證明我們在配置類中匯入的 Circle 類，確實被宣告為了一個 Bean。

2. 配合自定義的 ImportSelector 使用

ImportSelector 是一個介面，該介面中只有一個 selectImports 方法，用於返回全類名陣列。所以利用該特性我們可以給容器動態匯入 N 個 Bean。

  1. 建立普通 Java 類 Triangle。
public class Triangle { 

public void sayHi(){ 
System.out.println("Triangle sayHi()"); 
} 

}
複製程式碼
  1. 建立 ImportSelector 實現類，selectImports 返回 Triangle 的全類名。
public class MyImportSelector implements ImportSelector { 

@Override 
public String[] selectImports(AnnotationMetadata annotationMetadata) { 
return new String[]{"annotation.importannotation.waytwo.Triangle"}; 
} 

} 
複製程式碼
  1. 建立配置類，在原來的基礎上還匯入了 MyImportSelector。
@Import({Circle.class,MyImportSelector.class}) 
@Configuration 
public class MainConfigTwo { 

} 
複製程式碼
  1. 建立測試類
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(); 

} 
複製程式碼
  1. 執行結果：

Circle sayHi()

Triangle sayHi()

可以看到 Triangle 物件也被 IOC 容器成功的例項化出來了。

3. 配合 ImportBeanDefinitionRegistrar 使用

ImportBeanDefinitionRegistrar 也是一個介面，它可以手動註冊bean到容器中，從而我們可以對類進行個性化的定製。(需要搭配 @Import 與 @Configuration 一起使用。）

  1. 建立普通 Java 類 Rectangle。
public class Rectangle { 

public void sayHi() { 
System.out.println("Rectangle sayHi()"); 
} 

}
複製程式碼
  1. 建立 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); 
} 

} 
複製程式碼
  1. 建立配置類，匯入 MyImportBeanDefinitionRegistrar 類。
@Import({Circle.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class}) 
@Configuration 
public class MainConfigThree { 

} 
複製程式碼
  1. 建立測試類。
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(); 

} 
複製程式碼
  1. 執行結果

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()"); 
} 

} 
複製程式碼
  1. 建立 Condition 實現類，@Conditional 註解只有一個 Condition 型別的引數，Condition 是一個介面，該介面只有一個返回布林值的 matches() 方法，該方法返回 true 則條件成立，配置類生效。反之，則不生效。在該例子中我們直接返回 true。
public class MyCondition implements Condition { 

@Override 
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { 
return true; 
} 

} 
複製程式碼
  1. 建立配置類，可以看到該配置的 @Conditional 傳了我們剛才建立的 Condition 實現類進去，用作條件判斷。
@Configuration 
@Conditional(MyCondition.class) 
public class ConditionConfig { 

@Bean 
public ConditionBean conditionBean(){ 
return new ConditionBean(); 
} 

} 
複製程式碼
  1. 編寫測試方法。
public static void main(String[] args) { 

ApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class); 
ConditionBean conditionBean = context.getBean(ConditionBean.class); 
conditionBean.sayHi(); 

} 
複製程式碼
  1. 結果分析

因為 Condition 的 matches 方法直接返回了 true，配置類會生效，我們可以把 matches 改成返回 false，則配置類就不會生效了。

除了自定義 Condition，Spring 還為我們擴充套件了一些常用的 Condition。

擴充套件註解 作用
ConditionalOnBean 容器中存在指定 Bean，則生效。
ConditionalOnMissingBean 容器中不存在指定 Bean，則生效。
ConditionalOnClass 系統中有指定的類，則生效。
ConditionalOnMissingClass 系統中沒有指定的類，則生效。
ConditionalOnProperty 系統中指定的屬性是否有指定的值。
ConditionalOnWebApplication 當前是web環境，則生效。

2. 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) 這個方法。

1.png

上面的方法主要包括兩大步驟：

  • 建立 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 中獲取，從而達到啟動前後的各種定製操作。

3. 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：該註解表示這是一個 SpringBoot 的配置類，其實它就是一個 @Configuration 註解而已。

  • @ComponentScan：開啟元件掃描。

  • @EnableAutoConfiguration：從名字就可以看出來，就是這個類開啟自動配置的。嗯，自動配置的奧祕全都在這個註解裡面。

@EnableAutoConfiguration 註解

先看該註解是怎麼定義的：

@AutoConfigurationPackage 
@Import({AutoConfigurationImportSelector.class}) 
public @interface EnableAutoConfiguration { 
複製程式碼

@AutoConfigurationPackage

從字面意思理解就是自動配置包。點進去可以看到就是一個 @Import 註解：@Import({Registrar.class})，匯入了一個 Registrar 的元件。關於 @Import 的用法文章上面也有介紹哦。

我們在 Registrar 類中的 registerBeanDefinitions 方法上打上斷點，可以看到返回了一個包名，該包名其實就是主配置類所在的包。

1.png

一句話：@AutoConfigurationPackage 註解就是將主配置類（@SpringBootConfiguration標註的類）的所在包及下面所有子包裡面的所有元件掃描到Spring容器中。所以說，預設情況下主配置類包及子包以外的元件，Spring 容器是掃描不到的。

@Import({AutoConfigurationImportSelector.class})

該註解給當前配置類匯入另外的 N 個自動配置類。（該註解詳細用法上文有提及）。

配置類匯入規則

那具體的匯入規則是什麼呢？我們來看一下原始碼。在開始看原始碼之前，先囉嗦兩句。就像小馬哥說的，我們看原始碼不用全部都看，不用每一行程式碼都弄明白是什麼意思，我們只要抓住關鍵的地方就可以了。

我們知道 AutoConfigurationImportSelector 的 selectImports 就是用來返回需要匯入的元件的全類名陣列的，那麼如何得到這些陣列呢？

在 selectImports 方法中呼叫了一個 getAutoConfigurationEntry() 方法。

3.png

由於篇幅問題我就不一一截圖了，我直接告訴你們呼叫鏈：在 getAutoConfigurationEntry() -> getCandidateConfigurations() -> loadFactoryNames()。

在這裡 loadFactoryNames() 方法傳入了 EnableAutoConfiguration.class 這個引數。先記住這個引數，等下會用到。

4.png

loadFactoryNames() 中關鍵的三步：

  1. 從當前專案的類路徑中獲取所有 META-INF/spring.factories 這個檔案下的資訊。

  2. 將上面獲取到的資訊封裝成一個 Map 返回。

  3. 從返回的 Map 中通過剛才傳入的 EnableAutoConfiguration.class 引數，獲取該 key 下的所有值。

6.png

META-INF/spring.factories 探究

聽我這樣說完可能會有點懵，我們來看一下 META-INF/spring.factories 這類檔案是什麼就不懵了。當然在很多第三方依賴中都會有這個檔案，一般每匯入一個第三方的依賴，除了本身的jar包以外，還會有一個 xxx-spring-boot-autoConfigure，這個就是第三方依賴自己編寫的自動配置類。我們現在就以 spring-boot-autocongigure 這個依賴來說。

8.png

可以看到 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 { 
複製程式碼

小結：

  1. SpringBoot啟動會載入大量的自動配置類。

  2. 我們看需要的功能有沒有SpringBoot預設寫好的自動配置類。

  3. 我們再來看這個自動配置類中到底配置了那些元件（只要我們要用的元件有，我們就不需要再來配置了）。

  4. 給容器中自動配置類新增元件的時候，會從properties類中獲取某些屬性。我們就可以在配置檔案中指定這些屬性的值。

  • xxxAutoConfiguration：自動配置類給容器中新增元件。

  • xxxProperties：封裝配置檔案中相關屬性。

不知道小夥伴們有沒有發現，很多需要待載入的類都放在類路徑下的META-INF/Spring.factories 檔案下，而不是直接寫死這程式碼中，這樣做就可以很方便我們自己或者是第三方去擴充套件，我們也可以實現自己 starter，讓SpringBoot 去載入。現在明白為什麼 SpringBoot 可以實現零配置，開箱即用了吧！

最後

文章有點長，感謝大家的閱讀！覺得不錯可以點個贊哦！

參考文章:

- blog.51cto.com/4247649/211…

- www.cnblogs.com/duanxz/p/37…

- www.jianshu.com/p/e22b9fef3…

- blog.csdn.net/qq_26525215…

相關文章