【Spring Boot 源码学习】SpringApplication 的 run 方法监听器

2024-04-29 14:28
文章标签 java 源码 学习 方法 spring boot run 监听器 springapplication

本文主要是介绍【Spring Boot 源码学习】SpringApplication 的 run 方法监听器，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《Spring Boot 源码学习系列》

在这里插入图片描述

SpringApplication 的 run 方法监听器

  • 一、引言
  • 二、主要内容
    • 2.1 SpringApplicationRunListeners
    • 2.2 SpringApplicationRunListener
    • 2.3 实现类 EventPublishingRunListener
      • 2.3.1 成员变量和构造方法
      • 2.3.2 成员方法
        • 2.3.2.1 不同阶段的事件处理
        • 2.3.2.2 可用性状态变化事件
    • 2.4 自定义 SpringApplicationRunListener
  • 三、总结

一、引言

书接前文《SpringApplication 的 run 方法核心流程介绍》，Huazie 围绕 SpringApplication 的 run 方法，带大家一起初步了解了 Spring Boot 的核心运行流程。其中有关运行流程监听器的内容出现最多，但还未细讲。那么本篇就深入了解下 SpringApplication 的 run 方法监听器。

在这里插入图片描述

二、主要内容

注意： 以下涉及 Spring Boot 源码 均来自版本 2.7.9，其他版本有所出入，可自行查看源码。

2.1 SpringApplicationRunListeners

SpringApplication 的 run(String... args) 方法中，我们可以看到如下代码：

SpringApplicationRunListeners listeners = getRunListeners(args);

这里是获取一个 SpringApplicationRunListeners 对象，它管理了一组 SpringApplicationRunListener 的监听器集合。

继续查看 getRunListeners 方法：

private SpringApplicationRunListeners getRunListeners(String[] args) {Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };return new SpringApplicationRunListeners(logger,getSpringFactoriesInstances(SpringApplicationRunListener.class, types, this, args),this.applicationStartup);
}

可以看到 getRunListeners 方法里，直接 new 了一个 SpringApplicationRunListeners 对象并返回，它的构造函数有三个参数：

在这里插入图片描述

  • Log log ：日志对象
  • List<SpringApplicationRunListener> listeners ：监听器集合
  • ApplicationStartup applicationStartup ：应用启动指标对象，通过步骤来记录应用程序启动阶段的情况。核心容器及其基础设施组件可以使用 ApplicationStartup 来标记应用程序启动期间的步骤，并收集有关执行上下文或它们处理时间的数据。

getSpringFactoriesInstances(SpringApplicationRunListener.class, types, this, args) 方法是获取 SpringApplicationRunListener 的监听器集合，如果看过笔者前面的系列文章的朋友，应该对该方法并不陌生。

我们进入 getSpringFactoriesInstances 方法，查看如下：

在这里插入图片描述

可以看到了如下的代码 ：

SpringFactoriesLoader.loadFactoryNames(type, classLoader);

这里是通过 SpringFactoriesLoader 类的 loadFactoryNames 方法来获取 META-INF/spring.factories 中配置 key 为 org.springframework.boot.SpringApplicationRunListener 的数据；

在这里插入图片描述

有关实现类 EventPublishingRunListener 请查看 2.3 小节。

继续查看 SpringApplicationRunListeners 方法，可以看到：

在这里插入图片描述

上述标红的方法对应了 Spring Boot 运行流程的不同阶段，这些在《SpringApplication 的 run 方法核心流程介绍》都有介绍过。

以 starting 方法为例：

在这里插入图片描述
在这里插入图片描述

(listener) -> listener.starting(bootstrapContext) 是 Java 8 中引入的 Lambda 表达式写法【一种简洁的表示匿名函数（没有名称的函数）的方式】。它表示一个接受 SpringApplicationRunListener 类型参数 listener 并且不返回任何结果的函数，函数体内部调用了 listener 的 starting 方法。

Consumer 是 Java 8 中的一个函数式接口，它表示接受一个输入参数并且不返回结果的操作。也就是说，上述的 Lambda 表达式在这里被用来创建 Consumer 接口的一个实例。

在这里插入图片描述

