SpringApplication.run執(zhí)行流程詳解

SpringApplication 將一個典型的 Spring 應(yīng)用啟動的流程“模板化”(這里是動詞),在沒有特殊需求的情況下,默認(rèn)模板化后的執(zhí)行流程就可以滿足需求了但有特殊需求也沒關(guān)系,SpringApplication 在合適的流程結(jié)點(diǎn)開放了一系列不同類型的擴(kuò)展點(diǎn),我們可以通過這些擴(kuò)展點(diǎn)對 SpringBoot 程序的啟動和關(guān)閉過程進(jìn)行擴(kuò)展。

最“膚淺”的擴(kuò)展或者配置是 SpringApplication 通過一系列設(shè)置方法(setters)開放的定制方式,比如,我們之前的啟動類的 main 方法中只有一句:

SpringApplication.run(DemoApplication.class,args);

但如果我們想通過 SpringApplication 的一系列設(shè)置方法來擴(kuò)展啟動行為,則可以用如下方式進(jìn)行:

public class DemoApplication {
    public static void main(String[] args) {
        // SpringApplication.run(DemoConfiguration.class, args);
        SpringApplication bootstrap = new SpringApplication(Demo - Configuration.class);
        bootstrap.setBanner(new Banner() {
            @Override
            public void printBanner(Environment environment, Class<?> aClass, PrintStream printStream) {
                // 比如打印一個我們喜歡的ASCII Arts字符畫
            }
        });
        bootstrap.setBannerMode(Banner.Mode.CONSOLE);
        // 其他定制設(shè)置...
        bootstrap.run(args);
    }
}

設(shè)置自定義 banner 最簡單的方式其實(shí)是把 ASCII Art 字符畫放到一個資源文件,然后通過 ResourceBanner 來加載:

bootstrap.setBanner(new ResourceBanner(new ClassPathResource("banner.txt")));

大部分情況下,SpringApplication 已經(jīng)提供了很好的默認(rèn)設(shè)置,所以,我們不再對這些表層進(jìn)行探究了,因?yàn)閷Ρ韺又碌臇|西進(jìn)行探究才是我們的最終目的。

深入探索 SpringApplication 執(zhí)行流程

SpringApplication 的 run 方法的實(shí)現(xiàn)是我們本次旅程的主要線路,該方法的主要流程大體可以歸納如下:

1)如果我們使用的是 SpringApplication 的靜態(tài) run 方法,那么,這個方法里面首先需要創(chuàng)建一個 SpringApplication 對象實(shí)例,然后調(diào)用這個創(chuàng)建好的 SpringApplication 的實(shí)例 run方 法。在 SpringApplication 實(shí)例初始化的時(shí)候,它會提前做幾件事情:

根據(jù) classpath 里面是否存在某個特征類(org.springframework.web.context.ConfigurableWebApplicationContext)來決定是否應(yīng)該創(chuàng)建一個為 Web 應(yīng)用使用的 ApplicationContext 類型,還是應(yīng)該創(chuàng)建一個標(biāo)準(zhǔn) Standalone 應(yīng)用使用的 ApplicationContext 類型。

使用 SpringFactoriesLoader 在應(yīng)用的 classpath 中查找并加載所有可用的 ApplicationContextInitializer。

使用 SpringFactoriesLoader 在應(yīng)用的 classpath 中查找并加載所有可用的 ApplicationListener。

推斷并設(shè)置 main 方法的定義類。

2)SpringApplication 實(shí)例初始化完成并且完成設(shè)置后,就開始執(zhí)行 run 方法的邏輯了,方法執(zhí)行伊始,首先遍歷執(zhí)行所有通過 SpringFactoriesLoader 可以查找到并加載的 SpringApplicationRunListener,調(diào)用它們的 started() 方法,告訴這些 SpringApplicationRunListener,“嘿,SpringBoot 應(yīng)用要開始執(zhí)行咯!”。

3)創(chuàng)建并配置當(dāng)前 SpringBoot 應(yīng)用將要使用的 Environment(包括配置要使用的 PropertySource 以及 Profile)。

4)遍歷調(diào)用所有 SpringApplicationRunListener 的 environmentPrepared()的方法,告訴它們:“當(dāng)前 SpringBoot 應(yīng)用使用的 Environment 準(zhǔn)備好咯!”。

5)如果 SpringApplication的showBanner 屬性被設(shè)置為 true,則打印 banner(SpringBoot 1.3.x版本,這里應(yīng)該是基于 Banner.Mode 決定 banner 的打印行為)。這一步的邏輯其實(shí)可以不關(guān)心,我認(rèn)為唯一的用途就是“好玩”(Just For Fun)。

6)根據(jù)用戶是否明確設(shè)置了applicationContextClass 類型以及初始化階段的推斷結(jié)果,決定該為當(dāng)前 SpringBoot 應(yīng)用創(chuàng)建什么類型的 ApplicationContext 并創(chuàng)建完成,然后根據(jù)條件決定是否添加 ShutdownHook,決定是否使用自定義的 BeanNameGenerator,決定是否使用自定義的 ResourceLoader,當(dāng)然,最重要的,將之前準(zhǔn)備好的 Environment 設(shè)置給創(chuàng)建好的 ApplicationContext 使用。

