springboot應(yīng)用服務(wù)啟動事件的監(jiān)聽實現(xiàn)
一、簡介
Spring Boot提供了兩個接口:CommandLineRunner、ApplicationRunner,用于啟動應(yīng)用時做特殊處理,這些代碼會在SpringApplication的run()方法運行完成之前被執(zhí)行。相對于之前章節(jié)為大家介紹的Spring的ApplicationListener接口自定義監(jiān)聽器、Servlet的ServletContextListener監(jiān)聽器。使用二者的好處在于,可以方便的使用應(yīng)用啟動參數(shù),根據(jù)參數(shù)不同做不同的初始化操作。
二、常用場景介紹
實現(xiàn)CommandLineRunner、ApplicationRunner接口。通常用于應(yīng)用啟動前的特殊代碼執(zhí)行,比如:
- 將系統(tǒng)常用的數(shù)據(jù)加載到內(nèi)存
- 應(yīng)用上一次運行的垃圾數(shù)據(jù)清理
- 系統(tǒng)啟動成功后的通知的發(fā)送等
如下圖是我實現(xiàn)了CommandLineRunner接口,在應(yīng)用啟動時將系統(tǒng)內(nèi)常用的配置數(shù)據(jù)。從數(shù)據(jù)庫加載到內(nèi)存,以后使用該數(shù)據(jù)的時候只需要調(diào)用getSysConfigList方法,不需要每次使用該數(shù)據(jù)都去數(shù)據(jù)庫加載。節(jié)省系統(tǒng)資源、縮減數(shù)據(jù)加載時間。
二、代碼小實驗 通過@Component定義方式實現(xiàn)
CommandLineRunner:參數(shù)是字符串數(shù)組
@Slf4j @Component public class CommandLineStartupRunner implements CommandLineRunner { @Override public void run(String... args){ log.info("CommandLineRunner傳入?yún)?shù):{}", Arrays.toString(args)); } }
ApplicationRunner:參數(shù)被放入ApplicationArguments,通過getOptionNames()、getOptionValues()、getSourceArgs()獲取參數(shù)
@Slf4j @Component public class AppStartupRunner implements ApplicationRunner { @Override public void run(ApplicationArguments args) { log.info("ApplicationRunner參數(shù)名稱: {}", args.getOptionNames()); log.info("ApplicationRunner參數(shù)值: {}", args.getOptionValues("age")); log.info("ApplicationRunner參數(shù): {}", Arrays.toString(args.getSourceArgs())); } }
通過@Bean定義方式實現(xiàn)
這種方式可以指定執(zhí)行順序,注意前兩個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設(shè)置執(zhí)行順序
三、執(zhí)行測試
在IDEA Springboot啟動配置中加入如下參數(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]BeanApplicationRunner run3()[--name=zimug, --age=18]
c.z.b.l.config.CommandLineStartupRunner : CommandLineRunner傳入?yún)?shù):[--name=zimug, --age=18]
BeanCommandLineRunner run1()[--name=zimug, --age=18]
e=18]
BeanCommandLineRunner run2()[--name=zimug, --age=18]
從測試結(jié)果上看(筆者目前不敢確定這個優(yōu)先級順序是不是常態(tài),但從我的多次測試效果,順序一直是這樣的):
- ApplicationRunner執(zhí)行優(yōu)先級高于CommandLineRunner
- 以Bean的形式運行的Runner優(yōu)先級要低于Component注解加implements Runner接口的方式
- Order注解只能保證同類的CommandLineRunner或ApplicationRunner的執(zhí)行順序,不能跨類保證順序
四、總結(jié)
CommandLineRunner、ApplicationRunner的核心用法是一致的,就是用于應(yīng)用啟動前的特殊代碼執(zhí)行。ApplicationRunner的執(zhí)行順序先于CommandLineRunner;ApplicationRunner將參數(shù)封裝成了對象,提供了獲取參數(shù)名、參數(shù)值等方法,操作上會方便一些。
五、問題總結(jié)
這是筆者在實踐中真實遇到的問題,就是我定義了多個CommandLineRunner的實現(xiàn)。出現(xiàn)奇怪的問題是:當你定義多個CommandLineRunner的實現(xiàn)的時候,其中一個或者幾個將不會執(zhí)行。
分析一下:下面的代碼是SpringBootApplication啟動項目之后會執(zhí)行的代碼,大家看代碼中通過一個遍歷來啟動CommandLineRunner或者ApplicationRunner。也就是說,只有上一個CommandLineRunner執(zhí)行完成之后,才會執(zhí)行下一個CommandLineRunner,是同步執(zhí)行的。
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某個實現(xiàn)run 方法體中調(diào)用了同步阻塞的API或者是一個 while(true) 循環(huán),在遍歷中處于該CommandLineRunner之后的其他實現(xiàn)將不會被執(zhí)行。
到此這篇關(guān)于springboot應(yīng)用服務(wù)啟動事件的監(jiān)聽實現(xiàn)的文章就介紹到這了,更多相關(guān)springboot啟動事件監(jiān)聽內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java語言實現(xiàn)簡單的酒店前臺管理小功能(實例代碼)
這篇文章主要介紹了Java語言實現(xiàn)簡單的酒店前臺管理小功能,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-03-03Spring Boot 集成Mybatis實現(xiàn)主從(多數(shù)據(jù)源)分離方案示例
本篇文章主要介紹了Spring Boot 集成Mybatis實現(xiàn)主從(多數(shù)據(jù)源)分離方案實例,具有一定的參考價值,有興趣的可以了解一下。2017-03-03netty服務(wù)端輔助類ServerBootstrap創(chuàng)建邏輯分析
這篇文章主要介紹了netty服務(wù)端輔助類ServerBootstrap創(chuàng)建邏輯分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-03-03Spring Cloud Config配置文件使用對稱加密的方法
Spring Cloud Config提供了兩種加密解密方式,一種是對稱加密,一種是非對稱加密。這篇文章將先展示如何使用對稱加密。感興趣的朋友跟隨腳步之家小編一起學習吧2018-05-05如何使用JCTools實現(xiàn)Java并發(fā)程序
這篇文章主要介紹了如何使用JCTools實現(xiàn)Java并發(fā)程序,幫助大家更好的理解和學習使用Java,感興趣的朋友可以了解下2021-03-03SpringMVC中的@RequestMapping注解的使用詳細教程
@RequestMapping注解的作用就是將請求和處理請求的控制器方法關(guān)聯(lián)起來,建立映射關(guān)系,本文主要來和大家詳細講講它的具體使用,感興趣的可以了解一下2023-07-07java運行jar包提示?“XXX中沒有主清單屬性”?"找不到主類”兩種解決辦法
本文主要介紹了java運行jar包提示?“XXX中沒有主清單屬性”?"找不到主類”兩種解決辦法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-06-06