快捷導(dǎo)航

Spring Boot 定義系統(tǒng)啟動(dòng)任務(wù)的多種方式

更新時(shí)間：2019年04月15日 10:56:49 作者：江南一點(diǎn)雨

這篇文章主要介紹了Spring Boot 定義系統(tǒng)啟動(dòng)任務(wù)的多種方式，看看你都會(huì)哪幾種 ,感興趣的朋友跟隨小編一起看看吧

在 Servlet/Jsp 項(xiàng)目中，如果涉及到系統(tǒng)任務(wù)，例如在項(xiàng)目啟動(dòng)階段要做一些數(shù)據(jù)初始化操作，這些操作有一個(gè)共同的特點(diǎn)，只在項(xiàng)目啟動(dòng)時(shí)進(jìn)行，以后都不再執(zhí)行，這里，容易想到web基礎(chǔ)中的三大組件（ Servlet、Filter、Listener ）之一 Listener ，這種情況下，一般定義一個(gè) ServletContextListener，然后就可以監(jiān)聽到項(xiàng)目啟動(dòng)和銷毀，進(jìn)而做出相應(yīng)的數(shù)據(jù)初始化和銷毀操作，例如下面這樣：

public class MyListener implements ServletContextListener {
  @Override
  public void contextInitialized(ServletContextEvent sce) {
    //在這里做數(shù)據(jù)初始化操作
  }
  @Override
  public void contextDestroyed(ServletContextEvent sce) {
    //在這里做數(shù)據(jù)備份操作
  }
}

當(dāng)然，這是基礎(chǔ) web 項(xiàng)目的解決方案，如果使用了 Spring Boot，那么我們可以使用更為簡(jiǎn)便的方式。Spring Boot 中針對(duì)系統(tǒng)啟動(dòng)任務(wù)提供了兩種解決方案，分別是 CommandLineRunner 和 ApplicationRunner，分別來看。

CommandLineRunner

使用 CommandLineRunner 時(shí)，首先自定義 MyCommandLineRunner1 并且實(shí)現(xiàn) CommandLineRunner 接口：

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

關(guān)于這段代碼，我做如下解釋：

1.首先通過 @Compoent 注解將 MyCommandLineRunner1 注冊(cè)為Spring容器中的一個(gè) Bean。

2.添加 @Order注解，表示這個(gè)啟動(dòng)任務(wù)的執(zhí)行優(yōu)先級(jí)，因?yàn)樵谝粋€(gè)項(xiàng)目中，啟動(dòng)任務(wù)可能有多個(gè)，所以需要有一個(gè)排序。@Order 注解中，數(shù)字越小，優(yōu)先級(jí)越大，默認(rèn)情況下，優(yōu)先級(jí)的值為 Integer.MAX_VALUE，表示優(yōu)先級(jí)最低。

3.在 run 方法中，寫啟動(dòng)任務(wù)的核心邏輯，當(dāng)項(xiàng)目啟動(dòng)時(shí)，run方法會(huì)被自動(dòng)執(zhí)行。

4.run 方法的參數(shù)，來自于項(xiàng)目的啟動(dòng)參數(shù)，即項(xiàng)目入口類中，main方法的參數(shù)會(huì)被傳到這里。

此時(shí)啟動(dòng)項(xiàng)目，run方法就會(huì)被執(zhí)行，至于參數(shù)，可以通過兩種方式來傳遞，如果是在 IDEA 中，可以通過如下方式來配置參數(shù)：

另一種方式，則是將項(xiàng)目打包，在命令行中啟動(dòng)項(xiàng)目，然后啟動(dòng)時(shí)在命令行傳入?yún)?shù)，如下：

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

注意，這里參數(shù)傳遞時(shí)沒有key，直接寫value即可，執(zhí)行結(jié)果如下：

ApplicationRunner

ApplicationRunner 和 CommandLineRunner 功能一致，用法也基本一致，唯一的區(qū)別主要體現(xiàn)在對(duì)參數(shù)的處理上，ApplicationRunner 可以接收更多類型的參數(shù)（ApplicationRunner 除了可以接收 CommandLineRunner 的參數(shù)之外，還可以接收 key/value形式的參數(shù)）。

使用 ApplicationRunner ，自定義類實(shí)現(xiàn) ApplicationRunner 接口即可，組件注冊(cè)以及組件優(yōu)先級(jí)的配置都和 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));
  }
}

當(dāng)項(xiàng)目啟動(dòng)時(shí)，這里的 run 方法就會(huì)被自動(dòng)執(zhí)行，關(guān)于 run 方法的參數(shù) ApplicationArguments ，我說如下幾點(diǎn)：

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

ApplicationRunner 定義完成后，傳啟動(dòng)參數(shù)也是兩種方式，參數(shù)類型也有兩種，第一種和 CommandLineRunner 一致，第二種則是 --key=value 的形式，在 IDEA 中定義方式如下：