7)ApplicationContext 創(chuàng)建好之后,SpringApplication 會再次借助 Spring-FactoriesLoader,查找并加載 classpath 中所有可用的 ApplicationContext-Initializer,然后遍歷調(diào)用這些 ApplicationContextInitializer 的 initialize(applicationContext)方法來對已經(jīng)創(chuàng)建好的 ApplicationContext 進(jìn)行進(jìn)一步的處理。

8)遍歷調(diào)用所有 SpringApplicationRunListener 的 contextPrepared()方法,通知它們:“SpringBoot 應(yīng)用使用的 ApplicationContext 準(zhǔn)備好啦!”

9)最核心的一步,將之前通過 @EnableAutoConfiguration 獲取的所有配置以及其他形式的 IoC 容器配置加載到已經(jīng)準(zhǔn)備完畢的 ApplicationContext。

10)遍歷調(diào)用所有 SpringApplicationRunListener 的 contextLoaded() 方法,告知所有 SpringApplicationRunListener,ApplicationContext "裝填完畢"!

11)調(diào)用 ApplicationContext 的 refresh() 方法,完成 IoC 容器可用的最后一道工序。

12)查找當(dāng)前 ApplicationContext 中是否注冊有 CommandLineRunner,如果有,則遍歷執(zhí)行它們。

13)正常情況下,遍歷執(zhí)行 SpringApplicationRunListener 的 finished() 方法,告知它們:“搞定!”。(如果整個過程出現(xiàn)異常,則依然調(diào)用所有 SpringApplicationRunListener 的 finished() 方法,只不過這種情況下會將異常信息一并傳入處理)。

至此,一個完整的 SpringBoot 應(yīng)用啟動完畢!

整個過程看起來冗長無比,但其實(shí)很多都是一些事件通知的擴(kuò)展點(diǎn),如果我們將這些邏輯暫時(shí)忽略,那么,其實(shí)整個 SpringBoot 應(yīng)用啟動的邏輯就可以壓縮到極其精簡的幾步,如圖 1 所示。

SpringBoot應(yīng)用啟動步驟簡要示意圖

圖 1 SpringBoot應(yīng)用啟動步驟簡要示意圖

前后對比我們就可以發(fā)現(xiàn),其實(shí) SpringApplication 提供的這些各類擴(kuò)展點(diǎn)近乎“喧賓奪主”,占據(jù)了一個 Spring 應(yīng)用啟動邏輯的大部分“江山”,除了初始化并準(zhǔn)備好 ApplicationContext,剩下的大部分工作都是通過這些擴(kuò)展點(diǎn)完成的,所以,我們接下來對各類擴(kuò)展點(diǎn)進(jìn)行逐一剖析。

SpringApplicationRunListener

SpringApplicationRunListener 是一個只有 SpringBoot 應(yīng)用的 main 方法執(zhí)行過程中接收不同執(zhí)行時(shí)點(diǎn)事件通知的監(jiān)聽者:

public interface SpringApplicationRunListener {
    void started();
    void environmentPrepared(ConfigurableEnvironment environment);
    void contextPrepared(ConfigurableApplicationContext context);
    void contextLoaded(ConfigurableApplicationContext context);
    void finished(ConfigurableApplicationContext context, Throwable exception);
}

對于我們來說,基本沒什么常見的場景需要自己實(shí)現(xiàn)一個 Spring-ApplicationRunListener,即使 SpringBoot 默認(rèn)也只是實(shí)現(xiàn)了一個 org.spring-framework.boot.context.event.EventPublishingRunListener,用于在 SpringBoot 啟動的不同時(shí)點(diǎn)發(fā)布不同的應(yīng)用事件類型(ApplicationEvent),如果有哪些 ApplicationListener 對這些應(yīng)用事件感興趣,則可以接收并處理。

假設(shè)我們真的有場景需要自定義一個 SpringApplicationRunListener 實(shí)現(xiàn),那么有一點(diǎn)需要注意,即任何一個 SpringApplicationRunListener 實(shí)現(xiàn)類的構(gòu)造方法(Constructor)需要有兩個構(gòu)造參數(shù),一個構(gòu)造參數(shù)的類型就是我們的 org.springframework.boot.SpringApplication,另外一個就是 args 參數(shù)列表的 String[]:

public class DemoSpringApplicationRunListener implements SpringApplicationRunListener {
    @Override
    public void started() {
        // do whatever you want to do
    }
    @Override
    public void environmentPrepared(ConfigurableEnvironment environment) {
        // do whatever you want to do
    }
    @Override
    public void contextPrepared(ConfigurableApplicationContext context) {
        // do whatever you want to do
    }
    @Override
    public void contextLoaded(ConfigurableApplicationContext context) {
        // do whatever you want to do
    }
    @Override
    public void finished(ConfigurableApplicationContext context, Throwable exception) {
        // do whatever you want to do
    }
}

