天天看點

spring boot(二):啟動原了解析

我們開發任何一個Spring Boot項目,都會用到如下的啟動類

1 @SpringBootApplication
2 public class Application {
3     public static void main(String[] args) {
4         SpringApplication.run(Application.class, args);
5     }
6 }      

從上面代碼可以看出,Annotation定義(@SpringBootApplication)和類定義(SpringApplication.run)最為耀眼,是以要揭開SpringBoot的神秘面紗,我們要從這兩位開始就可以了。

一、SpringBootApplication背後的秘密

@SpringBootApplication注解是Spring Boot的核心注解,它其實是一個組合注解:

1 @Target(ElementType.TYPE)
 2 @Retention(RetentionPolicy.RUNTIME)
 3 @Documented
 4 @Inherited
 5 @SpringBootConfiguration
 6 @EnableAutoConfiguration
 7 @ComponentScan(excludeFilters = {
 8         @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
 9         @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
10 public @interface SpringBootApplication {
11 ...
12 }      

雖然定義使用了多個Annotation進行了原資訊标注,但實際上重要的隻有三個Annotation:

  • @Configuration(@SpringBootConfiguration點開檢視發現裡面還是應用了@Configuration)
  • @EnableAutoConfiguration
  • @ComponentScan

即 @SpringBootApplication = (預設屬性)@Configuration + @EnableAutoConfiguration + @ComponentScan。

是以,如果我們使用如下的SpringBoot啟動類,整個SpringBoot應用依然可以與之前的啟動類功能對等:

1 @Configuration
2 @EnableAutoConfiguration
3 @ComponentScan
4 public class Application {
5     public static void main(String[] args) {
6         SpringApplication.run(Application.class, args);
7     }
8 }      

每次寫這3個比較累,是以寫一個@SpringBootApplication友善點。接下來分别介紹這3個Annotation。

1、@Configuration

     這裡的@Configuration對我們來說不陌生,它就是JavaConfig形式的Spring Ioc容器的配置類使用的那個@Configuration,SpringBoot社群推薦使用基于JavaConfig的配置形式,是以,這裡的啟動類标注了@Configuration之後,本身其實也是一個IoC容器的配置類。

舉幾個簡單例子回顧下,XML跟config配置方式的差別:

(1)表達形式層面

基于XML配置的方式是這樣:

1 <?xml version="1.0" encoding="UTF-8"?>
2 <beans xmlns="http://www.springframework.org/schema/beans"
3        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"
5        default-lazy-init="true">
6     <!--bean定義-->
7 </beans>      

而基于JavaConfig的配置方式是這樣:

1 @Configuration
2 public class MockConfiguration{
3     //bean定義
4 }      

任何一個标注了@Configuration的Java類定義都是一個JavaConfig配置類。

(2)注冊bean定義層面

基于XML的配置形式是這樣:

1 <bean id="mockService" class="..MockServiceImpl">
2     ...
3 </bean>      

而基于JavaConfig的配置形式是這樣的:

1 @Configuration
2 public class MockConfiguration{
3     @Bean
4     public MockService mockService(){
5         return new MockServiceImpl();
6     }
7 }      

任何一個标注了@Bean的方法,其傳回值将作為一個bean定義注冊到Spring的IoC容器,方法名将預設成該bean定義的id。

(3)表達依賴注入關系層面

為了表達bean與bean之間的依賴關系,在XML形式中一般是這樣:

1 <bean id="mockService" class="..MockServiceImpl">
2     <propery name ="dependencyService" ref="dependencyService" />
3 </bean>
4 
5 <bean id="dependencyService" class="DependencyServiceImpl"></bean>      
1 @Configuration
 2 public class MockConfiguration{
 3     @Bean
 4     public MockService mockService(){
 5         return new MockServiceImpl(dependencyService());
 6     }
 7     
 8     @Bean
 9     public DependencyService dependencyService(){
10         return new DependencyServiceImpl();
11     }
12 }      

如果一個bean的定義依賴其他bean,則直接調用對應的JavaConfig類中依賴bean的建立方法就可以了。

@Configuration:提到@Configuration就要提到他的搭檔@Bean。使用這兩個注解就可以建立一個簡單的spring配置類,可以用來替代相應的xml配置檔案。

1 <beans> 
2     <bean id = "car" class="com.test.Car"> 
3         <property name="wheel" ref = "wheel"></property> 
4     </bean> 
5     <bean id = "wheel" class="com.test.Wheel"></bean> 
6 </beans>      

相當于:

1 @Configuration 
 2 public class Conf { 
 3     @Bean 
 4     public Car car() { 
 5         Car car = new Car(); 
 6         car.setWheel(wheel()); 
 7         return car; 
 8     }
 9     
10     @Bean 
11     public Wheel wheel() { 
12         return new Wheel(); 
13     } 
14 }      

@Configuration的注解類辨別這個類可以使用Spring IoC容器作為bean定義的來源。

@Bean注解告訴Spring,一個帶有@Bean的注解方法将傳回一個對象,該對象應該被注冊為在Spring應用程式上下文中的bean。

2、@ComponentScan

     @ComponentScan這個注解在Spring中很重要,它對應XML配置中的元素,@ComponentScan的功能其實就是自動掃描并加載符合條件的元件(比如@Component和@Repository等)或者bean定義,最終将這些bean定義加載到IoC容器中。

     我們可以通過basePackages等屬性來細粒度的定制@ComponentScan自動掃描的範圍,如果不指定,則預設Spring架構實作會從聲明@ComponentScan所在類的package進行掃描。

注:是以SpringBoot的啟動類最好是放在root package下,因為預設不指定basePackages。

3、@EnableAutoConfiguration

    個人感覺@EnableAutoConfiguration這個Annotation最為重要,是以放在最後來解讀,大家是否還記得Spring架構提供的各種名字為@Enable開頭的Annotation定義?比如@EnableScheduling、@EnableCaching、@EnableMBeanExport等,@EnableAutoConfiguration的理念和做事方式其實一脈相承,簡單概括一下就是,借助@Import的支援,收集和注冊特定場景相關的bean定義。

  • @EnableScheduling是通過@Import将Spring排程架構相關的bean定義都加載到IoC容器。
  • @EnableMBeanExport是通過@Import将JMX相關的bean定義加載到IoC容器。

而@EnableAutoConfiguration也是借助@Import的幫助,将所有符合自動配置條件的bean定義加載到IoC容器,僅此而已!

    @EnableAutoConfiguration會根據類路徑中的jar依賴為項目進行自動配置,如:添加了spring-boot-starter-web依賴,會自動添加Tomcat和Spring MVC的依賴,Spring Boot會對Tomcat和Spring MVC進行自動配置。

spring boot(二):啟動原了解析

 @EnableAutoConfiguration作為一個複合Annotation,其自身定義關鍵資訊如下:

1 @SuppressWarnings("deprecation")
 2 @Target(ElementType.TYPE)
 3 @Retention(RetentionPolicy.RUNTIME)
 4 @Documented
 5 @Inherited
 6 @AutoConfigurationPackage
 7 @Import(EnableAutoConfigurationImportSelector.class)
 8 public @interface EnableAutoConfiguration {
 9     ...
10 }      

    其中,最關鍵的要屬@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以幫助SpringBoot應用将所有符合條件的@Configuration配置都加載到目前SpringBoot建立并使用的IoC容器。就像一隻“八爪魚”一樣,借助于Spring架構原有的一個工具類:SpringFactoriesLoader的支援,@EnableAutoConfiguration可以智能的自動配置功效才得以大功告成!

spring boot(二):啟動原了解析

自動配置幕後英雄:SpringFactoriesLoader詳解

SpringFactoriesLoader屬于Spring架構私有的一種擴充方案,其主要功能就是從指定的配置檔案META-INF/spring.factories加載配置。

1 public abstract class SpringFactoriesLoader {
 2     //...
 3     public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
 4         ...
 5     }
 6 
 7 
 8     public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
 9         ....
10     }
11 }      

