這篇文章主要講解了Spring Boot 2如何自定義啟動(dòng)運(yùn)行邏輯,內(nèi)容清晰明了,對(duì)此有興趣的小伙伴可以學(xué)習(xí)一下,相信大家閱讀完之后會(huì)有幫助。
我們提供的服務(wù)有:網(wǎng)站制作、網(wǎng)站建設(shè)、微信公眾號(hào)開發(fā)、網(wǎng)站優(yōu)化、網(wǎng)站認(rèn)證、通州ssl等。為上千家企事業(yè)單位解決了網(wǎng)站和推廣的問(wèn)題。提供周到的售前咨詢和貼心的售后服務(wù),是有科學(xué)管理、有技術(shù)的通州網(wǎng)站制作公司
1. 前言
不知道你有沒有接到這種需求,項(xiàng)目啟動(dòng)后立馬執(zhí)行一些邏輯。比如緩存預(yù)熱,或者上線后的廣播之類等等??赡墁F(xiàn)在沒有但是將來(lái)會(huì)有的。想想你可能的操作, 寫個(gè)接口上線我調(diào)一次行嗎?NO!NO!NO!這種初級(jí)菜鳥才干的事。今天告訴你個(gè)騷操作使得你的代碼更加優(yōu)雅,逼格更高。
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
作用是當(dāng)springApplication 啟動(dòng)后,在同一應(yīng)用上下文中定義的多個(gè) CommandLineRunner
類型的 Spring Bean 按照標(biāo)記順序執(zhí)行。如果你想替代以數(shù)組方式接收 args
參數(shù) 可以用 另一個(gè)接口代替 org.springframework.boot.ApplicationRunner
。
talk is cheap show your code 下面我就來(lái)操作一波演示一下。
package cn.felord.begin; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.CommandLineRunner; import org.springframework.core.Ordered; import org.springframework.stereotype.Component; /** * 優(yōu)先級(jí)比較高 通過(guò)實(shí)現(xiàn)接口{@link Ordered}的方式 來(lái)指定優(yōu)先級(jí) * 命令行測(cè)試參數(shù) --foo=bar --dev.name=碼農(nóng)小胖哥 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; } }
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; /** * 優(yōu)先級(jí)比較低 通過(guò)注解{@link Order}方式來(lái)指定優(yōu)先級(jí) * 比最優(yōu)大64 說(shuō)明會(huì)在 {@link HighOrderCommandLineRunner} 之后執(zhí)行 * * @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("iamlowOrderRunner"); } }
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; /** * 優(yōu)先級(jí)最低的實(shí)現(xiàn) * @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("iamapplicationRunner"); } @Override public int getOrder() { return Ordered.HIGHEST_PRECEDENCE+65; } }
啟動(dòng)springboot 后控制臺(tái)打印出了執(zhí)行結(jié)果:
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
達(dá)到我們開篇的期望結(jié)果。那么這兩個(gè)接口啥區(qū)別呢? Spring 官方不會(huì)吃飽了沒事干弄兩個(gè)這來(lái)折騰人,應(yīng)該是有區(qū)別的,根據(jù)接口方法 run
方法可以看出來(lái)參數(shù)都不一樣,額外科普一下 Spring Boot 如何傳遞額外參數(shù)通過(guò)命令行 執(zhí)行 java -jar 傳遞給 main 方法,規(guī)則如下
鍵值對(duì) 格式為 --K=V
多個(gè)使用空格隔開
值 多個(gè)空格隔開 在idea 開發(fā)工具中打開main方法配置項(xiàng),進(jìn)行如下配置,其他ide工具同理。參數(shù)內(nèi)容為:
--foo=bar --dev.name=碼農(nóng)小胖哥 java springboot
HighOrderCommandLineRunner
打印一下 args
參數(shù):
package cn.felord.begin; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.CommandLineRunner; import org.springframework.core.Ordered; import org.springframework.stereotype.Component; /** * 優(yōu)先級(jí)比較高 通過(guò)實(shí)現(xiàn)接口{@link Ordered}的方式 來(lái)指定優(yōu)先級(jí) * 命令行測(cè)試參數(shù) --foo=bar --dev.name=碼農(nóng)小胖哥 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("<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"); Listfoo = args.getOptionValues("foo"); if (!CollectionUtils.isEmpty(foo)){ foo.forEach(System.out::println); } System.out.println("++++++++++++"); List nonOptionArgs = args.getNonOptionArgs(); System.out.println("nonOptionArgs.size() = " + nonOptionArgs.size()); nonOptionArgs.forEach(System.out::println); } @Override public int getOrder() { return Ordered.HIGHEST_PRECEDENCE+65; } }
重新啟動(dòng) Spring Boot 控制臺(tái)打印出了結(jié)果:
arg = --foo=bar arg = --dev.name=碼農(nóng)小胖哥 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=碼農(nóng)小胖哥 sourceArg = java sourceArg = springboot <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< bar ++++++++++++ nonOptionArgs.size() = 2 java springboot
我們發(fā)現(xiàn)可以利用這兩個(gè)接口來(lái)讀取 Spring Boot 命令行參數(shù)。其實(shí)我們還可以使用 @Value
注解來(lái)讀取,這里不進(jìn)行講解,有興趣可以自己嘗試。到這里 ApplicationRunner
與 CommandLineRunner
的區(qū)別從控制臺(tái)我們就很了然了。
從上面的 log 我們知道 arg=
為 CommandLineRunner
的 args
數(shù)組打印,僅僅單純把上面的參數(shù)以空格為規(guī)則解析成了原汁原味的數(shù)組。而 ApplicationRunner
則更加精細(xì)化。通過(guò)打印可以知道 ApplicationArguments
提供了一些很有用的參數(shù)解析方法:
args.getOptionNames()
是獲取鍵值對(duì) --K=V
中的 K
args.getOptionValues("foo")
用來(lái)通過(guò) K
來(lái)獲取鍵值對(duì)的值 V
args.getSourceArgs()
等同于 CommandLineRunner
的 args
數(shù)組
args.getNonOptionArgs()
最慘用來(lái)獲取單身狗
要注意的是 解析 ApplicationArguments 時(shí)要處理空指針問(wèn)題。
今天我們通過(guò)對(duì) CommandLineRunner
和 ApplicationRunner
講解。解決了如何在 Spring Boot 啟動(dòng)時(shí)執(zhí)行一些邏輯的問(wèn)題以及如何來(lái)編排多個(gè)啟動(dòng)邏輯的優(yōu)先級(jí)順序。同時(shí)我們進(jìn)階一步,通過(guò)這兩個(gè)方法讀取 Spring Boot 啟動(dòng)項(xiàng)參數(shù)。進(jìn)而也搞清楚了這兩個(gè)接口之間的細(xì)微的區(qū)別。
看完上述內(nèi)容,是不是對(duì)Spring Boot 2如何自定義啟動(dòng)運(yùn)行邏輯有進(jìn)一步的了解,如果還想學(xué)習(xí)更多內(nèi)容,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。