Spring-Boot-深入剖析SpringApplicationRunListener
Spring Boot 深入剖析：SpringApplicationRunListener
在研究SpringBoot的启动源码的时候我们看到run方法中有一个之前没见过的类SpringApplicationRunListeners 类，那么这个类的主要作用是什么呢？接下来我们来解析一下这个类
public ConfigurableApplicationContext run(String... args) {
、、、、、、
SpringApplicationRunListeners listeners = getRunListeners(args);
listeners.starting(bootstrapContext, this.mainApplicationClass);
、、、、、、
}SpringApplicationRunListeners
当我们点开SpringApplicationRunListeners查看其源码的时候我们发现，SpringApplicationRunListeners内部含有一个集合用来存储SpringApplicationRunListener类对象。同时大部分方法的模式都是调用doWithListeners方法，区别在于传递的参数不同。其实这些大部分的方法都是事件发布的方法，而他的那个集合SpringApplicationRunListener对象则是事件监听对象，因此这个类整体的作用我们就有了一个大概的了解–当内部的不同方法被调用的时候则会发布事件给SpringApplicationRunListener对象，而SpringApplicationRunListener对象收到事件后则会做出对应的处理
class SpringApplicationRunListeners {
private final Log log;
private final List<SpringApplicationRunListener> listeners;
private final ApplicationStartup applicationStartup;
SpringApplicationRunListeners(Log log, List<SpringApplicationRunListener> listeners,
ApplicationStartup applicationStartup) {
this.log = log;
this.listeners = List.copyOf(listeners);
this.applicationStartup = applicationStartup;
}
void starting(ConfigurableBootstrapContext bootstrapContext, Class<?> mainApplicationClass) {
doWithListeners("spring.boot.application.starting", (listener) -> listener.starting(bootstrapContext),
(step) -> {
if (mainApplicationClass != null) {
step.tag("mainApplicationClass", mainApplicationClass.getName());
}
});
}
void environmentPrepared(ConfigurableBootstrapContext bootstrapContext, ConfigurableEnvironment environment) {
doWithListeners("spring.boot.application.environment-prepared",
(listener) -> listener.environmentPrepared(bootstrapContext, environment));
}
void contextPrepared(ConfigurableApplicationContext context) {
doWithListeners("spring.boot.application.context-prepared", (listener) -> listener.contextPrepared(context));
}
void contextLoaded(ConfigurableApplicationContext context) {
doWithListeners("spring.boot.application.context-loaded", (listener) -> listener.contextLoaded(context));
}
、、、、、、
private void doWithListeners(String stepName, Consumer<SpringApplicationRunListener> listenerAction) {
doWithListeners(stepName, listenerAction, null);
}
private void doWithListeners(String stepName, Consumer<SpringApplicationRunListener> listenerAction,
Consumer<StartupStep> stepAction) {
StartupStep step = this.applicationStartup.start(stepName);
this.listeners.forEach(listenerAction);
if (stepAction != null) {
stepAction.accept(step);
}
step.end();
}
}下面我们挑两个主要方法来进行解析
void environmentPrepared(ConfigurableBootstrapContext bootstrapContext, ConfigurableEnvironment environment) {
doWithListeners("spring.boot.application.environment-prepared",
(listener) -> listener.environmentPrepared(bootstrapContext, environment));
}可以看到大部分的事件发布方法本质都是调用了doWithListeners，同时传递的第一个参数的事件类型不同标志着不同事件的触发，第二个参数则是使用了函数接口生成一个类对象传递给这个方法。
整个类的关键则是在第二个方法，doWithListeners首先则是采用了StartupStep 统计每个步骤的耗时，然后利用了 Java 8 的函数式编程特性遍历了listeners集合随后调用了函数接口listenerAction的方法，目的就是批量触发所有监听器的某个事件方法。而这个方法我们在将解析上一个方法源码的时候已经看到了是调用的则是SpringApplicationRunListener的内部****方法。
private void doWithListeners(String stepName, Consumer<SpringApplicationRunListener> listenerAction) {
doWithListeners(stepName, listenerAction, null);
}
private void doWithListeners(String stepName, Consumer<SpringApplicationRunListener> listenerAction,
Consumer<StartupStep> stepAction) {
StartupStep step = this.applicationStartup.start(stepName);
this.listeners.forEach(listenerAction);
if (stepAction != null) {
stepAction.accept(step);
}
step.end();
}所以本质上SpringApplicationRunListeners的作用则是发布事件，遍历当前类集合中每个SpringApplicationRunListener并且调用其对应这个事件的方法来实现事件的发布。
是 Spring Boot 应用启动过程的“广播站”，专门发布与应用生命周期（如开始启动、环境准备、上下文准备等）紧密相关的固定事件。而相较于ApplicationEventMulticaster 对于SpringApplicationRunListeners来说则更像是一个事件生产者。当我们分析完SpringApplicationRunListener源码便能更加深刻的理解
SpringApplicationRunListener
SpringApplicationRunListener 是一个接口，它定义了用于监听 SpringApplication 的 run() 方法执行过程中各个关键生命周期节点的回调方法。它的实现类通过这些回调方法，在特定的时间点执行必要的逻辑（最主要的就是发布事件）。
为什么说SpringApplicationRunListener 是发布事件呢？我们看看SpringApplicationRunListener 实现类的源码便可知道为啥时发布事件
class EventPublishingRunListener implements SpringApplicationRunListener, Ordered {
private final SpringApplication application;
private final String[] args;
private final SimpleApplicationEventMulticaster initialMulticaster;
EventPublishingRunListener(SpringApplication application, String[] args) {
this.application = application;
this.args = args;
this.initialMulticaster = new SimpleApplicationEventMulticaster();
}
@Override
public int getOrder() {
return 0;
}
@Override
public void starting(ConfigurableBootstrapContext bootstrapContext) {
multicastInitialEvent(new ApplicationStartingEvent(bootstrapContext, this.application, this.args));
}
@Override
public void environmentPrepared(ConfigurableBootstrapContext bootstrapContext,
ConfigurableEnvironment environment) {
multicastInitialEvent(
new ApplicationEnvironmentPreparedEvent(bootstrapContext, this.application, this.args, environment));
}
、、、、、、
private void multicastInitialEvent(ApplicationEvent event) {
refreshApplicationListeners();
this.initialMulticaster.multicastEvent(event);
}
private void refreshApplicationListeners() {
this.application.getListeners().forEach(this.initialMulticaster::addApplicationListener);
}
private static class LoggingErrorHandler implements ErrorHandler {
private static final Log logger = LogFactory.getLog(EventPublishingRunListener.class);
@Override
public void handleError(Throwable throwable) {
logger.warn("Error calling ApplicationEventListener", throwable);
}
}
}EventPublishingRunListener 是 SpringApplicationRunListener的一个子类实现类，我们可以看到其内部则是有一个SimpleApplicationEventMulticaster 类属性这个属性本质上是ApplicationEventMulticaster类的子类，而ApplicationEventMulticaster类则ApplicationContext内部最为常见的事件广播器主要作用则是监听事件并且广播事件。
当我们我们查看SpringApplicationRunListener不同的方法源码则可以看到不同的方法生成了不同的event事件类型当做参数，最终都是调用的multicastEvent方法，而multicastEvent方法内部的核心则是使用SimpleApplicationEventMulticaster的属性来对当前不同的event事件进行广播处理，最终本质上其实是ApplicationListener类来进行监听并且处理的
| 特性 | SpringApplicationRunListener | ApplicationListener |
|---|---|---|
| 关注点 | Spring Boot 应用的启动生命周期。 | Spring 框架的应用事件（包括Boot启动事件）。 |
| 触发时机 | 在 SpringApplication.run() 方法的固定节点被直接调用。 | 在任何事件被发布时，由 ApplicationEventMulticaster 通知。 |
| 获取方式 | 通过 spring.factories 机制配置。 | 可以是 @Component，或通过 SpringApplication.addListeners() 添加。 |
| 作用域 | 仅限于启动过程。 | 贯穿整个应用上下文生命周期。 |
| 主要职责 | 生产/发布启动事件。 | 消费/处理事件（包括启动事件）。 |
因此我们发现其实SpringApplicationRunListener是一个时间的发布器，通过ApplicationEventMulticaster来对事件进行广播，最终由ApplicationListener监听到不同的事件来进行处理，而SpringApplicationRunListeners我们则可以认为他是一个事件生产器，生产完毕之后调用SpringApplicationRunListener的方法来进行事件广播最终由ApplicationListener来进行事件的处理。