SpringBoot啟動流程解析

weixin_34148340發表於2018-02-28

寫在前面:

       由於該系統是底層系統,以微服務形式對外暴露dubbo服務,所以本流程中SpringBoot不基於jetty或者tomcat等容器啟動方式釋出服務,而是以執行程式方式啟動來發布(參考下圖keepRunning方法)。

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

6912735-51aa162747fcdc3d.png

總覽:

上圖為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所在的包路徑下檔案,所以最好將該啟動類放到根包路徑下

6912735-562d54f82e0ac2f4.png

SpringBoot啟動類

首先進入run方法

6912735-4eb0133161fa8425.png

run方法中去建立了一個SpringApplication例項,在該構造方法內,我們可以發現其呼叫了一個初始化的initialize方法

6912735-fdf3c64061ff1579.png
6912735-df6b3e65677fbb37.png

這裡主要是為SpringApplication物件賦一些初值。建構函式執行完畢後,我們回到run方法

6912735-b1512831c3402b11.png

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

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

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

6912735-27b75b10640f652e.png

可以看出,*Environment最終都實現了PropertyResolver介面,我們平時通過environment物件獲取配置檔案中指定Key對應的value方法時,就是呼叫了propertyResolver介面的getProperty方法

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

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

6912735-663a530bd3ebd142.png

方法會先獲取顯式設定的應用上下文(applicationContextClass),如果不存在,再載入預設的環境配置(通過是否是web environment判斷),預設選擇AnnotationConfigApplicationContext註解上下文(通過掃描所有註解類來載入bean),最後通過BeanUtils例項化上下文物件,並返回,ConfigurableApplicationContext類圖如下:

6912735-797f3d2c57b625bc.png

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

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

6912735-32afb038ad587cb2.png

refresh方法

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

自動化配置:

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

6912735-8f2374a500b07c6d.png

SpringBoot自動配置模組

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

6912735-71e4d0e8cda64ee7.png

工廠介面與其若干實現類介面名稱

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

6912735-95d1af756cee57ad.png

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

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

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

6912735-577bc78a48cea9ef.png

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

6912735-05843dc2de08fefe.png

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

6912735-1acb163dede80c03.png

該方法中的getCandidateConfigurations方法,通過方法註釋瞭解到,其返回一個自動配置類的類名列表,方法呼叫了loadFactoryNames方法,檢視該方法

6912735-0398d3354e6b91d1.png

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

6912735-84f04d5605c8a185.png

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

6912735-d836df5a3ae71c08.png

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

6912735-b616bb63af52b5dd.png

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

6912735-eeed64900a5e35c5.png

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

作者:jianshu_tr

連結:https://www.jianshu.com/p/87f101d8ec41

來源:簡書

著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。

相關文章