前言

有時候我們需要在應用啟動時執行一些程式碼片段,這些片段可能是僅僅是為了記錄 log,也可能是在啟動時檢查與安裝證書 ,諸如上述業務要求我們可能會經常碰到

Spring Boot 提供了至少 5 種方式用於在應用啟動時執行程式碼。我們應該如何選擇?本文將會逐步解釋與分析這幾種不同方式


CommandLineRunner

CommandLineRunner 是一個介面,通過實現它,我們可以在 Spring 應用成功啟動之後 執行一些程式碼片段

@Slf4j
@Component
@Order(2)
public class MyCommandLineRunner implements CommandLineRunner {
    
    @Override
    public void run(String... args) throws Exception {
        log.info("MyCommandLineRunner order is 2");
        if (args.length > 0){
            for (int i = 0; i < args.length; i++) {
                log.info("MyCommandLineRunner current parameter is: {}", args[i]);
            }
        }
    }
}

當 Spring Boot 在應用上下文中找到 CommandLineRunner bean,它將會在應用成功啟動之後呼叫 run() 方法,並傳遞用於啟動應用程式的命令列引數

通過如下 maven 命令生成 jar 包:

mvn clean package

通過終端命令啟動應用,並傳遞引數:

java -jar springboot-application-startup-0.0.1-SNAPSHOT.jar --foo=bar --name=rgyb

檢視執行結果:

到這裡我們可以看出幾個問題:

  1. 命令列傳入的引數並沒有被解析,而只是顯示出我們傳入的字串內容 --foo=bar--name=rgyb,我們可以通過 ApplicationRunner 解析,我們稍後看
  2. 在重寫的 run() 方法上有 throws Exception 標記,Spring Boot 會將 CommandLineRunner 作為應用啟動的一部分,如果執行 run() 方法時丟擲 Exception,應用將會終止啟動
  3. 我們在類上添加了 @Order(2) 註解,當有多個 CommandLineRunner 時,將會按照 @Order 註解中的數字從小到大排序 (數字當然也可以用複數)

⚠️不要使用 @Order 太多

看到 order 這個 "黑科技" 我們會覺得它可以非常方便將啟動邏輯按照指定順序執行,但如果你這麼寫,說明多個程式碼片段是有相互依賴關係的,為了讓我們的程式碼更好維護,我們應該減少這種依賴使用

小結

如果我們只是想簡單的獲取以空格分隔的命令列引數,那 MyCommandLineRunner 就足夠使用了


ApplicationRunner

上面提到,通過命令列啟動並傳遞引數,MyCommandLineRunner 不能解析引數,如果要解析引數,那我們就要用到 ApplicationRunner 引數了

@Component
@Slf4j
@Order(1)
public class MyApplicationRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        log.info("MyApplicationRunner order is 1");
        log.info("MyApplicationRunner Current parameter is {}:", args.getOptionValues("foo"));
    }
}

重新打 jar 包,執行如下命令:

java -jar springboot-application-startup-0.0.1-SNAPSHOT.jar --foo=bar,rgyb

執行結果如下:

到這裡我們可以看出:

  1. MyCommandLineRunner 相似,但 ApplicationRunner 可以通過 run 方法的 ApplicationArguments 物件解析出命令列引數,並且每個引數可以有多個值在裡面,因為 getOptionValues 方法返回 List
  2. 在重寫的 run() 方法上有 throws Exception 標記,Spring Boot 會將 CommandLineRunner 作為應用啟動的一部分,如果執行 run() 方法時丟擲 Exception,應用將會終止啟動
  3. ApplicationRunner 也可以使用 @Order 註解進行排序,從啟動結果來看,它與 CommandLineRunner 共享 order 的順序,稍後我們通過原始碼來驗證這個結論

小結

如果我們想獲取複雜的命令列引數時,我們可以使用 ApplicationRunner


ApplicationListener

如果我們不需要獲取命令列引數時,我們可以將啟動邏輯繫結到 Spring 的 ApplicationReadyEvent

@Slf4j
@Component
@Order(0)
public class MyApplicationListener implements ApplicationListener<ApplicationReadyEvent> {

    @Override
    public void onApplicationEvent(ApplicationReadyEvent applicationReadyEvent) {
        log.info("MyApplicationListener is started up");
    }
}

執行程式檢視結果:

到這我們可以看出:

  1. ApplicationReadyEvent 當且僅當 在應用程式就緒之後才被觸發,甚至是說上面的 Listener 要在本文說的所有解決方案都執行了之後才會被觸發,最終結論請稍後看
  2. 程式碼中我用 Order(0) 來標記,顯然 ApplicationListener 也是可以用該註解進行排序的,按數字大小排序,應該是最先執行。但是,這個順序僅用於同類型的 ApplicationListener 之間的排序,與前面提到的 ApplicationRunnersCommandLineRunners 的排序並不共享

小結

如果我們不需要獲取命令列引數,我們可以通過 ApplicationListener<ApplicationReadyEvent> 建立一些全域性的啟動邏輯,我們還可以通過它獲取 Spring Boot 支援的 configuration properties 環境變數引數


