Spring Boot 系統啟動任務定義

DOONDO發表於2020-09-29
Spring Boot

前言

系統任務：在專案啟動階段要做一些資料初始化操作，這些操作有一個共同的特點，只在專案啟動時進行，以後都不再執行。

應用場景：例如配置檔案載入，資料庫初始化等操作

Spring Boot出現之前 解決方案

在 Servlet/Jsp 專案中，如果涉及到系統任務，例如在專案啟動階段要做一些資料初始化操作，這些操作有一個共同的特點，只在專案啟動時進行，以後都不再執行，這裡，容易想到web基礎中的三大元件（ Servlet、Filter、Listener ）之一 Listener ，這種情況下，一般定義一個 ServletContextListener，然後就可以監聽到專案啟動和銷燬，進而做出相應的資料初始化和銷燬操作，例如下面這樣：

public class MyListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        //在這裡做資料初始化操作
    }
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        //在這裡做資料備份操作
    }
}

當然，這是基礎 web 專案的解決方案，如果使用了 Spring Boot，那麼我們可以使用更為簡便的方式。

內容介紹

1.SpringBoot對於系統啟動時執行的任務，提供了兩種解決方案：CommandLineRunner和ApplicationRunner，兩者差別主要在於引數。

2.SpringBoot專案啟動時會遍歷所有的CommandLineRunner和ApplicationRunner的實現類並呼叫其中的run方法@Order註解可對於這些實現類呼叫順序進行排序。

CommandLineRunner

使用 CommandLineRunner 時，首先自定義 MyCommandLineRunner1 並且實現 CommandLineRunner 介面：

@Component
@Order(100)
public class MyCommandLineRunner1 implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
    }
}

關於這段程式碼，我做如下解釋：

  1. 首先通過 @Compoent 註解將 MyCommandLineRunner1 註冊為Spring容器中的一個 Bean。
  2. 新增 @Order註解，表示這個啟動任務的執行優先順序，因為在一個專案中，啟動任務可能有多個，所以需要有一個排序。@Order 註解中，數字越小，優先順序越大，預設情況下，優先順序的值為 Integer.MAX_VALUE，表示優先順序最低。
  3. 在 run 方法中，寫啟動任務的核心邏輯，當專案啟動時，run方法會被自動執行。
  4. run 方法的引數，來自於專案的啟動引數，即專案入口類中，main方法的引數會被傳到這裡。

此時啟動專案，run方法就會被執行，至於引數，可以通過兩種方式來傳遞，如果是在 IDEA 中，可以通過如下方式來配置引數：

另一種方式，則是將專案打包，在命令列中啟動專案，然後啟動時在命令列傳入引數，如下：

java -jar devtools-0.0.1-SNAPSHOT.jar 三國演義 西遊記

注意，這裡引數傳遞時沒有key，直接寫value即可，執行結果如下：

ApplicationRunner

ApplicationRunner 和 CommandLineRunner 功能一致，用法也基本一致，唯一的區別主要體現在對引數的處理上，ApplicationRunner 可以接收更多型別的引數（ApplicationRunner 除了可以接收 CommandLineRunner 的引數之外，還可以接收 key/value形式的引數）。

使用 ApplicationRunner ，自定義類實現 ApplicationRunner 介面即可，元件註冊以及元件優先順序的配置都和 CommandLineRunner 一致，如下：

@Component
@Order(98)
public class MyApplicationRunner1 implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        List<String> nonOptionArgs = args.getNonOptionArgs();
        System.out.println("MyApplicationRunner1>>>"+nonOptionArgs);
        Set<String> optionNames = args.getOptionNames();
        for (String key : optionNames) {
            System.out.println("MyApplicationRunner1>>>"+key + ":" + args.getOptionValues(key));
        }
        String[] sourceArgs = args.getSourceArgs();
        System.out.println("MyApplicationRunner1>>>"+Arrays.toString(sourceArgs));
    }
}

當專案啟動時，這裡的 run 方法就會被自動執行，關於 run 方法的引數 ApplicationArguments ，我說如下幾點：

  1. args.getNonOptionArgs();可以用來獲取命令列中的無key引數（和CommandLineRunner一樣）。
  2. args.getOptionNames();可以用來獲取所有key/value形式的引數的key。
  3. args.getOptionValues(key));可以根據key獲取key/value 形式的引數的value。
  4. args.getSourceArgs(); 則表示獲取命令列中的所有引數。

ApplicationRunner 定義完成後，傳啟動引數也是兩種方式，引數型別也有兩種，第一種和 CommandLineRunner 一致，第二種則是 –key=value 的形式，在 IDEA 中定義方式如下：

或者使用 如下啟動命令：

java -jar devtools-0.0.1-SNAPSHOT.jar 三國演義 西遊記 --age=99

執行結果如下：

總結

整體來說 ，這兩種的用法的差異不大 ，主要體現在對引數的處理上，小夥伴可以根據專案中的實際情況選擇合適的解決方案。

相關文章