springboot之啟動原理解析

weixin_33686714發表於2018-04-27
Spring Boot

本文轉載自：https://www.cnblogs.com/shamo89/p/8184960.html

前言

SpringBoot為我們做的自動配置，確實方便快捷，但是對於新手來說，如果不大懂SpringBoot內部啟動原理，以後難免會吃虧。所以這次博主就跟你們一起一步步揭開SpringBoot的神祕面紗，讓它不在神祕。

正文

我們開發任何一個Spring Boot專案，都會用到如下的啟動類

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

從上面程式碼可以看出，Annotation定義（@SpringBootApplication）和類定義（SpringApplication.run）最為耀眼，所以要揭開SpringBoot的神祕面紗，我們要從這兩位開始就可以了。

SpringBootApplication背後的祕密

@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);
    }
}

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

@Configuration

這裡的@Configuration對我們來說不陌生，它就是JavaConfig形式的Spring Ioc容器的配置類使用的那個@Configuration，SpringBoot社群推薦使用基於JavaConfig的配置形式，所以，這裡的啟動類標註了@Configuration之後，本身其實也是一個IoC容器的配置類。
舉幾個簡單例子回顧下，XML跟config配置方式的區別：

      • 表達形式層面
        基於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的建立方法就可以了。

@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,其自身定義關鍵資訊如下：

@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框架原有的一個工具類：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容器。

深入探索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的核心元件完成了基本的解析，綜合來看，大部分都是Spring框架背後的一些概念和實踐方式，SpringBoot只是在這些概念和實踐上對特定的場景事先進行了固化和昇華，而也恰恰是這些固化讓我們開發基於Sping框架的應用更加方便高效。

相關文章