CommandLineRunner與ApplicationRunner的介紹

這篇文章帶給大家的內容是關於CommandLineRunner與ApplicationRunner的介紹，有一定的參考價值，有需要的朋友可以參考一下，希望對你有幫助。

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 <p>接下來我們直接啟動服務，查看日誌如下，發現run()方法被正常地執行了：</p><pre class="brush:php;toolbar:false">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. 進入終端介面，開始打包

1. #打包完成後，執行該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。

另一個場景是我們在伺服器上需要執行某個操作，例如修正資料庫使用者的數據，而又找不到合適的執行入口，那麼這就是它們理想的使用場景了。

#

以上是CommandLineRunner與ApplicationRunner的介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！