之后,我們可以通過 SpringFactoriesLoader 立下的規(guī)矩,在當(dāng)前 SpringBoot 應(yīng)用的 classpath 下的 META-INF/spring.factories 文件中進(jìn)行類似如下的配置:

org.springframework.boot.SpringApplicationRunListener=\com.keevol.springboot.demo.DemoSpringApplicationRunListener

然后 SpringApplication 就會在運(yùn)行的時(shí)候調(diào)用它啦!

ApplicationListener

ApplicationListener 其實(shí)是老面孔,屬于 Spring 框架對 Java 中實(shí)現(xiàn)的監(jiān)聽者模式的一種框架實(shí)現(xiàn),這里唯一值得著重強(qiáng)調(diào)的是,對于初次接觸 SpringBoot,但對 Spring 框架本身又沒有過多接觸的開發(fā)者來說,可能會將這個名字與 SpringApplicationRunListener 混淆。

關(guān)于 ApplicationListener 我們就不做過多介紹了,如果感興趣,請參考 Spring 框架相關(guān)的資料和書籍。

如果我們要為 SpringBoot 應(yīng)用添加自定義的 ApplicationListener,有兩種方式:

  • 通過 SpringApplication.addListeners(..)或者 SpringApplication.setListeners(..)方法添加一個或者多個自定義的 ApplicationListener。
  • 借助 SpringFactoriesLoader 機(jī)制,在 META-INF/spring.factories 文件中添加配置(以下代碼是為 SpringBoot 默認(rèn)注冊的 ApplicationListener 配置)。
org.springframework.context.ApplicationListener=
\org.springframework.boot.builder.ParentContextCloserApplicationListener,
\org.springframework.boot.cloudfoundry.VcapApplicationListener,
\org.springframework.boot.context.FileEncodingApplicationListener,
\org.springframework.boot.context.config.AnsiOutputApplicationListener,
\org.springframework.boot.context.config.ConfigFileApplicationListener,
\org.springframework.boot.context.config.DelegatingApplicationListener,
\org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicat-ionListener,
\org.springframework.boot.logging.ClasspathLoggingApplicationListener,
\org.springframework.boot.logging.LoggingApplicationListener

關(guān)于 ApplicationListener,我們就說這些。

ApplicationContextInitializer

ApplicationContextInitializer 也是 Spring 框架原有的概念,這個類的主要目的就是在 ConfigurableApplicationContext 類型(或者子類型)的 ApplicationContext 做 refresh 之前,允許我們對 ConfigurableApplicationContext 的實(shí)例做進(jìn)一步的設(shè)置或者處理。

實(shí)現(xiàn)一個 ApplicationContextInitializer 很簡單,因?yàn)樗挥幸粋€方法需要實(shí)現(xiàn):

public class DemoApplicationContextInitializer implements ApplicationContextInitializer {
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        // do whatever you want with applicationContext,
        // e.g.
        applicationContext.registerShutdownHook();
    }
}

不過,一般情況下我們基本不會需要自定義一個 ApplicationContext-Initializer,即使 SpringBoot 框架默認(rèn)也只是注冊了三個實(shí)現(xiàn):

org.springframework.context.ApplicationContextInitializer=
\org.springframework.boot.context.ConfigurationWarningsApplication-ContextInitializer,
\org.springframework.boot.context.ContextIdApplicationContextInitia-lizer,
\org.springframework.boot.context.config.DelegatingApplicationContex-tInitializer

如果我們真的需要自定義一個 ApplicationContextInitializer,那么只要像上面這樣,通過 SpringFactoriesLoader 機(jī)制進(jìn)行配置,或者通過 SpringApplication.addInitializers(..)設(shè)置即可。

CommandLineRunner

CommandLineRunner 是很好的擴(kuò)展接口,不是 Spring 框架原有的“寶貝”,它屬于 SpringBoot 應(yīng)用特定的回調(diào)擴(kuò)展接口。源碼如下所示:

public interface CommandLineRunner {
    void run(String... args) throws Exception;
}

CommandLineRunner 需要大家關(guān)注的其實(shí)就兩點(diǎn):

1)所有 CommandLineRunner 的執(zhí)行時(shí)點(diǎn)在 SpringBoot 應(yīng)用的 Application-Context 完全初始化開始工作之后(可以認(rèn)為是 main 方法執(zhí)行完成之前最后一步)。

2)只要存在于當(dāng)前 SpringBoot 應(yīng)用的 ApplicationContext 中的任何 Command-LineRunner,都會被加載執(zhí)行(不管你是手動注冊這個 CommandLineRunner 到 IoC 容器,還是自動掃描進(jìn)去的)。

與其他幾個擴(kuò)展點(diǎn)接口類型相似,建議 CommandLineRunner 的實(shí)現(xiàn)類使用 @org.springframework.core.annotation.Order 進(jìn)行標(biāo)注或者實(shí)現(xiàn) org.springframework.core.Ordered 接口,便于對它們的執(zhí)行順序進(jìn)行調(diào)整,這其實(shí)十分重要,我們不希望順序不當(dāng)?shù)?CommandLineRunner 實(shí)現(xiàn)類阻塞了后面其他 CommandLineRunner 的執(zhí)行。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容