如果你看過我之前寫的 Spring Bean 生命週期三部曲:

  • Spring Bean 生命週期之緣起
  • Spring Bean 生命週期之緣盡
  • Spring Aware 到底是什麼?

那麼你會對下面兩種方式非常熟悉了

@PostConstruct

建立啟動邏輯的另一種簡單解決方案是提供一種在 bean 建立期間由 Spring 呼叫的初始化方法。我們要做的就只是將 @PostConstruct 註解新增到方法中:

@Component
@Slf4j
@DependsOn("myApplicationListener")
public class MyPostConstructBean {

    @PostConstruct
    public void testPostConstruct(){
        log.info("MyPostConstructBean");
    }
}

檢視執行結果:

從上面執行結果可以看出:

  1. Spring 建立完 bean之後 (在啟動之前),便會立即呼叫 @PostConstruct 註解標記的方法,因此我們無法使用 @Order 註解對其進行自由排序,因為它可能依賴於 @Autowired 插入到我們 bean 中的其他 Spring bean。
  2. 相反,它將在依賴於它的所有 bean 被初始化之後被呼叫,如果要新增人為的依賴關係並由此建立一個排序,則可以使用 @DependsOn 註解(雖然可以排序,但是不建議使用,理由和 @Order 一樣)

小結

@PostConstruct 方法固有地繫結到現有的 Spring bean,因此應僅將其用於此單個 bean 的初始化邏輯;


InitializingBean

@PostConstruct 解決方案非常相似,我們可以實現 InitializingBean 介面,並讓 Spring 呼叫某個初始化方法:

@Component
@Slf4j
public class MyInitializingBean implements InitializingBean {


    @Override
    public void afterPropertiesSet() throws Exception {
        log.info("MyInitializingBean.afterPropertiesSet()");
    }
}

檢視執行結果:

從上面的執行結果中,我們得到了和 @PostConstruct 一樣的效果,但二者還是有差別的

⚠️ @PostConstructafterPropertiesSet 區別

  1. afterPropertiesSet,顧名思義「在屬性設定之後」,呼叫該方法時,該 bean 的所有屬性已經被 Spring 填充。如果我們在某些屬性上使用 @Autowired(常規操作應該使用建構函式注入),那麼 Spring 將在呼叫afterPropertiesSet 之前將 bean 注入這些屬性。但 @PostConstruct 並沒有這些屬性填充限制
  2. 所以 InitializingBean.afterPropertiesSet 解決方案比使用 @PostConstruct 更安全,因為如果我們依賴尚未自動注入的 @Autowired 欄位,則 @PostConstruct 方法可能會遇到 NullPointerExceptions

小結

如果我們使用建構函式注入,則這兩種解決方案都是等效的


原始碼分析

請開啟你的 IDE (重點程式碼已標記註釋):

MyCommandLineRunnerApplicationRunner 是在何時被呼叫的呢?

開啟 SpringApplication.java 類,裡面有 callRunners 方法

private void callRunners(ApplicationContext context, ApplicationArguments args) {
    List<Object> runners = new ArrayList<>();
    //從上下文獲取 ApplicationRunner 型別的 bean
    runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());

    //從上下文獲取 CommandLineRunner 型別的 bean
    runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());

    //對二者進行排序,這也就是為什麼二者的 order 是可以共享的了
    AnnotationAwareOrderComparator.sort(runners);

    //遍歷對其進行呼叫
    for (Object runner : new LinkedHashSet<>(runners)) {
        if (runner instanceof ApplicationRunner) {
            callRunner((ApplicationRunner) runner, args);
        }
        if (runner instanceof CommandLineRunner) {
            callRunner((CommandLineRunner) runner, args);
        }
    }
}

強烈建議完整看一下 SpringApplication.java 的全部程式碼,Spring Boot 啟動過程及原理都可以從這個類中找到一些答案


總結

最後畫一張圖用來總結這幾種方式(高清大圖請檢視原文:https://dayarch.top/p/spring-boot-execute-on-startup.html)

靈魂追問

  1. 上面程式執行結果, afterPropertiesSet 方法呼叫先於 @PostConstruct 方法,但這和我們在 Spring Bean 生命週期之緣起 中的呼叫順序恰恰相反,你知道為什麼嗎?
  2. MyPostConstructBean 通過 @DependsOn("myApplicationListener") 依賴了 MyApplicationListener,為什麼呼叫結果前者先與後者呢?
  3. 為什麼不建議 @Autowired 形式依賴注入

在寫 Spring Bean 生命週期時就有朋友問我與之相關的問題,顯然他們在概念上有一些含混,所以,仔細理解上面的問題將會幫助你加深對 Spring Bean 生命週期的理解

歡迎持續關注公眾號:「日拱一兵」

  • 前沿 Java 技術乾貨分享
  • 高效工具彙總 | 回覆「工具」
  • 面試問題分析與解答
  • 技術資料領取 | 回覆「資料」

以讀偵探小說思維輕鬆趣味學習 Java 技術棧相關知識,本著將複雜問題簡單化,抽象問題具體化和圖形化原則逐步分解技術問題,技術持續更新,請持續關注......


相關文章