配合@EnableAutoConfiguration使用的話,它更多是提供一種配置查找的功能支援,即根據@EnableAutoConfiguration的完整類名org.springframework.boot.autoconfigure.EnableAutoConfiguration作為查找的Key,擷取對應的一組@Configuration類。

spring boot(二):啟動原了解析

上圖就是從SpringBoot的autoconfigure依賴包中的META-INF/spring.factories配置檔案中摘錄的一段内容,可以很好地說明問題。

是以,@EnableAutoConfiguration自動配置的魔法騎士就變成了:從classpath中搜尋所有的META-INF/spring.factories配置檔案,并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration對應的配置項通過反射(Java Refletion)執行個體化為對應的标注了@Configuration的JavaConfig形式的IoC容器配置類,然後彙總為一個并加載到IoC容器。

二、深入探索SpringApplication執行流程

SpringApplication的run方法的實作是我們本次旅程的主要線路,該方法的主要流程大體可以歸納如下:

1) 如果我們使用的是SpringApplication的靜态run方法,那麼,這個方法裡面首先要建立一個SpringApplication對象執行個體,然後調用這個建立好的SpringApplication的執行個體方法。在SpringApplication執行個體初始化的時候,它會提前做幾件事情:

  • 根據classpath裡面是否存在某個特征類(org.springframework.web.context.ConfigurableWebApplicationContext)來決定是否應該建立一個為Web應用使用的ApplicationContext類型。
  • 使用SpringFactoriesLoader在應用的classpath中查找并加載所有可用的ApplicationContextInitializer。
  • 使用SpringFactoriesLoader在應用的classpath中查找并加載所有可用的ApplicationListener。
  • 推斷并設定main方法的定義類。

