Spring Boot 2 - 使用CommandLineRunner與ApplicationRunner

本篇文章咱們將探討CommandLineRunner和ApplicationRunner的使用。

在閱讀本篇文章以前，你能夠新建一個工程，寫一些關於本篇內容代碼，這樣會加深你對本文內容的理解，關於如何快速建立新工程，能夠參考個人這篇博客：

Spring Boot 2 - 建立新工程

概述

CommandLineRunner和ApplicationRunner是Spring Boot所提供的接口，他們都有一個run()方法。全部實現他們的Bean都會在Spring Boot服務啓動以後自動地被調用。

因爲這個特性，它們是一個理想地方去作一些初始化的工做，或者寫一些測試代碼。

CommandLineRunner

使用Application實現

在咱們新建好工程後，爲了簡單咱們直接使用Application類實現CommandLineRunner接口，這個類的註解@SpringBootApplication會爲咱們自動配置。

package cn.examplecode.sb2runner;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Sb2runnerApplication implements CommandLineRunner {

    private static Logger logger = LoggerFactory.getLogger(Sb2runnerApplication.class);

    public static void main(String[] args) {
        SpringApplication.run(Sb2runnerApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        logger.info("服務已啓動，執行command line runner。");

        for (int i = 0; i < args.length; ++i) {
            logger.info("args[{}]: {}", i, args[i]);
        }
    }
}

接下來咱們直接啓動服務，查看日誌以下，發現run()方法被正常地執行了：

Tomcat started on port(s): 8080 (http) with context path ''
Started Sb2runnerApplication in 2.204 seconds (JVM running for 3.161)
服務已啓動，執行command line runner。

參數傳遞

run()方法有個可變參數args，這個參數是用來接收命令行參數的，咱們下面來加入參數來測試一下：

而後重啓服務，觀察日誌，能夠看到參數被正常地接收到了：

Tomcat started on port(s): 8080 (http) with context path ''
Started Sb2runnerApplication in 1.888 seconds (JVM running for 2.41)
服務已啓動，執行command line runner。
args[0]: --param=sth

命令行參數傳遞

以前咱們說過使用Spring Boot的一大優點就是能夠將工程直接打包成一個jar包而不須要單獨部署。打包成jar包後能夠直接執行該jar包進行服務的啓動，這樣在執行jar包時咱們就能夠傳入命令行參數，讓CommandLineRunner接收參數。

這種場景在服務器上特別經常使用。好比咱們想執行某個操做，又不想對外部暴露，此時可使用CommandLineRunner做爲該操做的入口。

下面咱們就打成jar包來演示一下。

1. 進入終端界面，開始打包
   

2. 打包完成後，執行該jar包，記得先把IDE的服務停掉。
   

能夠從日誌中看到咱們也正常地獲取到了參數。經過傳遞參數，在業務邏輯上咱們能夠根據不一樣的參數而執行不一樣的操做。

上面咱們提到的只是一個CommandLineRunner，若是咱們有多個CommandLineRunner怎麼辦呢？怎麼控制它們執行的順序呢？

下面咱們就來介紹如何指定執行的順序。

指定執行順序

Spring Boot爲咱們提供了一個註解"@Order"，能夠用來指定執行的順序，好比咱們工程裏面有三個CommandLineRunner:

@Component
@Order(1)
public class CommandRunner1 implements CommandLineRunner {

    private static Logger logger = LoggerFactory.getLogger(CommandRunner1.class);

    @Override
    public void run(String... args) throws Exception {
        logger.info("執行第一個command line runner...");
    }

}


@Component
@Order(2)
public class CommandRunner2 implements CommandLineRunner {

    private static Logger logger = LoggerFactory.getLogger(CommandRunner2.class);

    @Override
    public void run(String... args) throws Exception {
        logger.info("執行第二個command line runner...");
    }
    
}

@Component
@Order(3)
public class CommandRunner3 implements CommandLineRunner {

    private static Logger logger = LoggerFactory.getLogger(CommandRunner3.class);

    @Override
    public void run(String... args) throws Exception {
        logger.info("執行第三個command line runner...");
    }
    
}

咱們能夠在該類的上面直接加入@Order註解，而後Spring Boot就會按照咱們註解指定的順序從小到大的執行了。很簡單，是否是？

Tomcat started on port(s): 8080 (http) with context path ''
Started Sb2runnerApplication in 1.764 seconds (JVM running for 2.292)
執行第一個command line runner...
執行第二個command line runner...
執行第三個command line runner...

ApplicationRunner

ApplicationRunner與CommandLineRunner作的事情是同樣的，也是在服務啓動以後其run()方法會被自動地調用，惟一不一樣的是ApplicationRunner會封裝命令行參數，能夠很方便地獲取到命令行參數和參數值。

@Component
public class ApplicationRunner1 implements ApplicationRunner {

    private static Logger logger = LoggerFactory.getLogger(ApplicationRunner1.class);

    @Override
    public void run(ApplicationArguments args) throws Exception {
        logger.info("執行application runner...");
        logger.info("獲取到參數: " + args.getOptionValues("param"));
    }
}

執行結果：

咱們能夠發現，經過run()方法的參數ApplicationArguments能夠很方便地獲取到命令行參數的值。

因此若是你的工程須要獲取命令行參數的話，建議你使用ApplicationRunner。

總結

不管是CommandLineRunner仍是ApplicationRunner，它們的目的都是在服務啓動以後執行一些操做。若是須要獲取命令行參數時則建議使用ApplicationRunner。

另外一種場景是咱們在服務器上須要執行某個操做，好比修正數據庫用戶的數據，而又找不到合適的執行入口，那麼這就是它們理想的使用場景了。

個人博客中其餘關於Spring Boot的全部文章能夠點擊這裏找到，歡迎關注！

若是有問題能夠留言，或者給我發郵件lloyd@examplecode.cn，期待咱們共同窗習與成長！