Spring Boot(十四):啓動類原理解析

1、啓動類簡介java

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

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

2、SpringBootApplication背後的祕密spring

@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:app

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

因此,若是咱們使用以下的SpringBoot啓動類,整個SpringBoot應用依然能夠與以前的啓動類功能對等:框架

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

寫三個比較累,因此寫一個@SpringBootApplication比較方便。工具

3、@Configurationspa

這裏的@Configuration對咱們來講並不陌生,它就是JavaConfig形式的Spring IOC容器的配置類使用的那個@Configuration,SpringBoot社區推薦使用基於JavaConfig的配置形式,因此,這裏的啓動類標註了@Configuration以後,自己其實也是一個IOC容器的配置類。3d

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

一、表達形式層面xml

基於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配置類。

二、註冊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。

三、表達依賴注入關係層面

爲了表達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的建立方法就能夠了。

4、@ComponentScan

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

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

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

5、@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,其自身定義關鍵信息以下:

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

其中,最關鍵的要屬@Import(EnableAutoConfigurationImportSelector.class), 藉助 EnableAutoConfigurationImportSelector,將@EnableAutoConfiguration能夠幫助SpringBoot應用將全部符合條件的@Configuration配置都加載到當前SpringBoot建立並使用的IOC容器。  就像一隻「八爪魚」同樣,藉助於Spring框架原有的一個工具類:SpringFacoriesLoader的支持, @EnableAutoConfiguration能夠智能的自動配置功效才得以大功告成!

6、自動配置幕後英雄: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 對應的配置項經過反射實例化對應的標註了@Configuration的JavaConfig形式的IOC容器配置類,而後彙總爲一個並加載到IOC容器。

7、深刻探索SpringApplication執行流程

SpringApplication的run方法的實現是咱們本次旅程的主要線路,該方法的主要流程大致能夠概括以下:

一、若是咱們使用的是 SpringApplication 的靜態run方法,那麼,這個方法裏面首先要建立一個 SpringApplication 對象實例,而後調用這個建立好的 SpringApplication 的實例方法。在 SpringApplication 實例初始化的時候,它會提早作幾件事情:

  • 根據classpath裏面是否存在某個特徵類(org.springframework.web.context.ConfigurableWebApplicationContext)來決定是否應該建立一個爲Web應用使用的ApplicationContext類型。
  • 使用SpringFactoriesLoader在應用的classpath中查找並加載全部可用的 ApplicationContextInitialize。
  • 使用SpringFactoriesLoader在應用的classpath中查找並加載全部可用的ApplicationListener。
  • 推斷並設置main方法的定義類。

二、SpringApplication實例初始化完成而且完成設置後,就開始執行run方法的邏輯了,方法執行伊始,首先遍歷執行全部經過SpringFactoriesLoader能夠查找並加載的 SpringApplicationRunListene。調用它們的started()方法,告訴這些 SpringApplicationRunListener,「嘿,SpringBoot應用要開始執行咯!」。

三、建立並配置當前SpringBoot應用將要使用的environment(包括配置要使用的propertySource以及Profile)。

四、遍歷調用全部 SpringApplicationRunListener 的environmentPrepared()方法,告訴他們: 「當前SpringBoot應用使用的Environment準備好了咯!」。

五、若是SpringApplication的showBanner屬性被設置爲true,則打印banner。

六、根據用戶是否明確設置了 applicationContextClass類型以及初始化階段的推斷結果,決定該位當前SpringBoot應用建立什麼類型的ApplicationContext並建立完成,而後根據條件決定是否添加 ShutdownHook ,決定是否使用自定義的BeanNameGenerator,決定是否使用自定義的ResourceLoader,固然,最重要的,將以前準備好的Environment設置給建立好的ApplicationContext使用。

七、ApplicationContext建立好以後,SpringApplication會再次藉助Spring-FactoriesLoader,查找並加載classpath中全部可用的ApplicationContext-Initializer,而後遍歷調用這些ApplicationContextInitializer的initialize(applicationContext)方法來對已經建立好的ApplicationContext進行進一步的處理。

八、遍歷調用全部SpringApplicationRunListener的contextPrepared()方法。

九、最核心的一步,將以前經過@EnableAutoConfiguration獲取的全部配置以及其餘形式的IoC容器配置加載到已經準備完畢的ApplicationContext。

十、遍歷調用全部 SpringApplicationRunListener的contextLoaded()方法。

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

十二、查找當前ApplicationContext中是否註冊有CommandLineRunner,若是有,則遍歷執行它們。 

1三、正常狀況下,遍歷執行SpringApplicationRunListener的finished()方法、(若是整個過程出現異常,則依然調用全部SpringApplicationRunListener的finished()方法,只不過這種狀況下會將異常信息一併傳入處理)
去除事件通知點後,整個流程以下:

8、總結

到此,SpringBoot的核心組件完成了基本的解析,綜合來看,大部分都是Spring框架背後的一些概念和實踐方式,SpringBoot只是在這些概念和實踐上對特定的場景事先進行了固化和昇華,而也偏偏是這些固化讓咱們開發基於Sping框架的應用更加方便高效。

相關文章
相關標籤/搜索