2) SpringApplication執行個體初始化完成并且完成設定後,就開始執行run方法的邏輯了,方法執行伊始,首先周遊執行所有通過SpringFactoriesLoader可以查找到并加載的SpringApplicationRunListener。調用它們的started()方法,告訴這些SpringApplicationRunListener,“嘿,SpringBoot應用要開始執行咯!”。

3) 建立并配置目前Spring Boot應用将要使用的Environment(包括配置要使用的PropertySource以及Profile)。

4) 周遊調用所有SpringApplicationRunListener的environmentPrepared()的方法,告訴他們:“目前SpringBoot應用使用的Environment準備好了咯!”。

5) 如果SpringApplication的showBanner屬性被設定為true,則列印banner。

6) 根據使用者是否明确設定了applicationContextClass類型以及初始化階段的推斷結果,決定該為目前SpringBoot應用建立什麼類型的ApplicationContext并建立完成,然後根據條件決定是否添加ShutdownHook,決定是否使用自定義的BeanNameGenerator,決定是否使用自定義的ResourceLoader,當然,最重要的,将之前準備好的Environment設定給建立好的ApplicationContext使用。

7) ApplicationContext建立好之後,SpringApplication會再次借助Spring-FactoriesLoader,查找并加載classpath中所有可用的ApplicationContext-Initializer,然後周遊調用這些ApplicationContextInitializer的initialize(applicationContext)方法來對已經建立好的ApplicationContext進行進一步的處理。

8) 周遊調用所有SpringApplicationRunListener的contextPrepared()方法。

9) 最核心的一步,将之前通過@EnableAutoConfiguration擷取的所有配置以及其他形式的IoC容器配置加載到已經準備完畢的ApplicationContext。

10) 周遊調用所有SpringApplicationRunListener的contextLoaded()方法。

11) 調用ApplicationContext的refresh()方法,完成IoC容器可用的最後一道工序。

12) 查找目前ApplicationContext中是否注冊有CommandLineRunner,如果有,則周遊執行它們。

13) 正常情況下,周遊執行SpringApplicationRunListener的finished()方法、(如果整個過程出現異常,則依然調用所有SpringApplicationRunListener的finished()方法,隻不過這種情況下會将異常資訊一并傳入處理)

去除事件通知點後,整個流程如下:

spring boot(二):啟動原了解析

本文以調試一個實際的SpringBoot啟動程式為例,參考流程中主要類類圖,來分析其啟動邏輯和自動化配置原理。

spring boot(二):啟動原了解析

總覽:    

    上圖為SpringBoot啟動結構圖,我們發現啟動流程主要分為三個部分,第一部分進行SpringApplication的初始化子產品,配置一些基本的環境變量、資源、構造器、監聽器,第二部分實作了應用具體的啟動方案,包括啟動流程的監聽子產品、加載配置環境子產品、及核心的建立上下文環境子產品,第三部分是自動化配置子產品,該子產品作為springboot自動配置核心,在後面的分析中會詳細讨論。在下面的啟動程式中我們會串聯起結構中的主要功能。