由于 Consumer 接口只有一个抽象方法 accept，上述的 Lambda 表达式将自动实现了这个方法。在 Lambda 表达式中，(listener) 对应 accept 方法的参数，而 -> listener.starting(bootstrapContext) 则定义了当 accept 方法被调用时应该执行的操作。

this.listeners.forEach(listenerAction);

这里遍历了监听器集合中的每个监听器，并执行上述 Lambda 表达式定义的函数。

在这里插入图片描述

2.2 SpringApplicationRunListener

SpringApplicationRunListener 提供了一系列运行流程中回调的方法，如下图所示：

在这里插入图片描述

下面来逐一介绍下【其中一些标注了 @Deprecated 的方法，即表示当前版本废弃的方法】：

  • starting：当 run 方法第一次被执行时，会被立即调用，可用于非常早期的初始化工作。
  • environmentPrepared：当 environment 准备完成，在 ApplicationContext 创建之前，该方法被调用。
  • contextPrepared：当 ApplicationContext 构建完成，资源还未被加载时，该方法被调用。
  • contextLoaded：当 ApplicationContext 加载完成，未被刷新之前，该方法被调用。
  • started：当 ApplicationContext 刷新并启动之后， CommandLineRunner 和 ApplicationRunner 未被调用之前，该方法被调用。
  • ready：当应用程序上下文已刷新，并且所有的 CommandLineRunner 和 ApplicationRunner 都已被调用后，run 方法完成之前，该方法被立即调用。
  • running：同 ready 方法，在当前版本已被废弃。
  • failed：当应用程序出现错误时，该方法被调用。

2.3 实现类 EventPublishingRunListener

EventPublishingRunListener 是 Spring Boot 中 SpringApplicationRunListener 接口的唯一内部实现。

2.3.1 成员变量和构造方法

先来看看它的成员变量和构造方法：

在这里插入图片描述

EventPublishingRunListener 有三个成员变量：

  • SpringApplication application：当前运行的 SpringApplication 实例
  • String[] args：启动应用程序时的命令参数
  • SimpleApplicationEventMulticaster initialMulticaster：事件广播器的简单实现，它会将所有事件多播给所有已注册的监听器，由监听器自身决定是否忽略它们不感兴趣的事件。

EventPublishingRunListener 的构造方法中初始化上述三个变量之后，就会遍历 SpringApplication 中的所有 ApplicationListener 实例，并将它们和 SimpleApplicationEventMulticaster 进行关联，以便后续将事件多播给所有已注册的监听器。

2.3.2 成员方法

在这里插入图片描述
在这里插入图片描述

2.3.2.1 不同阶段的事件处理

通过阅读上述源码，可以大致总结一下 Spring Boot 启动运行的不同阶段的事件处理流程：

  • 首先，Spring Boot 应用程序启动的某个阶段，调用 EventPublishingRunListener 的某个方法；
  • 然后，在这些方法中，将 application 参数和 args 参数【某些事件还有其他参数】封装到对应的事件中，这些事件都是 SpringApplicationEvent 的实现类；
  • 接着，通过成员变量 initialMulticaster 的 multicastEvent 方法对指定事件进行广播 或者 通过当前方法的应用上下文参数 context 的 publishEvent 方法来对事件进行发布；
  • 最后，对应的事件监听器 ApplicationListener 被触发，执行相应的业务逻辑。

细心的朋友，可能发现了，上述 EventPublishingRunListener 的某些方法是通过成员变量 initialMulticaster 的 multicastEvent 方法对指定事件进行广播，而某些方法是通过当前方法的应用上下文参数 context 的 publishEvent 方法来对事件进行发布。

那这是为啥呢？

在解答这个问题之前，我们先来看下 EventPublishingRunListener 的 contextLoaded 方法，如下所示：

在这里插入图片描述

大致总结一下 contextLoaded 方法的处理逻辑：

  • 遍历 application 的所有监听器实现类，如果该实现类还实现了 ApplicationContextAware 接口，则将上下文信息设置到该监听器内；
  • 将 application 中的监听器实现类都添加到应用上下文中；
  • 通过成员变量 initialMulticaster 的 multicastEvent 方法对 ApplicationPreparedEvent 事件进行广播。

