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，那么我們可以使用更為簡便的方式。Spring Boot 中針對系統啟動任務提供了兩種解決方案，分別是 CommandLineRunner 和 ApplicationRunner，分別來看。

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

運行結果如下：

總結

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