第springboot應(yīng)用服務(wù)啟動事件的監(jiān)聽實(shí)現(xiàn)目錄一、簡介二、常用場景介紹二、代碼小實(shí)驗(yàn)通過@Component定義方式實(shí)現(xiàn)通過@Bean定義方式實(shí)現(xiàn)三、執(zhí)行測試四、總結(jié)五、問題總結(jié)

一、簡介

SpringBoot提供了兩個(gè)接口：CommandLineRunner、ApplicationRunner，用于啟動應(yīng)用時(shí)做特殊處理，這些代碼會在SpringApplication的run()方法運(yùn)行完成之前被執(zhí)行。相對于之前章節(jié)為大家介紹的Spring的ApplicationListener接口自定義監(jiān)聽器、Servlet的ServletContextListener監(jiān)聽器。使用二者的好處在于，可以方便的使用應(yīng)用啟動參數(shù)，根據(jù)參數(shù)不同做不同的初始化操作。

二、常用場景介紹

實(shí)現(xiàn)CommandLineRunner、ApplicationRunner接口。通常用于應(yīng)用啟動前的特殊代碼執(zhí)行，比如：

將系統(tǒng)常用的數(shù)據(jù)加載到內(nèi)存應(yīng)用上一次運(yùn)行的垃圾數(shù)據(jù)清理系統(tǒng)啟動成功后的通知的發(fā)送等

如下圖是我實(shí)現(xiàn)了CommandLineRunner接口，在應(yīng)用啟動時(shí)將系統(tǒng)內(nèi)常用的配置數(shù)據(jù)。從數(shù)據(jù)庫加載到內(nèi)存，以后使用該數(shù)據(jù)的時(shí)候只需要調(diào)用getSysConfigList方法，不需要每次使用該數(shù)據(jù)都去數(shù)據(jù)庫加載。節(jié)省系統(tǒng)資源、縮減數(shù)據(jù)加載時(shí)間。

二、代碼小實(shí)驗(yàn)通過@Component定義方式實(shí)現(xiàn)

CommandLineRunner：參數(shù)是字符串?dāng)?shù)組

@Slf4j

@Component

publicclassCommandLineStartupRunnerimplementsCommandLineRunner{

@Override

publicvoidrun(String...args){

("CommandLineRunner傳入?yún)?shù)：{}",Arrays.toString(args));

ApplicationRunner：參數(shù)被放入ApplicationArguments，通過getOptionNames()、getOptionValues()、getSourceArgs()獲取參數(shù)

@Slf4j

@Component

publicclassAppStartupRunnerimplementsApplicationRunner{

@Override

publicvoidrun(ApplicationArgumentsargs){

("ApplicationRunner參數(shù)名稱:{}",args.getOptionNames());

("ApplicationRunner參數(shù)值:{}",args.getOptionValues("age"));

("ApplicationRunner參數(shù):{}",Arrays.toString(args.getSourceArgs()));

通過@Bean定義方式實(shí)現(xiàn)

這種方式可以指定執(zhí)行順序，注意前兩個(gè)Bean是CommandLineRunner，最后一個(gè)Bean是ApplicationRunner。

@Configuration

publicclassBeanRunner{

@Bean

@Order(1)

publicCommandLineRunnerrunner1(){

returnnewCommandLineRunner(){

@Override

publicvoidrun(String...args){

System.out.println("BeanCommandLineRunnerrun1()"+Arrays.toString(args));

@Bean

@Order(2)

publicCommandLineRunnerrunner2(){

returnnewCommandLineRunner(){

@Override

publicvoidrun(String...args){

System.out.println("BeanCommandLineRunnerrun2()"+Arrays.toString(args));

@Bean

@Order(3)

publicApplicationRunnerrunner3(){

returnnewApplicationRunner(){

@Override

publicvoidrun(ApplicationArgumentsargs){

System.out.println("BeanApplicationRunnerrun3()"+Arrays.toString(args.getSourceArgs()));

可以通過@Order設(shè)置執(zhí)行順序

三、執(zhí)行測試

在IDEASpringboot啟動配置中加入如下參數(shù)，保存后啟動應(yīng)用

測試輸出結(jié)果：

c.z.boot.launch.config.AppStartupRunner:ApplicationRunner參數(shù)名稱:[name,age]

c.z.boot.launch.config.AppStartupRunner:ApplicationRunner參數(shù)值:[18]

c.z.boot.launch.config.AppStartupRunner:ApplicationRunner參數(shù):[--name=zimug,--age=18]

BeanApplicationRunnerrun3()[--name=zimug,--age=18]

c.z.b.l.config.CommandLineStartupRunner:CommandLineRunner傳入?yún)?shù)：[--name=zimug,--age=18]

BeanCommandLineRunnerrun1()[--name=zimug,--age=18]

e=18]

BeanCommandLineRunnerrun2()[--name=zimug,--age=18]

從測試結(jié)果上看（筆者目前不敢確定這個(gè)優(yōu)先級順序是不是常態(tài)，但從我的多次測試效果，順序一直是這樣的）：

ApplicationRunner執(zhí)行優(yōu)先級高于CommandLineRunner以Bean的形式運(yùn)行的Runner優(yōu)先級要低于Component注解加implementsRunner接口的方式Order注解只能保證同類的CommandLineRunner或ApplicationRunner的執(zhí)行順序，不能跨類保證順序

四、總結(jié)

CommandLineRunner、ApplicationRunner的核心用法是一致的，就是用于應(yīng)用啟動前的特殊代碼執(zhí)行。ApplicationRunner的執(zhí)行順序先于CommandLineRunner；ApplicationRunner將參數(shù)封裝成了對象，提供了獲取參數(shù)名、參數(shù)值等方法，操作上會方便一些。

五、問題總結(jié)

這是筆者在實(shí)踐中真實(shí)遇到的問題，就是我定義了多個(gè)CommandLineRunner的實(shí)現(xiàn)。出現(xiàn)奇怪的問題是：當(dāng)你定義多個(gè)CommandLineRunner的實(shí)現(xiàn)的時(shí)候，其中一個(gè)或者幾個(gè)將不會執(zhí)行。

分析一下：下面的代碼是SpringBootApplication啟動項(xiàng)目之后會執(zhí)行的代碼，大家看代碼中通過一個(gè)遍歷來啟動CommandLineRunner或者ApplicationRunner。也就是說，只有上一個(gè)CommandLineRunner執(zhí)行完成之后，才會執(zhí)行下一個(gè)CommandLineRunner，是同步執(zhí)行的。

privatevoidcallRunners(ApplicationContextcontext,ApplicationArgumentsargs){

ListObjectrunners=newArrayList();

runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());

runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());

AnnotationAwareOrderComparator.sort(runners);

for(Objectrunner:newLinkedHashSet(runners)){

if(runnerinstanceofApplicationRunner){

callRunner((ApplicationRunner)runner,args);