1. 前言
不知道你有沒有接到這種需求，項目啟動後立馬執行一些邏輯。比如緩存預熱，或者上線後的廣播之類等等。可能現在沒有但是將來會有的。想想你可能的操作， 寫個接口上線我調一次行嗎？NO！NO！NO！這種初級菜鳥才幹的事。今天告訴你個騷操作使得你的代碼更加優雅，逼格更高。
2. CommandLineRunner 接口
package org.springframework.boot;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
/**
* Interface used to indicate that a bean should run when it is contained within
* a {@link SpringApplication}. Multiple {@link CommandLineRunner} beans can be defined
* within the same application context and can be ordered using the {@link Ordered}
* interface or {@link Order @Order} annotation.
*
* If you need access to {@link ApplicationArguments} instead of the raw String array
* consider using {@link ApplicationRunner}.
*
* @author Dave Syer
* @see ApplicationRunner
*/
@FunctionalInterface
public interface CommandLineRunner {
/**
* Callback used to run the bean.
* @param args incoming main method arguments
* @throws Exception on error
*/
void run(String... args) throws Exception;
}
CommandLineRunner 作用是當springApplication 啟動後，在同一應用上下文中定義的多個 CommandLineRunner 類型的 Spring Bean 按照標記順序執行。如果你想替代以數組方式接收 args 參數 可以用 另一個接口代替 org.springframework.boot.ApplicationRunner 。
talk is cheap show your code 下面我就來操作一波演示一下。
2.1 優先級比較高的 CommandLineRunner 實現
package cn.felord.begin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
/**
* 優先級比較高 通過實現接口{@link Ordered}的方式 來指定優先級
* 命令行測試參數 --foo=bar --dev.name=碼農小胖哥 java,springboot
* @author Felordcn
* @since 2019/6/17 23:06
*/
@Slf4j
@Component
public class HighOrderCommandLineRunner implements CommandLineRunner , Ordered {
@Override
public void run(String... args) throws Exception {
log.info("i am highOrderRunner");
}
@Override
public int getOrder() {
return Ordered.HIGHEST_PRECEDENCE;
}
}
2.2 優先級比較低的 CommandLineRunner 實現:
package cn.felord.begin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
/**
* 優先級比較低 通過註解{@link Order}方式來指定優先級
* 比最優大64 說明會在 {@link HighOrderCommandLineRunner} 之後執行
*
* @author Felord
* @since 2019/6/17 23:07
*/
@Slf4j
@Order(Ordered.HIGHEST_PRECEDENCE + 64)
@Component
public class LowOrderCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
log.info("i am lowOrderRunner");
}
}
2.3 用 ApplicationRunner 實現最低優先級:
package cn.felord.begin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import java.util.List;
/**
* 優先級最低的實現
* @author Felordcn
* @since 2019/6/18 22:13
*/
@Slf4j
@Component
public class DefaultApplicationRunner implements ApplicationRunner, Ordered {
@Override
public void run(ApplicationArguments args) throws Exception {
log.info("i am applicationRunner");
}
@Override
public int getOrder() {
return Ordered.HIGHEST_PRECEDENCE+65;
}
}
啟動springboot 後控制檯打印出了執行結果：
2019-11-02 21:18:14.603 INFO 10244 --- [ main] c.f.begin.HighOrderCommandLineRunner : i am highOrderRunner
2019-11-02 21:18:14.604 INFO 10244 --- [ main] c.f.begin.LowOrderCommandLineRunner : i am lowOrderRunner
2019-11-02 21:18:14.604 INFO 10244 --- [ main] c.f.begin.DefaultApplicationRunner : i am applicationRunner
3. 進階操作 —— 讀取通過Spring Boot命令行啟動注入的參數
達到我們開篇的期望結果。那麼這兩個接口啥區別呢？ Spring 官方不會吃飽了沒事幹弄兩個這來折騰人，應該是有區別的，根據接口方法 run 方法可以看出來參數都不一樣，額外科普一下 Spring Boot 如何傳遞額外參數通過命令行 執行 java -jar 傳遞給 main 方法，規則如下
- 鍵值對 格式為 --K=V 多個使用空格隔開
- 值 多個空格隔開
- 在idea 開發工具中打開main方法配置項，進行如下配置，其他ide工具同理。參數內容為：
--foo=bar --dev.name=碼農小胖哥 java springboot
HighOrderCommandLineRunner 打印一下 args 參數:
package cn.felord.begin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
/**
* 優先級比較高 通過實現接口{@link Ordered}的方式 來指定優先級
* 命令行測試參數 --foo=bar --dev.name=碼農小胖哥 java,springboot
* @author dax
* @since 2019/6/17 23:06
*/
@Slf4j
@Component
public class HighOrderCommandLineRunner implements CommandLineRunner , Ordered {
@Override
public void run(String... args) throws Exception {
for (String arg : args) {
System.out.println("arg = " + arg);
}
log.info("i am highOrderRunner");
}
@Override
public int getOrder() {
return Ordered.HIGHEST_PRECEDENCE;
}
}
然後 DefaultApplicationRunner 的 ApplicationArguments 我們也一探究竟:
package cn.felord.begin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import java.util.List;
/**
* @author Felord
* @since 2019/6/18 22:13
*/
@Slf4j
@Component
public class DefaultApplicationRunner implements ApplicationRunner, Ordered {
@Override
public void run(ApplicationArguments args) throws Exception {
log.info("i am applicationRunner");
args.getOptionNames().forEach(System.out::println);
System.out.println(">>>>>>>>>>>>>>>>>>>>>>>>>>");
String[] sourceArgs = args.getSourceArgs();
if (sourceArgs!=null){
for (String sourceArg : sourceArgs) {
System.out.println("sourceArg = " + sourceArg);
}
}
System.out.println("<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< List<string> foo = args.getOptionValues("foo");
if (!CollectionUtils.isEmpty(foo)){
foo.forEach(System.out::println);
}
System.out.println("++++++++++++");
List<string> nonOptionArgs = args.getNonOptionArgs();
System.out.println("nonOptionArgs.size() = " + nonOptionArgs.size());
nonOptionArgs.forEach(System.out::println);
}
@Override
public int getOrder() {
return Ordered.HIGHEST_PRECEDENCE+65;
}
}
/<string>/<string>
重新啟動 Spring Boot 控制檯打印出了結果：
arg = --foo=bar
arg = --dev.name=碼農小胖哥
arg = java
arg = springboot
2019-11-02 21:18:14.603 INFO 10244 --- [ main] c.f.begin.HighOrderCommandLineRunner : i am highOrderRunner
2019-11-02 21:18:14.604 INFO 10244 --- [ main] c.f.begin.LowOrderCommandLineRunner : i am lowOrderRunner
2019-11-02 21:18:14.604 INFO 10244 --- [ main] c.f.begin.DefaultApplicationRunner : i am applicationRunner
dev.name
foo
>>>>>>>>>>>>>>>>>>>>>>>>>>
sourceArg = --foo=bar
sourceArg = --dev.name=碼農小胖哥
sourceArg = java
sourceArg = springboot
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
bar
++++++++++++
nonOptionArgs.size() = 2
java
springboot
我們發現可以利用這兩個接口來讀取 Spring Boot 命令行參數。 其實我們還可以使用 @Value 註解來讀取，這裡不進行講解，有興趣可以自己嘗試。 到這裡 ApplicationRunner 與 CommandLineRunner 的區別從控制檯我們就很瞭然了。
4. ApplicationRunner 與 CommandLineRunner 的區別
從上面的 log 我們知道 arg= 為 CommandLineRunner 的 args數組打印，僅僅單純把上面的參數以空格為規則解析成了原汁原味的數組。而 ApplicationRunner 則更加精細化。通過打印可以知道 ApplicationArguments 提供了一些很有用的參數解析方法：
- args.getOptionNames() 是獲取鍵值對 --K=V 中的 K
- args.getOptionValues("foo") 用來通過 K 來獲取鍵值對的值 V
- args.getSourceArgs() 等同於 CommandLineRunner 的 args 數組
- args.getNonOptionArgs() 最慘用來獲取單身狗
要注意的是 解析 ApplicationArguments 時要處理空指針問題。
5. 總結
今天我們通過對 CommandLineRunner 和 ApplicationRunner 講解。解決了如何在 Spring Boot 啟動時執行一些邏輯的問題以及如何來編排多個啟動邏輯的優先級順序。同時我們進階一步，通過這兩個方法讀取 Spring Boot 啟動項參數。進而也搞清楚了這兩個接口之間的細微的區別。希望對你有所幫助。
閱讀更多 碼農小胖哥 的文章