仔细查看上述源码，我们发现在 contextLoaded 方法之前，都是通过 initialMulticaster 的 multicastEvent 方法进行事件广播的，而在 contextLoaded 方法之后均采用当前方法的应用上下文参数 context 的 publishEvent 方法来对事件进行发布的。

现在可以回答上面的疑问了。因为只有调用 contextLoaded 方法之后，应用上下文才算初始化完成，这时才可以通过它的 publishEvent 方法来进行事件的发布。

2.3.2.2 可用性状态变化事件

在 started 和 ready 方法的实现中，我们还看到 AvailabilityChangeEvent 的调用。

AvailabilityChangeEvent ，即应用程序可用性状态变化事件。任何应用程序组件都可以发送这些事件以更新应用程序的状态。

// started
AvailabilityChangeEvent.publish(context, LivenessState.CORRECT);

started 方法发布了一个 LivenessState.CORRECT 类型的可用性状态变化事件。LivenessState 是一个表示可用性状态的枚举类型，其中 CORRECT 表示应用程序正在运行，其内部状态是正确的。它还有一个 BROKEN 的枚举类型，表示应用程序正在运行，但其内部状态已损坏。

// ready
AvailabilityChangeEvent.publish(context, ReadinessState.ACCEPTING_TRAFFIC);

ready 方法发布了一个 ReadinessState.ACCEPTING_TRAFFIC 类型的可用性状态变化事件。ReadinessState 也是一个可用性状态的枚举类型，其中 ACCEPTING_TRAFFIC 表示应用程序已准备好接收流量。它还有一个 REFUSING_TRAFFIC 的枚举类型，表示应用程序不愿意接收流量。

2.4 自定义 SpringApplicationRunListener

了解了这么多关于 SpringApplication 的 run 方法监听器的内容，现在让我们来自定义 SpringApplicationRunListener 的接口实现看看，如下所示：

import org.springframework.boot.ConfigurableBootstrapContext;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.SpringApplicationRunListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;import java.time.Duration;public class DemoRunListener implements SpringApplicationRunListener {public DemoRunListener(SpringApplication application, String[] args) {System.out.println("DemoRunListener的构造方法被调用");}@Overridepublic void starting(ConfigurableBootstrapContext bootstrapContext) {System.out.println("DemoRunListener的 starting 方法被调用");}@Overridepublic void environmentPrepared(ConfigurableBootstrapContext bootstrapContext, ConfigurableEnvironment environment) {System.out.println("DemoRunListener的 environmentPrepared 方法被调用");}@Overridepublic void contextPrepared(ConfigurableApplicationContext context) {System.out.println("DemoRunListener的 contextPrepared 方法被调用");}@Overridepublic void contextLoaded(ConfigurableApplicationContext context) {System.out.println("DemoRunListener的 contextLoaded 方法被调用");}@Overridepublic void started(ConfigurableApplicationContext context, Duration timeTaken) {System.out.println("DemoRunListener的 started 方法被调用");}@Overridepublic void ready(ConfigurableApplicationContext context, Duration timeTaken) {System.out.println("DemoRunListener的 ready 方法被调用");}@Overridepublic void failed(ConfigurableApplicationContext context, Throwable exception) {System.out.println("DemoRunListener的 failed 方法被调用");}
}

上述 DemoRunListener 类定义好了之后，我们就可以在 resources 目录下的 META-INF 目录下的 spring.factories 文件中添加如下配置【如果对应的目录和文件没有，则需要自行创建】：

在这里插入图片描述

到这一步，我们就可以启动自己的 Spring Boot 项目，运行结果如下截图：

在这里插入图片描述

从上图中，可以看到不同的启动运行阶段，分别打印了不同的日志出来，说明我们自定义的实现类生效了。

三、总结

本篇博文 Huazie 同大家一起深入分析了 SpringApplication 的 run 方法监听器，从配置的加载，接口定义，实现类等方面作了详细了解，最后通过自定义 SpringApplicationRunListener 接口实现并运行查看，进一步加深了理解。

这篇关于【Spring Boot 源码学习】SpringApplication 的 run 方法监听器的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/946338。

