Spring Boot应用事件监听示例详解

更新时间：2018年12月04日 17:06:35 作者：wiselyman

这篇文章主要给大家介绍了关于Spring Boot应用事件监听的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

前言

本文主要给大家介绍了关于Spring Boot应用事件监听的相关内容，分享出来供大家参考学习，下面话不多说了，来一起看看详细的介绍吧

1. Spring Boot特有的应用事件

除了Spring框架的事件，Spring Boot的SpringApplication也发送了一些自己的事件：

ApplicationStartingEvent:在任何处理(除了注册listener和initializer)开始之前发送。
ApplicationEnvironmentPreparedEvent: 在context创建之前，而用到context中的Environment已经被识别时发送。
ApplicationContextInitializedEvent: SpringApplication正在启动，ApplicationContext已准备好且ApplicationContextInitializer已被调用但是bean的定义还没有被加载时发送。
ApplicationPreparedEvent: 在context刷新之前，在bean的定义已经被加载之后调用。
ApplicationStartedEvent: 在任何应用和command-line runner调用之前，而context已经被刷新时发送。
ApplicationReadyEvent: 在任何应用和command-line runner被调用的时候发送，它意味着应用可以接受请求了。
ApplicationFailedEvent: 在启动时有异常的时候发送。

有些事件是在ApplicationContext创建之前触发的，所以我们不能用常规的注册成bean的事件监听方式：

注解了@EventListener注解分方法的类注册的bean；
实现了ApplicationListener<Event>接口的类注册的bean。

像ApplicationStartedEvent和ApplicationReadyEvent是ApplicationContext创建之后触发的，可以用上述两种方式来监听事件。

2. 如何监听这些事件

我们可以通过下面的方式注册监听：

2.1. SpringApplication.addListeners(...)

SpringApplication application = new SpringApplication(StartEventsApplication.class);
application.addListeners(
  (ApplicationListener<ApplicationStartingEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
  (ApplicationListener<ApplicationEnvironmentPreparedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
  (ApplicationListener<ApplicationContextInitializedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
  (ApplicationListener<ApplicationPreparedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
  (ApplicationListener<ApplicationStartedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
  (ApplicationListener<ApplicationReadyEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName())
);
application.run(args);

2.2. SpringApplicationBuilder.listeners(...)

new SpringApplicationBuilder()
   .sources(StartEventsApplication.class)
   .listeners(
     (ApplicationListener<ApplicationStartingEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
     (ApplicationListener<ApplicationEnvironmentPreparedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
     (ApplicationListener<ApplicationContextInitializedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
     (ApplicationListener<ApplicationPreparedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
     (ApplicationListener<ApplicationStartedEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName()),
     (ApplicationListener<ApplicationReadyEvent>) event -> log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName())
     )
   .run(args);

2.3. META-INF/spring.factories

src/main/resources/META-INF/spring.factories：

org.springframework.context.ApplicationListener=top.wisely.startevents.listeners.ApplicationContextInitializedEventListener, \
            top.wisely.startevents.listeners.ApplicationEnvironmentPreparedEventListener, \
            top.wisely.startevents.listeners.ApplicationPreparedEventListener, \
            top.wisely.startevents.listeners.ApplicationReadyEventListener, \
            top.wisely.startevents.listeners.ApplicationStartedEventListener, \
            top.wisely.startevents.listeners.ApplicationStartingEventListener

监听器只需实现ApplicationListener<要监听的接口类型>接口，无需手动注册为bean:

public class ApplicationStartedEventListener implements ApplicationListener<ApplicationStartedEvent> {
 @Override
 public void onApplicationEvent(ApplicationStartedEvent event) {
  log.info("----------- 监听Spring Boot:" + event.getClass().getSimpleName());
 }
}

3. 源码地址

https://github.com/wiselyman/spring-boot-application-events.git （本地下载）

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

java获取Date类型的年份实例代码
这篇文章主要给大家介绍了关于java如何获取Date类型的年份,针对java获取Date时间的各种方式汇总,有常用的时间获取方式,还有一些其他特殊时间获取方式,需要的朋友可以参考下
2024-06-06
java中字符进行全角半角转换示例代码
全角：指一个字符占用两个标准字符位置，而半角：指一字符占用一个标准的字符位置，在日常开发中经常会遇到全角半角转换的要求，下面这篇文章主要给大家介绍了关于java中字符进行全角半角转换的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下。
2017-08-08
maven package后Idea项目中找不到target文件的解决
在Idea中执行mavenpackage打包后,target文件不显示,点击「ShowinExplore」可以在本地文件夹中查到,解决方法：在Idea的Maven工具窗口中,右键点击项目,选择Reimport,刷新项目即可
2024-11-11
java代码效率优化方法(推荐)
下面小编就为大家带来一篇java代码效率优化方法(推荐)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-01-01
SpringBoot项目启动报错：命令行太长解决的两种解决方法
SpringBoot项目启动时可能会遇到命令行太长的错误,本文介绍两种解决方法修改.idea\workspace.xml文件和执行maven的clean命令或重启IDEA,这些操作可以有效解决启动问题,需要的朋友可以参考下
2024-10-10
MybatisPlus多表连接查询的问题及解决方案
MybatisPlus官方并没有提供多表连接查询的通用解决方案，然而连接查询是相当普遍的需求，今天通过本文给大家介绍下MybatisPlus多表连接查询的问题及解决方案，感兴趣的朋友一起看看吧
2022-01-01
Java 深入探究讲解简单工厂模式
简单工厂模式是属于创建型模式，又叫做静态工厂方法（Static Factory Method）模式，但不属于23种GOF设计模式之一。简单工厂模式是由一个工厂对象决定创建出哪一种产品类的实例。简单工厂模式是工厂模式家族中最简单实用的模式，可以理解为是不同工厂模式的一个特殊实现
2022-04-04
一文彻底吃透SpringMVC中的转发和重定向
大家应该都知道springmvc本来就会把返回的字符串作为视图名解析,然后转发到对应的视图,这篇文章主要给大家介绍了关于SpringMVC中转发和重定向的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-04-04
java的三种随机数生成方式的实现方法
这篇文章主要介绍了java的三种随机数生成方式的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-09-09
详解SpringBoot 处理异常的几种常见姿势
这篇文章主要介绍了详解SpringBoot 处理异常的几种常见姿势，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-08-08

Spring Boot应用事件监听示例详解

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具