springboot中ApplicationListener和SpringApplicationRunListener作用,区别,联系

在 Spring Boot 中，ApplicationListener 和 SpringApplicationRunListener 是两个常见的接口，它们用于监听和处理应用程序的生命周期事件。虽然它们的功能上有一定的相似性，但它们设计的目标和使用场景是不同的。以下将详细解析它们的作用、区别以及联系。

1. ApplicationListener

作用

ApplicationListener 是 Spring 框架中的核心接口，用于监听特定类型的事件。例如，当 Spring 容器中发生了一些事件时（如上下文刷新、启动、关闭等），可以通过实现 ApplicationListener 接口来捕获并处理这些事件。

主要特点

1. 基于事件机制

   • 它可以监听所有的 ApplicationEvent 以及其子类事件。

2. 适用于容器层级的事件监听

   • 它关注的是 Spring 容器中发生的生命周期事件，例如 ContextRefreshedEvent, ContextClosedEvent 等。

3. 实现方式

   • 通过实现 ApplicationListener 接口，可以在 onApplicationEvent 方法中处理事件。例如：

     public class MyApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
         @Override
         public void onApplicationEvent(ContextRefreshedEvent event) {
             System.out.println("Spring Context Refreshed");
         }
     }
     

4. 配置方式

   • 可以通过以下方式注册：
     • 直接通过 SpringApplication 注册（addListeners()）。
     • 使用 @Component 或 XML 配置方式注册到 Spring 容器中。

优势

• 简单易用，能处理 Spring 容器的事件，例如上下文加载完成、上下文关闭等。
• 传统的 Spring 事件监听器机制支持，可灵活扩展。

2. SpringApplicationRunListener

作用

SpringApplicationRunListener 是 Spring Boot 特有的接口，它用于监听 SpringApplication 的启动过程中的事件和生命周期方法。它通常被用来在应用程序初始化的不同阶段插入一些逻辑。

主要特点

1. 面向 SpringApplication 的生命周期管理

   • 它聚焦于 Spring Boot 应用启动的具体过程，并允许开发者在启动过程中定制逻辑。

2. 启动过程中的关键阶段

   • 它监听的是 Spring Boot 应用程序启动的 5 个特定阶段。
     • starting()：应用程序刚启动时触发。
     • environmentPrepared()：Environment 已准备好，但还未创建 ApplicationContext 时触发。
     • contextPrepared()：ApplicationContext 已创建，但还未刷新。
     • contextLoaded()：ApplicationContext 已加载完成，但还未刷新。
     • started()：ApplicationContext 已刷新，Spring Boot 应用启动完成。
     • running()：应用程序已启动并运行。
     • failed()：应用程序启动失败时触发。

3. 实现方式

   • 可通过实现 SpringApplicationRunListener 接口并注册到 Spring Boot 的 spring.factories 文件中进行扩展。例如：

     public class MyRunListener implements SpringApplicationRunListener {
     
         public MyRunListener(SpringApplication application, String[] args) {
             // 构造函数
         }
     
         @Override
         public void starting() {
             System.out.println("SpringApplication is starting");
         }
     
         @Override
         public void environmentPrepared(ConfigurableEnvironment environment) {
             System.out.println("Environment is prepared");
         }
     
         @Override
         public void contextPrepared(ConfigurableApplicationContext context) {
             System.out.println("Context is prepared");
         }
         
         // 其他方法...
     }
     

4. 配置方式

   • 需要在 META-INF/spring.factories 文件中注册：

     org.springframework.boot.SpringApplicationRunListener=\
     com.example.MyRunListener
     

优势

• 提供对 Spring Boot 应用启动流程的全面监控和扩展能力。
• 适用于对应用启动过程中底层细节的定制化需求。

3. 区别

4. 联系

• SpringApplicationRunListener 和 ApplicationListener 都属于监听机制，用于监听生命周期中的某些重要事件。
• 它们可以协同工作。例如：
  1. SpringApplicationRunListener 用于监听 Spring Boot 的启动阶段，并在某些阶段注入逻辑。
  2. ApplicationListener 用于接收来自容器生命周期的事件，扩展应用逻辑。
• ApplicationEvent 的广播机制也可能被用在 SpringApplicationRunListener 中。

总结

• ApplicationListener 更偏向 Spring 容器级别的事件监听，适用于监听容器初始化、刷新、关闭等事件。
• SpringApplicationRunListener 专注于 Spring Boot 启动阶段的事件，它更低层和更细粒度。
• 如果需要监听 Spring Boot 启动流程和容器生命周期，可以结合两者使用，达到对应用生命周期的全面扩展和自定义。