springboot应用服务启动事件的监听实现


Posted in Java/Android onApril 06, 2022

一、简介

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应用服务启动事件的监听实现的文章就介绍到这了,更多相关springboot启动事件监听内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Java/Android 相关文章推荐
Spring Data JPA使用JPQL与原生SQL进行查询的操作
Jun 15 Java/Android
启动Tomcat时出现大量乱码的解决方法
Jun 21 Java/Android
分析设计模式之模板方法Java实现
Jun 23 Java/Android
分析并发编程之LongAdder原理
Jun 29 Java/Android
新手初学Java网络编程
Jul 07 Java/Android
使用@Value值注入及配置文件组件扫描
Jul 09 Java/Android
java objectUtils 使用可能会出现的问题
Feb 28 Java/Android
详解Flutter和Dart取消Future的三种方法
Apr 07 Java/Android
Java Lambda表达式常用的函数式接口
Apr 07 Java/Android
Java Spring Lifecycle的使用
May 06 Java/Android
java实现自定义时钟并实现走时功能
Jun 21 Java/Android
springboot 全局异常处理和统一响应对象的处理方式
Jun 28 Java/Android
Java十分钟精通进阶适配器模式
mapstruct的用法之qualifiedByName示例详解
Apr 06 #Java/Android
Spring Boot项目传参校验的最佳实践指南
springboot入门 之profile设置方式
Apr 04 #Java/Android
Java实现经典游戏泡泡堂的示例代码
Dubbo+zookeeper搭配分布式服务的过程详解
SpringBoot整合minio快速入门教程(代码示例)
Apr 03 #Java/Android
You might like
PHP魔术方法__GET、__SET使用实例
2014/11/25 PHP
CI框架源码解读之利用Hook.php文件完成功能扩展的方法
2016/05/18 PHP
PHP实现模拟http请求的方法分析
2017/12/20 PHP
网页开发中的容易忽略的问题 javascript HTML中的table
2009/04/15 Javascript
JavaScript DOM学习第八章 表单错误提示
2010/02/19 Javascript
Jquery AJAX POST与GET之间的区别
2013/11/14 Javascript
Jquery中children与find之间的区别详细解析
2013/11/29 Javascript
iPhone手机上搭建nodejs服务器步骤方法
2015/07/06 NodeJs
javascript Slip.js实现整屏滑动的手机网页
2015/11/25 Javascript
基于JavaScript获取鼠标位置的各种方法
2015/12/16 Javascript
jQuery Timelinr实现垂直水平时间轴插件(附源码下载)
2016/02/16 Javascript
BootStrap下拉框在firefox浏览器界面不友好的解决方案
2016/08/18 Javascript
BootStrap中
2016/12/10 Javascript
bootstrap laydate日期组件使用详解
2017/01/04 Javascript
easyui datebox 时间限制,datebox开始时间限制结束时间,datebox截止日期比起始日期大的实现代码
2017/01/12 Javascript
Vue.js列表渲染绑定jQuery插件的正确姿势
2017/06/29 jQuery
vue.js中父组件调用子组件的内部方法示例
2017/10/22 Javascript
Vue.js devtool插件安装后无法使用的解决办法
2017/11/27 Javascript
Angular实现的简单查询天气预报功能示例
2017/12/27 Javascript
对类Vue的MVVM前端库的实现代码
2018/09/07 Javascript
如何给element添加一个抽屉组件的方法步骤
2019/07/14 Javascript
JavaScript实现HTML导航栏下拉菜单
2020/11/25 Javascript
浅谈Python程序与C++程序的联合使用
2015/04/07 Python
CentOS下Python3的安装及创建虚拟环境的方法
2018/11/28 Python
解决Python正则表达式匹配反斜杠''\''问题
2019/07/17 Python
解决pytorch GPU 计算过程中出现内存耗尽的问题
2019/08/19 Python
python 多进程队列数据处理详解
2019/12/23 Python
Python如何实现远程方法调用
2020/08/07 Python
iHerb台湾:维生素、保健品和健康产品
2018/01/31 全球购物
Notino法国:购买香水和化妆品
2019/04/15 全球购物
给校长的一封检讨书
2014/09/20 职场文书
企业法人代表授权委托书
2014/10/02 职场文书
《怀念母亲》教学反思
2016/02/19 职场文书
react 项目中引入图片的几种方式
2021/06/02 Javascript
Mysql数据库表中为什么有索引却没有提高查询速度
2022/02/24 MySQL
Alexa停服!网站排名将何去何从?目前还没有替代品。
2022/04/15 杂记