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 （本地下载）

总结

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

您可能感兴趣的文章:

Spring的事件发布与监听方式案例讲解
今天去官网查看spring boot资料时，在特性中看见了系统的事件及监听章节,所以下面这篇文章主要给大家介绍了关于SpringBoot事件发布和监听的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-03-03
Java CAS机制详解
这篇文章主要介绍了Java CAS机制，CAS机制是一种数据更新的方式。在具体讲什么是CAS机制之前，我们先来聊下在多线程环境下，对共享变量进行数据更新的两种模式：悲观锁模式和乐观锁模式
2023-01-01
Springboot集成minio实现文件存储的实现代码
MinIO 是一款基于Go语言的高性能对象存储服务，本文主要介绍了Springboot集成minio实现文件存储的实现代码，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
java数据库连接池的特点及步骤
大家好，本篇文章主要讲的是数据库连接池的特点及步骤，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下，方便下次浏览
2021-12-12
SpringBoot切面拦截@PathVariable参数及抛出异常的全局处理方式
这篇文章主要介绍了SpringBoot切面拦截@PathVariable参数及抛出异常的全局处理方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
Mybatis逆工程jar包的修改和打包
这篇文章主要介绍了Mybatis逆工程jar包的修改和打包的相关资料,需要的朋友可以参考下
2016-06-06
Spark SQL的自定义函数UDF使用
Spark Sql可以通过UDF来对DataFrame的Column进行自定义操作。在特定场景下定义UDF可能需要用到Spark Context以外的资源或数据。比如从List或Map中取值，或是通过连接池从外部的数据源中读取数据，然后再参与Column的运算
2023-02-02
Hibernate中Session.get()方法和load()方法的详细比较
今天小编就为大家分享一篇关于Hibernate中Session.get()方法和load()方法的详细比较，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-03-03
Java8到Java19的一些变化分析详解
这篇文章主要为大家介绍了Java8到Java19的一些变化分析详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-01-01
Java之NIO基本简介
这篇文章主要介绍了Java之NIO基本简介,文中给大家讲到了NIO 与 BIO的比较结合实例代码给大家介绍的非常详细，需要的朋友可以参考下
2023-05-05