Spring Boot 2 - 使用CommandLineRunner與ApplicationRunner

羅伊德發表於2019-03-21
Spring BootAPP

本篇文章我們將探討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，這個引數是用來接收命令列引數的，我們下面來加入引數來測試一下：

-w1070

然後重啟服務，觀察日誌，可以看到引數被正常地接收到了：

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. 進入終端介面，開始打包

    -w430

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

    -w1217

可以從日誌中看到我們也正常地獲取到了引數。通過傳遞引數，在業務邏輯上我們可以根據不同的引數而執行不同的操作。

上面我們提到的只是一個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"));
    }
}

複製程式碼

執行結果：

-w533

我們可以發現，通過run()方法的引數ApplicationArguments可以很方便地獲取到命令列引數的值。

所以如果你的工程需要獲取命令列引數的話，建議你使用ApplicationRunner。

總結

無論是CommandLineRunner還是ApplicationRunner，它們的目的都是在服務啟動之後執行一些操作。如果需要獲取命令列引數時則建議使用ApplicationRunner。

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

我的部落格中其他關於Spring Boot的所有文章可以點選這裡找到，歡迎關注！

如果有問題可以留言，或者給我發郵件lloyd@examplecode.cn，期待我們共同學習與成長！

相關文章