spring boot:啓動原理解析

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

 @SpringBootApplication
 public class Application {
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
 }

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

一、SpringBootApplication背後的祕密

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
...
}

雖然定義使用了多個Annotation進行了原信息標註,但實際上重要的只有三個Annotation:

  • @Configuration(@SpringBootConfiguration點開查看發現裏面還是應用了@Configuration)
  • @EnableAutoConfiguration
  • @ComponentScan

@SpringBootApplication = (默認屬性)@Configuration + @EnableAutoConfiguration + @ComponentScan。

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

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

每次寫這3個比較累,所以寫一個@SpringBootApplication方便點。接下來分別介紹這3個Annotation。

1、@Configuration

     這裏的@Configuration對我們來說不陌生,它就是JavaConfig形式的Spring Ioc容器的配置類使用的那個@Configuration,SpringBoot社區推薦使用基於JavaConfig的配置形式,所以,這裏的啓動類標註了@Configuration之後,本身其實也是一個IoC容器的配置類。

舉幾個簡單例子回顧下,

XML跟config配置方式的區別:

(1)表達形式層面

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

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

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

@Configuration
public class MockConfiguration{
     //bean定義
 }

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

(2)註冊bean定義層面

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

<bean id="mockService" class="..MockServiceImpl">
    ...
</bean>

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

@Configuration
public class MockConfiguration{
    @Bean
    public MockService mockService(){
        return new MockServiceImpl();
    }
}

任何一個標註了@Bean的方法,其返回值將作爲一個bean定義註冊到Spring的IoC容器,方法名將默認成該bean定義的id

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

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

<bean id="mockService" class="..MockServiceImpl">
    <propery name ="dependencyService" ref="dependencyService" />
</bean>

<bean id="dependencyService" class="DependencyServiceImpl"></bean>

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

@Configuration
public class MockConfiguration{
    @Bean
    public MockService mockService(){
        return new MockServiceImpl(dependencyService());
    }
    
    @Bean
    public DependencyService dependencyService(){
        return new DependencyServiceImpl();
    }
}

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


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

<beans> 
    <bean id = "car" class="com.test.Car"> 
        <property name="wheel" ref = "wheel"></property> 
    </bean> 
    <bean id = "wheel" class="com.test.Wheel"></bean> 
</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進行自動配置。

 @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可以智能的自動配置功效才得以大功告成!

自動配置幕後英雄: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類。

上圖就是從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()方法,只不過這種情況下會將異常信息一併傳入處理)

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


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

總覽:    

    上圖爲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所在的包路徑下文件,所以最好將該啓動類放到根包路徑下。

SpringBoot啓動類

首先進入run方法

run方法中去創建了一個SpringApplication實例,在該構造方法內,我們可以發現其調用了一個初始化的initialize方法

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

該方法中實現瞭如下幾個關鍵步驟:

1.創建了應用的監聽器SpringApplicationRunListeners並開始監聽

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

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

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

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

方法會先獲取顯式設置的應用上下文(applicationContextClass),如果不存在,再加載默認的環境配置(通過是否是web environment判斷),默認選擇AnnotationConfigApplicationContext註解上下文(通過掃描所有註解類來加載bean),最後通過BeanUtils實例化上下文對象,並返回。

ConfigurableApplicationContext類圖如下:

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

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的實例化等核心工作。

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


自動化配置:

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

SpringBoot自動配置模塊

    該配置模塊的主要使用到了SpringFactoriesLoader,即Spring工廠加載器,該對象提供了loadFactoryNames方法,入參爲factoryClass和classLoader,即需要傳入上圖中的工廠類名稱和對應的類加載器,方法會根據指定的classLoader,加載該類加器搜索路徑下的指定文件,即spring.factories文件,傳入的工廠類爲接口,而文件中對應的類則是接口的實現類,或最終作爲實現類,所以文件中一般爲如下圖這種一對多的類名集合,獲取到這些實現類的類名後,loadFactoryNames方法返回類名集合,方法調用方得到這些集合後,再通過反射獲取這些類的類對象、構造方法,最終生成實例。

工廠接口與其若干實現類接口名稱

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

SpringBoot自動化配置關鍵組件關係圖 

    mybatis-spring-boot-starter、spring-boot-starter-web等組件的META-INF文件下均含有spring.factories文件,自動配置模塊中,SpringFactoriesLoader收集到文件中的類全名並返回一個類全名的數組,返回的類全名通過反射被實例化,就形成了具體的工廠實例,工廠實例來生成組件具體需要的bean。

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

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

    該方法在springboot啓動流程——bean實例化前被執行,返回要實例化的類信息列表。我們知道,如果獲取到類信息,spring自然可以通過類加載器將類加載到jvm中,現在我們已經通過spring-boot的starter依賴方式依賴了我們需要的組件,那麼這些組建的類信息在select方法中也是可以被獲取到的,不要急我們繼續向下分析。

該方法中的getCandidateConfigurations方法,通過方法註釋瞭解到,其返回一個自動配置類的類名列表,方法調用了loadFactoryNames方法,查看該方法

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

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

發現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)如下:

這裏是截取的mybatis-spring-boot-starter的源碼中pom.xml文件中所有依賴:

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

 

 參考鏈接:https://www.cnblogs.com/xiaoxi/p/7999885.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章