Spring boot 啓動類源碼分析以及@EnableAutoConfiguration和@SpringBootApplication講解

對於任何一個Spring boot項目,都會用到下面的啓動類:

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

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

@SpringBooApplication源碼如下:

@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

所以,如果我們使用如下的SpringBoot啓動類,整個SpringBoot應用依然可以與之前的啓動類功能對等:
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

因此上面三個註解對等於@SpringBootConfiguration,所以直接寫@SpringBootConfiguration方便點,下面分別介紹一下這三個Annotation

@Configuration  可以參考@Configuration註解、@Bean註解以及配置自動掃描、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作爲一個複合Annotation,其自身定義關鍵信息如下

@Target(ElementType.TYPE)  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
@Inherited  
@Import({ EnableAutoConfigurationImportSelector.class,  
        AutoConfigurationPackages.Registrar.class })  
public @interface EnableAutoConfiguration {  
  
    /**  
     * Exclude specific auto-configuration classes such that they will never be applied.  
     * @return the classes to exclude  
     */  
    Class<?>[] exclude() default {};  
  
}

其中,最關鍵的要

@Import(EnableAutoConfigurationImportSelector.class),藉助EnableAutoConfigurationImportSelector

@EnableAutoConfiguration可以幫助SpringBoot應用將所有符合條件的@Configuration配置都加載到當前SpringBoot創建並使用的IoC容器。就像一隻“八爪魚”一樣,藉助於Spring框架原有的一個工具類:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自動配置功效才得以大功告成!




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

SpringFactoriesLoader屬於Spring框架私有的一種擴展方案,其主要功能就是從指定的配置文件META-INF/spring.factories加載配置。

public abstract class SpringFactoriesLoader {
    //...
    public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
        ...
    }
 
 
    public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
        ....
    }
}
配合@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容器。

EnableAutoConfigurationImportSelector 是一個DeferredImportSelector,由 spring boot autoconfigure 從版本1.3開始,提供用來處理EnableAutoConfiguration自動配置。

EnableAutoConfigurationImportSelector繼承自AutoConfigurationImportSelector,從 pring boot 1.5 以後,EnableAutoConfigurationImportSelector已經不再被建議使用,而是推薦使用 AutoConfigurationImportSelector。

Spring EnableAutoConfigurationImportSelector 是如何工作的 ?

Spring 工具類 ConfigurationClassParser 是如何工作的 ?

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

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




發佈了73 篇原創文章 · 獲贊 13 · 訪問量 10萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章