Spring 事件监听机制源码

简介: Spring 提供了事件发布订阅机制,广泛应用于项目中。本文介绍了如何通过自定义事件类、订阅类和发布类实现这一机制,并展示了如何监听 SpringBoot 启动过程中的多个事件(如 `ApplicationStartingEvent`、`ApplicationEnvironmentPreparedEvent` 等)。通过掌握这些事件,可以更好地理解 SpringBoot 的启动流程。示例代码展示了从事件发布到接收的完整过程。

Spring 事件发布订阅机制

Spring 提供了许多非常好用的机制,比如IOC,AOP。这些几乎在所有的Spring项目中都有广泛的使用,这里讲解的是Spring提供的事件发布订阅机制,掌握发布订阅设计模式可以更好的在项目中对功能进行设计,也多一种解决方案。同时如果你掌握了SpringBoot的事件发布的全部流程,你就掌握了SpringBoot在整个启动过程中干了什么事,走了哪些流程

使用案例

事件类

scala

代码解读

复制代码

public class MyEvent extends ApplicationEvent {
    public MyEvent(Object source) {
        super(source);
    }
}

订阅类

typescript

代码解读

复制代码

@Component
public class MyEventSubscribe implements ApplicationListener<MyEvent> {
    @Override
    public void onApplicationEvent(MyEvent event) {
        String msg = (String) event.getSource();
        System.out.println("我接受到了事件,msg: "+msg);
    }
}

发布类

java

代码解读

复制代码

@Component
public class MyTest implements CommandLineRunner {
    @Autowired
    ApplicationEventPublisher applicationEventPublisher;

    @Override
    public void run(String... args) throws Exception {
        applicationEventPublisher.publishEvent(new MyEvent("hello event"));

    }
}

Log输出

vbnet

代码解读

复制代码

2024-09-25 14:44:23.852  INFO 22492 --- [           main] c.c.s.SpringResCode1Application          : Starting SpringResCode1Application using Java 1.8.0_202 on TCN1214966 with PID 22492 (D:\code\java\springResCode1\target\classes started by changtao.deng in D:\code\java\springResCode1)
2024-09-25 14:44:23.858  INFO 22492 --- [           main] c.c.s.SpringResCode1Application          : No active profile set, falling back to 1 default profile: "default"
我接受到了事件,msg: hello event
2024-09-25 14:44:24.555  INFO 22492 --- [           main] c.c.s.SpringResCode1Application          : Started SpringResCode1Application in 1.243 seconds (JVM running for 2.426)

除了自定义事件以外,你还可以监听SpringBoot 应用在启动过程中的发布的事件

typescript

代码解读

复制代码

@Component
public class MyEventSubscribe {

    @EventListener
    public void handleMyEvent1(ApplicationStartingEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ApplicationStartingEvent事件,msg: " + source);
    }

    @EventListener
    public void handleMyEvent2(ApplicationEnvironmentPreparedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ApplicationEnvironmentPreparedEvent事件,msg: " + source);
    }

    @EventListener
    public void handleMyEvent3(ApplicationContextInitializedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ApplicationContextInitializedEvent事件,msg: " + source);
    }

    @EventListener
    public void handleMyEvent4(ApplicationPreparedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ApplicationPreparedEvent事件,msg: " + source);
    }

    @EventListener
    public void handleMyEvent6(ContextRefreshedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ContextRefreshed事件,msg: " + source);
    }
    
    @EventListener
    public void handleMyEvent5(ApplicationStartedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ApplicationStartedEvent事件,msg: " + source);
    }

    @EventListener
    public void handleMyEvent7(ContextClosedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ContextClosed事件,msg: " + source);
    }

    @EventListener
    public void handleMyEvent8(ContextStoppedEvent event) {
        Object source = event.getSource();
        System.out.println("我接受到了ContextStopped事件,msg: " + source);
    }
}

我这里还不是完全列举就写了八个事件,还是比较多的,那让我们执行下

vbnet

代码解读

复制代码

2024-09-25 15:20:39.298  INFO 12724 --- [           main] c.c.s.SpringResCode1Application          : No active profile set, falling back to 1 default profile: "default"
我接受到了ContextRefreshed事件,msg: org.springframework.context.annotation.AnnotationConfigApplicationContext@14cd1699, started on Wed Sep 25 15:20:39 CST 2024
2024-09-25 15:20:40.093  INFO 12724 --- [           main] c.c.s.SpringResCode1Application          : Started SpringResCode1Application in 1.272 seconds (JVM running for 2.278)
我接受到了ApplicationStartedEvent事件,msg: org.springframework.boot.SpringApplication@5f0e9815
我接受到了ContextClosed事件,msg: org.springframework.context.annotation.AnnotationConfigApplicationContext@14cd1699, started on Wed Sep 25 15:20:39 CST 2024

Process finished with exit code 0

并没有全部触发,只触发了ContextRefreshed,ApplicationStarted 以及最后的ContextClosed。

