首頁 > Java > java教程 > springboot應用程式服務啟動事件的監聽怎麼實現

springboot應用程式服務啟動事件的監聽怎麼實現

WBOY
發布: 2023-05-16 23:10:37
轉載
2232 人瀏覽過

    一、簡介

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

    二、常用場景介紹

    實作CommandLineRunner和ApplicationRunner介面。通常用於應用啟動前的特殊程式碼執行,例如:

    • 將系統常用的資料載入到記憶體

    • 應用程式上一次運行的垃圾資料清理

    • 系統啟動成功後的通知的發送等

    #我透過實作CommandLineRunner接口,在應用程式啟動時載入了系統內常用的配置數據,如下圖所示。從資料庫載入到內存,以後使用該資料的時候只需要呼叫getSysConfigList方法,不需要每次使用該資料都去資料庫載入。節省系統資源、縮減資料載入時間。

    springboot應用程式服務啟動事件的監聽怎麼實現

    二、程式碼小實驗透過@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啟動設定中加入下列參數,儲存後啟動應用程式

    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應用程式服務啟動事件的監聽怎麼實現的詳細內容。更多資訊請關注PHP中文網其他相關文章!

    相關標籤:
    來源:yisu.com
    本網站聲明
    本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
    熱門教學
    更多>
    最新下載
    更多>
    網站特效
    網站源碼
    網站素材
    前端模板