相关文章

Spring三级缓存解决循环依赖的解析过程

Spring三级缓存解决循环依赖的解析过程

《Spring三级缓存解决循环依赖的解析过程》：本文主要介绍Spring三级缓存解决循环依赖的解析过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、循环依赖场景二、三级缓存定义三、解决流程（以ServiceA和ServiceB为例）四、关键机制详解五、设计约
阅读更多...
spring IOC的理解之原理和实现过程

spring IOC的理解之原理和实现过程

《springIOC的理解之原理和实现过程》：本文主要介绍springIOC的理解之原理和实现过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、IoC 核心概念二、核心原理1. 容器架构2. 核心组件3. 工作流程三、关键实现机制1. Bean生命周期2.
阅读更多...
解决tomcat启动时报Junit相关错误java.lang.ClassNotFoundException: org.junit.Test问题

解决tomcat启动时报Junit相关错误java.lang.ClassNotFoundException: org.junit.Test问题

《解决tomcat启动时报Junit相关错误java.lang.ClassNotFoundException:org.junit.Test问题》：本文主要介绍解决tomcat启动时报Junit相... 目录tomcat启动时报Junit相关错误Java.lang.ClassNotFoundException
阅读更多...
Gradle下如何搭建SpringCloud分布式环境

Gradle下如何搭建SpringCloud分布式环境

《Gradle下如何搭建SpringCloud分布式环境》：本文主要介绍Gradle下如何搭建SpringCloud分布式环境问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录Gradle下搭建SpringCloud分布式环境1.idea配置好gradle2.创建一个空的gr
阅读更多...
JVM垃圾回收机制之GC解读

JVM垃圾回收机制之GC解读

《JVM垃圾回收机制之GC解读》：本文主要介绍JVM垃圾回收机制之GC,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、死亡对象的判断算法1.1 引用计数算法1.2 可达性分析算法二、垃圾回收算法2.1 标记-清除算法2.2 复制算法2.3 标记-整理算法2.4
阅读更多...
nginx负载均衡及详细配置方法

nginx负载均衡及详细配置方法

《nginx负载均衡及详细配置方法》Nginx作为一种高效的Web服务器和反向代理服务器,广泛应用于网站的负载均衡中,：本文主要介绍nginx负载均衡及详细配置,需要的朋友可以参考下... 目录一、 nginx负载均衡策略1.1 基本负载均衡策略1.2 第三方策略1.3 策略对比二、 nginx配置2.1
阅读更多...
springboot集成Lucene的详细指南

springboot集成Lucene的详细指南

《springboot集成Lucene的详细指南》这篇文章主要为大家详细介绍了springboot集成Lucene的详细指南,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起... 目录添加依赖创建配置类创建实体类创建索引服务类创建搜索服务类创建控制器类使用示例以下是 Spring
阅读更多...
Java调用Python的四种方法小结

Java调用Python的四种方法小结

《Java调用Python的四种方法小结》在现代开发中,结合不同编程语言的优势往往能达到事半功倍的效果,本文将详细介绍四种在Java中调用Python的方法,并推荐一种最常用且实用的方法,希望对大家有... 目录一、在Java类中直接执行python语句二、在Java中直接调用Python脚本三、使用Run
阅读更多...
Java根据IP地址实现归属地获取

Java根据IP地址实现归属地获取

《Java根据IP地址实现归属地获取》Ip2region是一个离线IP地址定位库和IP定位数据管理框架,这篇文章主要为大家详细介绍了Java如何使用Ip2region实现根据IP地址获取归属地,感兴趣... 目录一、使用Ip2region离线获取1、Ip2region简介2、导包3、下编程载xdb文件4、J
阅读更多...
Android实现一键录屏功能(附源码)

Android实现一键录屏功能(附源码)

《Android实现一键录屏功能(附源码)》在Android5.0及以上版本,系统提供了MediaProjectionAPI,允许应用在用户授权下录制屏幕内容并输出到视频文件,所以本文将基于此实现一个... 目录一、项目介绍二、相关技术与原理三、系统权限与用户授权四、项目架构与流程五、环境配置与依赖六、完整
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2