springboot應用服務啟動事件的監聽實現

2022-04-06 13:01:39

一、簡介

Spring Boot提供了兩個介面：CommandLineRunner、ApplicationRunner，用於啟動應用時做特殊處理，這些程式碼會在SpringApplication的run()方法執行完成之前被執行。相對於之前章節為大家介紹的Spring的ApplicationListener介面自定義監聽器、Servlet的ServletContextListener監聽器。使用二者的好處在於，可以方便的使用應用啟動引數，根據引數不同做不同的初始化操作。

二、常用場景介紹

實現CommandLineRunner、ApplicationRunner介面。通常用於應用啟動前的特殊程式碼執行，比如：

將系統常用的資料載入到記憶體
應用上一次執行的垃圾資料清理
系統啟動成功後的通知的傳送等

如下圖是我實現了CommandLineRunner介面，在應用啟動時將系統內常用的設定資料。從資料庫載入到記憶體，以後使用該資料的時候只需要呼叫getSysConfigList方法，不需要每次使用該資料都去資料庫載入。節省系統資源、縮減資料載入時間。

二、程式碼小實驗通過@Component定義方式實現

CommandLineRunner：引數是字串陣列

@Slf4j
@Component
public class CommandLineStartupRunner implements CommandLineRunner {
    @Override
    public void run(String... args){
        log.info("CommandLineRunner傳入引數：{}", Arrays.toString(args));
    }
}

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

@Slf4j
@Component
public class AppStartupRunner implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args)  {
        log.info("ApplicationRunner引數名稱: {}", args.getOptionNames());
        log.info("ApplicationRunner引數值: {}", args.getOptionValues("age"));
        log.info("ApplicationRunner引數: {}", Arrays.toString(args.getSourceArgs()));
    }
}

通過@Bean定義方式實現

這種方式可以指定執行順序，注意前兩個Bean是CommandLineRunner，最後一個Bean是ApplicationRunner 。

@Configuration
public class BeanRunner {
    @Bean
    @Order(1)
    public CommandLineRunner runner1(){
        return new CommandLineRunner() {
            @Override
            public void run(String... args){
                System.out.println("BeanCommandLineRunner run1()" + Arrays.toString(args));
            }
        };
    }

    @Bean
    @Order(2)
    public CommandLineRunner runner2(){
        return new CommandLineRunner() {
            @Override
            public void run(String... args){
                System.out.println("BeanCommandLineRunner run2()" + Arrays.toString(args));
            }
        };
    }

    @Bean
    @Order(3)
    public ApplicationRunner runner3(){
        return new ApplicationRunner() {
            @Override
            public void run(ApplicationArguments args){
                System.out.println("BeanApplicationRunner run3()" + Arrays.toString(args.getSourceArgs()));
            }
        };
    }
}

可以通過@Order設定執行順序

三、執行測試

在IDEA Springboot啟動設定中加入如下引數，儲存後啟動應用

測試輸出結果：

c.z.boot.launch.config.AppStartupRunner : ApplicationRunner引數名稱: [name, age]
c.z.boot.launch.config.AppStartupRunner : ApplicationRunner引數值: [18]
c.z.boot.launch.config.AppStartupRunner : ApplicationRunner引數: [--name=zimug, --age=18]

BeanApplicationRunner run3()[--name=zimug, --age=18]

c.z.b.l.config.CommandLineStartupRunner : CommandLineRunner傳入引數：[--name=zimug, --age=18]
BeanCommandLineRunner run1()[--name=zimug, --age=18]
e=18]
BeanCommandLineRunner run2()[--name=zimug, --age=18]

從測試結果上看（筆者目前不敢確定這個優先順序順序是不是常態，但從我的多次測試效果，順序一直是這樣的）：

ApplicationRunner執行優先順序高於CommandLineRunner
以Bean的形式執行的Runner優先順序要低於Component註解加implements Runner介面的方式
Order註解只能保證同類的CommandLineRunner或ApplicationRunner的執行順序，不能跨類保證順序

四、總結

CommandLineRunner、ApplicationRunner的核心用法是一致的，就是用於應用啟動前的特殊程式碼執行。ApplicationRunner的執行順序先於CommandLineRunner；ApplicationRunner將引數封裝成了物件，提供了獲取引數名、引數值等方法，操作上會方便一些。

五、問題總結

這是筆者在實踐中真實遇到的問題，就是我定義了多個CommandLineRunner的實現。出現奇怪的問題是：當你定義多個CommandLineRunner的實現的時候，其中一個或者幾個將不會執行。

分析一下：下面的程式碼是SpringBootApplication啟動專案之後會執行的程式碼，大家看程式碼中通過一個遍歷來啟動CommandLineRunner或者ApplicationRunner。也就是說，只有上一個CommandLineRunner執行完成之後，才會執行下一個CommandLineRunner，是同步執行的。

private void callRunners(ApplicationContext context, ApplicationArguments args) {
		List<Object> runners = new ArrayList<>();
		runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
		runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
		AnnotationAwareOrderComparator.sort(runners);
		for (Object runner : new LinkedHashSet<>(runners)) {
			if (runner instanceof ApplicationRunner) {
				callRunner((ApplicationRunner) runner, args);
			}
			if (runner instanceof CommandLineRunner) {
				callRunner((CommandLineRunner) runner, args);
			}
		}
	}

所以，如果在CommandLineRunner某個實現run 方法體中呼叫了同步阻塞的API或者是一個 while(true) 迴圈，在遍歷中處於該CommandLineRunner之後的其他實現將不會被執行。

到此這篇關於springboot應用服務啟動事件的監聽實現的文章就介紹到這了,更多相關springboot啟動事件監聽內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！