啟動:

     每個SpringBoot程式都有一個主入口,也就是main方法,main裡面調用SpringApplication.run()啟動整個spring-boot程式,該方法所在類需要使用@SpringBootApplication注解,以及@ImportResource注解(if need),@SpringBootApplication包括三個注解,功能如下:

@EnableAutoConfiguration:SpringBoot根據應用所聲明的依賴來對Spring架構進行自動配置。

@SpringBootConfiguration(内部為@Configuration):被标注的類等于在spring的XML配置檔案中(applicationContext.xml),裝配所有bean事務,提供了一個spring的上下文環境。

@ComponentScan:元件掃描,可自動發現和裝配Bean,預設掃描SpringApplication的run方法裡的Booter.class所在的包路徑下檔案,是以最好将該啟動類放到根包路徑下。

spring boot(二):啟動原了解析

SpringBoot啟動類

首先進入run方法

spring boot(二):啟動原了解析

run方法中去建立了一個SpringApplication執行個體,在該構造方法内,我們可以發現其調用了一個初始化的initialize方法

spring boot(二):啟動原了解析
spring boot(二):啟動原了解析

這裡主要是為SpringApplication對象賦一些初值。構造函數執行完畢後,我們回到run方法

spring boot(二):啟動原了解析

該方法中實作了如下幾個關鍵步驟:

1.建立了應用的監聽器SpringApplicationRunListeners并開始監聽

2.加載SpringBoot配置環境(ConfigurableEnvironment),如果是通過web容器釋出,會加載StandardEnvironment,其最終也是繼承了ConfigurableEnvironment,類圖如下

spring boot(二):啟動原了解析

可以看出,*Environment最終都實作了PropertyResolver接口,我們平時通過environment對象擷取配置檔案中指定Key對應的value方法時,就是調用了propertyResolver接口的getProperty方法

3.配置環境(Environment)加入到監聽器對象中(SpringApplicationRunListeners)

4.建立run方法的傳回對象:ConfigurableApplicationContext(應用配置上下文),我們可以看一下建立方法:

spring boot(二):啟動原了解析

方法會先擷取顯式設定的應用上下文(applicationContextClass),如果不存在,再加載預設的環境配置(通過是否是web environment判斷),預設選擇AnnotationConfigApplicationContext注解上下文(通過掃描所有注解類來加載bean),最後通過BeanUtils執行個體化上下文對象,并傳回。

ConfigurableApplicationContext類圖如下:

spring boot(二):啟動原了解析

主要看其繼承的兩個方向:

LifeCycle:生命周期類,定義了start啟動、stop結束、isRunning是否運作中等生命周期空值方法

ApplicationContext:應用上下文類,其主要繼承了beanFactory(bean的工廠類)

5.回到run方法内,prepareContext方法将listeners、environment、applicationArguments、banner等重要元件與上下文對象關聯

6.接下來的refreshContext(context)方法(初始化方法如下)将是實作spring-boot-starter-*(mybatis、redis等)自動化配置的關鍵,包括spring.factories的加載,bean的執行個體化等核心工作。

spring boot(二):啟動原了解析

     配置結束後,Springboot做了一些基本的收尾工作,傳回了應用環境上下文。回顧整體流程,Springboot的啟動,主要建立了配置環境(environment)、事件監聽(listeners)、應用上下文(applicationContext),并基于以上條件,在容器中開始執行個體化我們需要的Bean,至此,通過SpringBoot啟動的程式已經構造完成,接下來我們來探讨自動化配置是如何實作。

自動化配置:

之前的啟動結構圖中,我們注意到無論是應用初始化還是具體的執行過程,都調用了SpringBoot自動配置子產品。

spring boot(二):啟動原了解析

SpringBoot自動配置子產品

    該配置子產品的主要使用到了SpringFactoriesLoader,即Spring工廠加載器,該對象提供了loadFactoryNames方法,入參為factoryClass和classLoader,即需要傳入上圖中的工廠類名稱和對應的類加載器,方法會根據指定的classLoader,加載該類加器搜尋路徑下的指定檔案,即spring.factories檔案,傳入的工廠類為接口,而檔案中對應的類則是接口的實作類,或最終作為實作類,是以檔案中一般為如下圖這種一對多的類名集合,擷取到這些實作類的類名後,loadFactoryNames方法傳回類名集合,方法調用方得到這些集合後,再通過反射擷取這些類的類對象、構造方法,最終生成執行個體。

