Springboot通過run啟動web應用的方法

2022-03-28 16:01:40

一、SpringBootApplication背後的祕密

@SpringBootApplication註解是Spring Boot的核心註解，它其實是一個組合註解：

@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

即 @SpringBootApplication = (預設屬性)@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。

1、@Configuration

這裡的@Configuration對我們來說不陌生，它就是JavaConfig形式的Spring Ioc容器的設定類使用的那個@Configuration，SpringBoot社群推薦使用基於JavaConfig的設定形式，所以，這裡的啟動類標註了@Configuration之後，本身其實也是一個IoC容器的設定類。

舉幾個簡單例子回顧下，XML跟config設定方式的區別：

（1）表達形式層面

基於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設定類。

（2）註冊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。

（3）表達依賴注入關係層面

為了表達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的建立方法就可以了。

@Configuration：提到@Configuration就要提到他的搭檔@Bean。使用這兩個註解就可以建立一個簡單的spring設定類，可以用來替代相應的xml組態檔。

<beans> 
     <bean id = "car" class="com.test.Car"> 
         <property name="wheel" ref = "wheel"></property> 
     </bean> 
     <bean id = "wheel" class="com.test.Wheel"></bean> 
 </beans>

相當於：

@Configuration 
  public class Conf { 
      @Bean 
      public Car car() { 
          Car car = new Car(); 
          car.setWheel(wheel()); 
          return car; 
      }
      
     @Bean 
     public Wheel wheel() { 
         return new Wheel(); 
     } 
 }

@Configuration的註解類標識這個類可以使用Spring IoC容器作為bean定義的來源。

@Bean註解告訴Spring，一個帶有@Bean的註解方法將返回一個物件，該物件應該被註冊為在Spring應用程式上下文中的bean。

2、@ComponentScan

@ComponentScan這個註解在Spring中很重要，它對應XML設定中的元素，@ComponentScan的功能其實就是自動掃描並載入符合條件的元件（比如@Component和@Repository等）或者bean定義，最終將這些bean定義載入到IoC容器中。

我們可以通過basePackages等屬性來細粒度的客製化@ComponentScan自動掃描的範圍，如果不指定，則預設Spring框架實現會從宣告@ComponentScan所在類的package進行掃描。

注：所以SpringBoot的啟動類最好是放在root package下，因為預設不指定basePackages。

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

 @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啟動程式為例，參考流程中主要類類圖，來分析其啟動邏輯和自動化設定原理。

總覽：

上圖為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設定以及複雜的依賴管理，讓開發人員可以更加關注業務邏輯的開發。

到此這篇關於Springboot通過run啟動web應用的方法的文章就介紹到這了,更多相關Springboot啟動web應用內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！