Spring Boot2 系列教程(十五)定義系統啓動任務的兩種方式

在 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
複製代碼

運行結果以下：

總結

總體來講 ，這兩種的用法的差別不大 ，主要體如今對參數的處理上，小夥伴能夠根據項目中的實際狀況選擇合適的解決方案。相關案例已經上傳到 GitHub，歡迎小夥伴們們下載：github.com/lenve/javab…

關注公衆號【江南一點雨】，專一於 Spring Boot+微服務以及先後端分離等全棧技術，按期視頻教程分享，關注後回覆 Java ，領取鬆哥爲你精心準備的 Java 乾貨！