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 相关文章推荐
JPA如何使用entityManager执行SQL并指定返回类型
Jun 15 Java/Android
Java用自带的Image IO给图片添加水印
Jun 15 Java/Android
Java并发编程之详解CyclicBarrier线程同步
Jun 23 Java/Android
Java基于字符界面的简易收银台
Jun 26 Java/Android
详解Java分布式事务的 6 种解决方案
Jun 26 Java/Android
Java中CyclicBarrier和CountDownLatch的用法与区别
Aug 23 Java/Android
java版 简单三子棋游戏
May 04 Java/Android
Java版 简易五子棋小游戏
May 04 Java/Android
Java 数组的使用
May 11 Java/Android
springboot集成redis存对象乱码的问题及解决
Jun 16 Java/Android
springboot 全局异常处理和统一响应对象的处理方式
Jun 28 Java/Android
IDEA中sout快捷键无效问题的解决方法
Jul 23 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 方便水印和缩略图的图形类
2009/05/21 PHP
js和php邮箱地址验证的实现方法
2014/01/09 PHP
php中二维数组排序问题方法详解
2015/08/28 PHP
PHP 信号管理知识整理汇总
2017/02/19 PHP
PHP中in_array的隐式转换的解决方法
2018/03/06 PHP
javascript跨域原因以及解决方案分享
2015/04/08 Javascript
JavaScript中的闭包
2016/02/24 Javascript
html判断当前页面是否在iframe中的实例
2016/11/30 Javascript
javascript 使用正则test( )第一次是 true,第二次是false
2017/02/22 Javascript
微信小程序实现动态获取元素宽高的方法分析
2018/12/10 Javascript
详解mpvue开发微信小程序基础知识
2019/09/23 Javascript
jQuery cookie的公共方法封装和使用示例
2020/06/01 jQuery
jQuery使用jsonp实现百度搜索的示例代码
2020/07/08 jQuery
vue项目实现设置根据路由高亮对应的菜单项操作
2020/08/06 Javascript
关于element的表单组件整理笔记
2021/02/05 Javascript
python多线程用法实例详解
2015/01/15 Python
python在Windows下安装setuptools(easy_install工具)步骤详解
2016/07/01 Python
详解python3实现的web端json通信协议
2016/12/29 Python
Python 查找字符在字符串中的位置实例
2018/05/02 Python
Python爬虫实现(伪)球迷速成
2018/06/10 Python
python 按不同维度求和,最值,均值的实例
2018/06/28 Python
在mac下查找python包存放路径site-packages的实现方法
2018/11/06 Python
详解爬虫被封的问题
2019/04/23 Python
Python二维码生成识别实例详解
2019/07/16 Python
python+requests接口自动化框架的实现
2020/08/31 Python
澳大利亚购买健身器材网站:Gym Direct
2019/12/19 全球购物
策划主管的工作职责
2013/11/24 职场文书
物理专业本科生自荐信
2014/01/30 职场文书
《大江保卫战》教学反思
2014/04/11 职场文书
关于孝道的演讲稿
2014/05/21 职场文书
暑假安全教育广播稿
2014/09/10 职场文书
群众路线领导干部个人对照检查材料(集锦)
2014/09/23 职场文书
2015年纪检监察工作总结
2015/04/08 职场文书
收入证明怎么写
2015/06/12 职场文书
Java并发编程之Executor接口的使用
2021/06/21 Java/Android
Win11 Beta 预览版 22621.575 和 22622.575更新补丁KB5016694发布(附更新内容大全)
2022/08/14 数码科技