这里就先简单讲下这些事件

  1. ApplicationStartingEvent
  • 在运行开始时发送,但在任何处理开始之前。此时,监听器和初始化器还未被注册。
  1. ApplicationEnvironmentPreparedEvent
  • 在环境准备好后发送,但在创建 ApplicationContext 之前。这时,Environment 已经准备好,可以用于配置和处理。
  1. ApplicationContextInitializedEvent
  • ApplicationContext 初始化完成后发送,但在刷新之前。此时,所有的 ApplicationContextInitializer 已经被调用。
  1. ApplicationPreparedEvent
  • ApplicationContext 准备完成后发送,但在刷新之前。此时,所有的 Bean 定义已经加载,但尚未实例化。
  1. ApplicationStartedEvent
  • ApplicationContext 刷新并启动完成后发送。这标志着应用程序已经完全启动并准备好处理请求。
  1. ContextRefreshedEvent
  • ApplicationContext 完成刷新时发送。此时,所有的单例 Bean 已经被实例化并且已完成初始化。
  1. ContextStoppedEvent
  • ApplicationContext 停止时发送。此事件需要显式调用 stop() 方法。
  1. ContextClosedEvent
  • ApplicationContext 关闭时发送。这通常在 JVM 关闭或显式调用 close() 方法时发生。

因为我们的Bean是通过@Component注解来进行IOC注入的,所以上下文没有完成所有的Bean注入前的事件这个监听器是监听不到的,也就是ApplicationStartedEvent 之前的事件无法监听到。那有没有办法监听更前面的事件呢,其实也有,那就是通过SPI的方式进行注入,因为SPI的注入会在SpringContext的构造方法中就进行执行。

转载来源:https://juejin.cn/post/7418237666396946469

相关文章
|
23天前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
60 2
|
1月前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
29天前
|
前端开发 Java 开发者
Spring生态学习路径与源码深度探讨
【11月更文挑战第13天】Spring框架作为Java企业级开发中的核心框架,其丰富的生态系统和强大的功能吸引了无数开发者的关注。学习Spring生态不仅仅是掌握Spring Framework本身,更需要深入理解其周边组件和工具,以及源码的底层实现逻辑。本文将从Spring生态的学习路径入手,详细探讨如何系统地学习Spring,并深入解析各个重点的底层实现逻辑。
53 9
|
3月前
|
缓存 Java 开发工具
Spring是如何解决循环依赖的?从底层源码入手,详细解读Spring框架的三级缓存
三级缓存是Spring框架里,一个经典的技术点,它很好地解决了循环依赖的问题,也是很多面试中会被问到的问题,本文从源码入手,详细剖析Spring三级缓存的来龙去脉。
217 24
Spring是如何解决循环依赖的?从底层源码入手,详细解读Spring框架的三级缓存
|
3月前
|
缓存 安全 Java
Spring框架中Bean是如何加载的?从底层源码入手,详细解读Bean的创建流程
从底层源码入手,通过代码示例,追踪AnnotationConfigApplicationContext加载配置类、启动Spring容器的整个流程,并对IOC、BeanDefinition、PostProcesser等相关概念进行解释
273 24
Spring框架中Bean是如何加载的?从底层源码入手,详细解读Bean的创建流程
|
3月前
|
XML 缓存 Java
手写Spring源码(简化版)
Spring包下的类、手写@ComponentScan注解、@Component注解、@Autowired注解、@Scope注解、手写BeanDefinition、BeanNameAware、InitializingBean、BeanPostProcessor 、手写AnnotationConfigApplicationContext
手写Spring源码(简化版)
|
2月前
|
Java Spring
Spring底层架构源码解析(三)
Spring底层架构源码解析(三)
135 5
|
2月前
|
XML Java 数据格式
Spring底层架构源码解析(二)
Spring底层架构源码解析(二)
|
2月前
|
Java Spring 容器
Spring IOC、AOP与事务管理底层原理及源码解析
【10月更文挑战第1天】Spring框架以其强大的控制反转(IOC)和面向切面编程(AOP)功能,成为Java企业级开发中的首选框架。本文将深入探讨Spring IOC和AOP的底层原理,并通过源码解析来揭示其实现机制。同时,我们还将探讨Spring事务管理的核心原理,并给出相应的源码示例。
137 9
|
2月前
|
缓存 Java Spring
源码解读:Spring如何解决构造器注入的循环依赖?
本文详细探讨了Spring框架中的循环依赖问题,包括构造器注入和字段注入两种情况,并重点分析了构造器注入循环依赖的解决方案。文章通过具体示例展示了循环依赖的错误信息及常见场景,提出了三种解决方法:重构代码、使用字段依赖注入以及使用`@Lazy`注解。其中,`@Lazy`注解通过延迟初始化和动态代理机制有效解决了循环依赖问题。作者建议优先使用`@Lazy`注解,并提供了详细的源码解析和调试截图,帮助读者深入理解其实现机制。
57 1