本篇文章我們將探討CommandLineRunner和ApplicationRunner的使用雌澄。
在閱讀本篇文章之前内斯，你可以新建一個(gè)工程匆笤，寫一些關(guān)于本篇內(nèi)容代碼纷跛，這樣會(huì)加深你對(duì)本文內(nèi)容的理解，關(guān)于如何快速創(chuàng)建新工程惋戏，可以參考我的這篇博客：
概述
CommandLineRunner和ApplicationRunner是Spring Boot所提供的接口领追，他們都有一個(gè)run()方法。所有實(shí)現(xiàn)他們的Bean都會(huì)在Spring Boot服務(wù)啟動(dòng)之后自動(dòng)地被調(diào)用响逢。
由于這個(gè)特性绒窑，它們是一個(gè)理想地方去做一些初始化的工作，或者寫一些測(cè)試代碼舔亭。
CommandLineRunner
使用Application實(shí)現(xiàn)
在我們新建好工程后些膨，為了簡(jiǎn)單我們直接使用Application類實(shí)現(xiàn)CommandLineRunner接口，這個(gè)類的注解@SpringBootApplication會(huì)為我們自動(dòng)配置分歇。
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("服務(wù)已啟動(dòng)傀蓉，執(zhí)行command line runner。");
for (int i = 0; i < args.length; ++i) {
logger.info("args[{}]: {}", i, args[i]);
}
}
}
接下來(lái)我們直接啟動(dòng)服務(wù)职抡，查看日志如下葬燎，發(fā)現(xiàn)run()方法被正常地執(zhí)行了：
Tomcat started on port(s): 8080 (http) with context path ''
Started Sb2runnerApplication in 2.204 seconds (JVM running for 3.161)
服務(wù)已啟動(dòng)，執(zhí)行command line runner缚甩。
參數(shù)傳遞
run()方法有個(gè)可變參數(shù)args谱净，這個(gè)參數(shù)是用來(lái)接收命令行參數(shù)的，我們下面來(lái)加入?yún)?shù)來(lái)測(cè)試一下：
然后重啟服務(wù)擅威，觀察日志壕探，可以看到參數(shù)被正常地接收到了：
Tomcat started on port(s): 8080 (http) with context path ''
Started Sb2runnerApplication in 1.888 seconds (JVM running for 2.41)
服務(wù)已啟動(dòng)，執(zhí)行command line runner郊丛。
args[0]: --param=sth
命令行參數(shù)傳遞
之前我們說過使用Spring Boot的一大優(yōu)勢(shì)就是可以將工程直接打包成一個(gè)jar包而不需要單獨(dú)部署李请。打包成jar包后可以直接執(zhí)行該jar包進(jìn)行服務(wù)的啟動(dòng)，這樣在執(zhí)行jar包時(shí)我們就可以傳入命令行參數(shù)厉熟，讓CommandLineRunner接收參數(shù)导盅。
這種場(chǎng)景在服務(wù)器上特別常用。比如我們想執(zhí)行某個(gè)操作揍瑟，又不想對(duì)外部暴露白翻，此時(shí)可以使用CommandLineRunner作為該操作的入口。
下面我們就打成jar包來(lái)演示一下绢片。
-
進(jìn)入終端界面滤馍，開始打包
-w430 -
打包完成后岛琼，執(zhí)行該jar包，記得先把IDE的服務(wù)停掉巢株。
-w1217
可以從日志中看到我們也正常地獲取到了參數(shù)槐瑞。通過傳遞參數(shù)，在業(yè)務(wù)邏輯上我們可以根據(jù)不同的參數(shù)而執(zhí)行不同的操作纯续。
上面我們提到的只是一個(gè)CommandLineRunner随珠，如果我們有多個(gè)CommandLineRunner怎么辦呢？怎么控制它們執(zhí)行的順序呢猬错？
下面我們就來(lái)介紹如何指定執(zhí)行的順序。
指定執(zhí)行順序
Spring Boot為我們提供了一個(gè)注解"@Order"茸歧，可以用來(lái)指定執(zhí)行的順序倦炒，比如我們工程里面有三個(gè)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("執(zhí)行第一個(gè)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("執(zhí)行第二個(gè)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("執(zhí)行第三個(gè)command line runner...");
}
}
我們可以在該類的上面直接加入@Order注解，然后Spring Boot就會(huì)按照我們注解指定的順序從小到大的執(zhí)行了软瞎。很簡(jiǎn)單逢唤，是不是？
Tomcat started on port(s): 8080 (http) with context path ''
Started Sb2runnerApplication in 1.764 seconds (JVM running for 2.292)
執(zhí)行第一個(gè)command line runner...
執(zhí)行第二個(gè)command line runner...
執(zhí)行第三個(gè)command line runner...
ApplicationRunner
ApplicationRunner與CommandLineRunner做的事情是一樣的涤浇，也是在服務(wù)啟動(dòng)之后其run()方法會(huì)被自動(dòng)地調(diào)用鳖藕，唯一不同的是ApplicationRunner會(huì)封裝命令行參數(shù)，可以很方便地獲取到命令行參數(shù)和參數(shù)值只锭。
@Component
public class ApplicationRunner1 implements ApplicationRunner {
private static Logger logger = LoggerFactory.getLogger(ApplicationRunner1.class);
@Override
public void run(ApplicationArguments args) throws Exception {
logger.info("執(zhí)行application runner...");
logger.info("獲取到參數(shù): " + args.getOptionValues("param"));
}
}
執(zhí)行結(jié)果：
我們可以發(fā)現(xiàn)著恩，通過run()方法的參數(shù)ApplicationArguments可以很方便地獲取到命令行參數(shù)的值。
所以如果你的工程需要獲取命令行參數(shù)的話蜻展，建議你使用ApplicationRunner喉誊。
總結(jié)
無(wú)論是CommandLineRunner還是ApplicationRunner，它們的目的都是在服務(wù)啟動(dòng)之后執(zhí)行一些操作纵顾。如果需要獲取命令行參數(shù)時(shí)則建議使用ApplicationRunner伍茄。
另一種場(chǎng)景是我們?cè)诜?wù)器上需要執(zhí)行某個(gè)操作，比如修正數(shù)據(jù)庫(kù)用戶的數(shù)據(jù)施逾，而又找不到合適的執(zhí)行入口敷矫，那么這就是它們理想的使用場(chǎng)景了。
我的博客中其他關(guān)于Spring Boot的所有文章可以點(diǎn)擊這里找到汉额，歡迎關(guān)注曹仗！
如果有問題可以留言，或者給我發(fā)郵件lloyd@examplecode.cn闷愤，期待我們共同學(xué)習(xí)與成長(zhǎng)整葡！