spring boot(二):啟動原了解析

工廠接口與其若幹實作類接口名稱

下圖有助于我們形象了解自動配置流程。

spring boot(二):啟動原了解析

SpringBoot自動化配置關鍵元件關系圖 

    mybatis-spring-boot-starter、spring-boot-starter-web等元件的META-INF檔案下均含有spring.factories檔案,自動配置子產品中,SpringFactoriesLoader收集到檔案中的類全名并傳回一個類全名的數組,傳回的類全名通過反射被執行個體化,就形成了具體的工廠執行個體,工廠執行個體來生成元件具體需要的bean。

之前我們提到了EnableAutoConfiguration注解,其類圖如下:

spring boot(二):啟動原了解析

可以發現其最終實作了ImportSelector(選擇器)和BeanClassLoaderAware(bean類加載器中間件),重點關注一下AutoConfigurationImportSelector的selectImports方法。

spring boot(二):啟動原了解析

    該方法在springboot啟動流程——bean執行個體化前被執行,傳回要執行個體化的類資訊清單。我們知道,如果擷取到類資訊,spring自然可以通過類加載器将類加載到jvm中,現在我們已經通過spring-boot的starter依賴方式依賴了我們需要的元件,那麼這些組建的類資訊在select方法中也是可以被擷取到的,不要急我們繼續向下分析。

spring boot(二):啟動原了解析

該方法中的getCandidateConfigurations方法,通過方法注釋了解到,其傳回一個自動配置類的類名清單,方法調用了loadFactoryNames方法,檢視該方法

spring boot(二):啟動原了解析

    在上面的代碼可以看到自動配置器會根據傳入的factoryClass.getName()到項目系統路徑下所有的spring.factories檔案中找到相應的key,進而加載裡面的類。我們就選取這個mybatis-spring-boot-autoconfigure下的spring.factories檔案

spring boot(二):啟動原了解析

進入org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration中,主要看一下類頭:

spring boot(二):啟動原了解析

發現Spring的@Configuration,俨然是一個通過注解标注的springBean,繼續向下看,

@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class})這個注解的意思是:當存在SqlSessionFactory.class, SqlSessionFactoryBean.class這兩個類時才解析MybatisAutoConfiguration配置類,否則不解析這一個配置類,make sence,我們需要mybatis為我們傳回會話對象,就必須有會話工廠相關類。

@CondtionalOnBean(DataSource.class):隻有處理已經被聲明為bean的dataSource。

@ConditionalOnMissingBean(MapperFactoryBean.class)這個注解的意思是如果容器中不存在name指定的bean則建立bean注入,否則不執行(該類源碼較長,篇幅限制不全粘貼)

     以上配置可以保證sqlSessionFactory、sqlSessionTemplate、dataSource等mybatis所需的元件均可被自動配置,@Configuration注解已經提供了Spring的上下文環境,是以以上元件的配置方式與Spring啟動時通過mybatis.xml檔案進行配置起到一個效果。通過分析我們可以發現,隻要一個基于SpringBoot項目的類路徑下存在SqlSessionFactory.class, SqlSessionFactoryBean.class,并且容器中已經注冊了dataSourceBean,就可以觸發自動化配置,意思說我們隻要在maven的項目中加入了mybatis所需要的若幹依賴,就可以觸發自動配置,但引入mybatis原生依賴的話,每內建一個功能都要去修改其自動化配置類,那就得不到開箱即用的效果了。是以Spring-boot為我們提供了統一的starter可以直接配置好相關的類,觸發自動配置所需的依賴(mybatis)如下:

spring boot(二):啟動原了解析

這裡是截取的mybatis-spring-boot-starter的源碼中pom.xml檔案中所有依賴:

spring boot(二):啟動原了解析

 因為maven依賴的傳遞性,我們隻要依賴starter就可以依賴到所有需要自動配置的類,實作開箱即用的功能。也展現出Springboot簡化了Spring架構帶來的大量XML配置以及複雜的依賴管理,讓開發人員可以更加關注業務邏輯的開發。