spring boot啓動原理

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

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的神祕面紗,咱們要從這兩位開始就能夠了。web

1、SpringBootApplication背後的祕密redis

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

 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:sql

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

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

因此,若是咱們使用以下的SpringBoot啓動類,整個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。mybatis

一、@Configurationapp

     這裏的@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>

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

 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。

二、@ComponentScan

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

     咱們能夠經過basePackages等屬性來細粒度的定製@ComponentScan自動掃描的範圍,若是不指定,則默認Spring框架實現會從聲明@ComponentScan所在類的package進行掃描。

注:因此SpringBoot的啓動類最好是放在root package下,由於默認不指定basePackages。

三、@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容器。

2、深刻探索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配置以及複雜的依賴管理,讓開發人員能夠更加關注業務邏輯的開發。

 

 

轉載自:http://www.javashuo.com/article/p-wslrskye-gp.html

相關文章
相關標籤/搜索