glmapper

SpringBoot 系列-事件机制详解

字数统计: 2.7k阅读时长: 10 min
2019/04/13 Share

微信公众号:glmapper工作室
掘金专栏:glmapper
微 博:疯狂的石头_henu
欢迎关注,一起学习、一起分享

在这篇文章中聊一聊 Spring 中的扩展机制(一)中对Spring中的事件机制进行了分析。那么对于 SpringBoot 来说,它在 Spring 的基础上又做了哪些拓展呢?本篇将来聊一聊 SpringBoot 中的事件。

在 SpringBoot 的启动过程中,会通过 SPI 机制去加载 spring.factories 下面的一些类,这里面就包括了事件相关的类。

  • SpringApplicationRunListener

    1
    2
    3
    # Run Listeners
    org.springframework.boot.SpringApplicationRunListener=\
    org.springframework.boot.context.event.EventPublishingRunListener
  • ApplicationListener

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    # Application Listeners
    org.springframework.context.ApplicationListener=\
    org.springframework.boot.ClearCachesApplicationListener,\
    org.springframework.boot.builder.ParentContextCloserApplicationListener,\
    org.springframework.boot.context.FileEncodingApplicationListener,\
    org.springframework.boot.context.config.AnsiOutputApplicationListener,\
    org.springframework.boot.context.config.ConfigFileApplicationListener,\
    org.springframework.boot.context.config.DelegatingApplicationListener,\
    org.springframework.boot.context.logging.ClasspathLoggingApplicationListener,\
    org.springframework.boot.context.logging.LoggingApplicationListener,\
    org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener

    SpringApplicationRunListener 类是 SpringBoot 中新增的类。SpringApplication 类 中使用它们来间接调用 ApplicationListener。另外还有一个新增的类是SpringApplicationRunListenersSpringApplicationRunListeners 中包含了多个 SpringApplicationRunListener

    SpringApplicationRunListener

    SpringApplicationRunListener 接口规定了 SpringBoot 的生命周期,在各个生命周期广播相应的事件,调用实际的 ApplicationListener 类。通过对 SpringApplicationRunListener 的分析,也可以对 SpringBoot 的整个启动过程的理解会有很大帮助。

    先来看下SpringApplicationRunListener 接口的代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public interface SpringApplicationRunListener {
//当run方法首次启动时立即调用。可用于非常早期的初始化。
void starting();
//在准备好环境后,但在创建ApplicationContext之前调用。
void environmentPrepared(ConfigurableEnvironment environment);
//在创建和准备好ApplicationContext之后,但在加载源之前调用。
void contextPrepared(ConfigurableApplicationContext context);
//在加载应用程序上下文后但刷新之前调用
void contextLoaded(ConfigurableApplicationContext context);
//上下文已刷新,应用程序已启动,但尚未调用commandlinerunner和applicationrunner。
void started(ConfigurableApplicationContext context);
//在运行方法完成之前立即调用,此时应用程序上下文已刷新,
//并且所有commandlinerunner和applicationrunner都已调用。
//2.0 才有
void running(ConfigurableApplicationContext context);
//在运行应用程序时发生故障时调用。2.0 才有
void failed(ConfigurableApplicationContext context, Throwable exception);
}

SpringApplicationRunListeners

上面提到,SpringApplicationRunListenersSpringApplicationRunListener的集合,里面包括了很多SpringApplicationRunListener实例;SpringApplication 类实际上使用的是 SpringApplicationRunListeners 类,与 SpringApplicationRunListener 生命周期相同,调用各个周期的 SpringApplicationRunListener 。然后广播相应的事件到 ApplicationListener

代码详见:SpringApplicationRunListeners.

EventPublishingRunListener

EventPublishingRunListener 类是 SpringApplicationRunListener接口的实现类 ,它具有广播事件的功能。其内部使用 ApplicationEventMulticaster在实际刷新上下文之前发布事件。下面来看下 EventPublishingRunListener 类生命周期对应的事件。

ApplicationStartingEvent

ApplicationStartingEventSpringBoot 启动开始的时候执行的事件,在该事件中可以获取到 SpringApplication 对象,可做一些执行前的设置,对应的调用方法是 starting()

ApplicationEnvironmentPreparedEvent

ApplicationEnvironmentPreparedEventSpringBoot 对应 Enviroment 已经准备完毕时执行的事件,此时上下文 context 还没有创建。在该监听中获取到 ConfigurableEnvironment 后可以对配置信息做操作,例如:修改默认的配置信息,增加额外的配置信息等。对应的生命周期方法是 environmentPrepared(environment)SpringCloud 中,引导上下文就是在这时初始化的。

ApplicationContextInitializedEvent

SpringApplication 启动并且准备好 ApplicationContext,并且在加载任何 bean 定义之前调用了 ApplicationContextInitializers 时发布的事件。对应的生命周期方法是contextPrepared()

ApplicationPreparedEvent

ApplicationPreparedEventSpringBoot上下文 context 创建完成是发布的事件;但此时 spring 中的 bean 还没有完全加载完成。这里可以将上下文传递出去做一些额外的操作。但是在该监听器中是无法获取自定义 bean 并进行操作的。对应的生命周期方法是 contextLoaded()

ApplicationStartedEvent

这个事件是在 2.0 版本才引入的;具体发布是在应用程序上下文刷新之后,调用任何 ApplicationRunnerCommandLineRunner 运行程序之前。

ApplicationReadyEvent

这个和 ApplicationStartedEvent 很类似,也是在应用程序上下文刷新之后之后调用,区别在于此时ApplicationRunnerCommandLineRunner已经完成调用了,也意味着 SpringBoot 加载已经完成。

ApplicationFailedEvent

SpringBoot 启动异常时执行的事件,在异常发生时,最好是添加虚拟机对应的钩子进行资源的回收与释放,能友善的处理异常信息。

demo 及各个事件的执行顺序

下面的各个事件对应的demo及打印出来的执行顺序。

  • GlmapperApplicationStartingEventListener

    1
    2
    3
    4
    5
    6
    public class GlmapperApplicationStartingEventListener implements ApplicationListener<ApplicationStartingEvent> {
    @Override
    public void onApplicationEvent(ApplicationStartingEvent applicationStartingEvent) {
    System.out.println("execute ApplicationStartingEvent ...");
    }
    }
  • GlmapperApplicationEnvironmentPreparedEvent

1
2
3
4
5
6
public class GlmapperApplicationEnvironmentPreparedEvent implements ApplicationListener<ApplicationEnvironmentPreparedEvent> {
@Override
public void onApplicationEvent(ApplicationEnvironmentPreparedEvent applicationEnvironmentPreparedEvent) {
System.out.println("execute ApplicationEnvironmentPreparedEvent ...");
}
}
  • GlmapperApplicationContextInitializedEvent
1
2
3
4
5
6
public class GlmapperApplicationContextInitializedEvent implements ApplicationListener<ApplicationContextInitializedEvent> {
@Override
public void onApplicationEvent(ApplicationContextInitializedEvent applicationContextInitializedEvent) {
System.out.println("execute applicationContextInitializedEvent ...");
}
}
  • GlmapperApplicationPreparedEvent
1
2
3
4
5
6
public class GlmapperApplicationPreparedEvent implements ApplicationListener<ApplicationPreparedEvent> {
@Override
public void onApplicationEvent(ApplicationPreparedEvent applicationPreparedEvent) {
System.out.println("execute ApplicationPreparedEvent ...");
}
}
  • GlmapperApplicationStartedEvent
1
2
3
4
5
6
public class GlmapperApplicationStartedEvent implements ApplicationListener<ApplicationStartedEvent> {
@Override
public void onApplicationEvent(ApplicationStartedEvent applicationStartedEvent) {
System.out.println("execute ApplicationStartedEvent ...");
}
}
  • GlmapperApplicationReadyEvent
1
2
3
4
5
6
public class GlmapperApplicationReadyEvent implements ApplicationListener<ApplicationReadyEvent> {
@Override
public void onApplicationEvent(ApplicationReadyEvent applicationReadyEvent) {
System.out.println("execute ApplicationReadyEvent ...");
}
}
  • 执行结果

SpringBoot 中的事件体系

这里围绕 SpringApplicationRunListener 这个类来说。在实现类 EventPublishingRunListener 中,事件发布有两种模式:

  • 通过 SimpleApplicationEventMulticaster 进行事件广播
  • 所有监听器交给相应的 Context

所以EventPublishingRunListener 不仅负责发布事件,而且在合适的时机将 SpringApplication 所获取的监听器和应用上下文作关联。

SimpleApplicationEventMulticaster

SimpleApplicationEventMulticasterSpring 默认的事件广播器。来看下它是怎么工作的:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Override
public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {
ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));
for (final ApplicationListener<?> listener : getApplicationListeners(event, type)) {
Executor executor = getTaskExecutor();
if (executor != null) {
// 异步的
executor.execute(() -> invokeListener(listener, event));
}
else {
invokeListener(listener, event);
}
}
}

从上面的代码段可以看出,它是通过遍历注册的每个监听器,并启动来调用每个监听器的 onApplicationEvent 方法。

下面再来看下 SimpleApplicationEventMulticaster 的类集成结构:

这里的 AbstractApplicationContext 下面来聊,这个类实际上就负责了事件体系的初始化工作。

事件体系的初始化

事件体系的初始化对应在 SpringBoot启动过程的 refreshContext这个方法;refreshContext具体调用 AbstractApplicationContext.refresh()方法,最后调用 initApplicationEventMulticaster() 来完成事件体系的初始化,代码如下:

用户可以为容器定义一个自定义的事件广播器,只要实现 ApplicationEventMulticaster 就可以了,Spring 会通过 反射的机制将其注册成容器的事件广播器,如果没有找到配置的外部事件广播器,Spring 就是默认使用 SimpleApplicationEventMulticaster 作为事件广播器。

事件注册

事件注册是在事件体系初始化完成之后做的事情,也是在 AbstractApplicationContext.refresh() 方法中进行调用的。


这里干了三件事:

  • 首先注册静态指定的 listeners;这里包括我们自定义的那些监听器。
  • 调用 DefaultListableBeanFactorygetBeanNamesForType 得到自定义的 ApplicationListener bean 进行事件注册。
  • 广播早期的事件。

事件广播

事件发布伴随着 SpringBoot 启动的整个生命周期。不同阶段对应发布不同的事件,上面我们已经对各个事件进行了分析,下面就具体看下发布事件的实现:

org.springframework.context.support.AbstractApplicationContext#publishEvent

earlyApplicationEvents 中的事件是广播器未建立的时候保存通知信息,一旦容器建立完成,以后都是直接通知。

广播事件最终还是通过调用 ApplicationEventMulticastermulticastEvent 来实现。而 multicastEvent 也就就是事件执行的方法。

事件执行

上面 SimpleApplicationEventMulticaster 小节已经初步介绍了 multicastEvent 这个方法。补充一点, 如果有可用的 taskExecutor 会使用并发的模式执行事件,但是实际上 SimpleApplicationEventMulticaster 并没有提供线程池实现,默认请况下是使用同步的方式执行事件(org.springframework.core.task.SyncTaskExecutor),所以如果需要异步配置的话,需要自己去实现线程池。

SpringBoot 启动过程中的事件阶段

这里回到 SpringApplicationrun方法,看下 SpringBoot 在启动过程中,各个事件阶段做了哪些事情。

starting -> ApplicationStartingEvent

这里 debugstarting 方法,追踪到 multicastEvent,这里 typeApplicationStartingEvent;对应的事件如下:

  • LoggerApplicationListener:配置日志系统。使用logging.config环境变量指定的配置或者缺省配置
  • BackgroundPreinitializer:尽早触发一些耗时的初始化任务,使用一个后台线程
  • DelegatingApplicationListener:监听到事件后转发给环境变量context.listener.classes指定的那些事件监听器
  • LiquibaseServiceLocatorApplicationListener:使用一个可以和 SpringBoot 可执行jar包配合工作的版本替换 liquibase ServiceLocator

listeners.environmentPrepared->ApplicationEnvironmentPreparedEvent

  • AnsiOutputApplicationListener:根据spring.output.ansi.enabled参数配置AnsiOutput
  • ConfigFileApplicationListener:EnvironmentPostProcessor,从常见的那些约定的位置读取配置文件,比如从以下目录读取application.properties,application.yml等配置文件:

    • classpath:
    • file:.
    • classpath:config
    • file:./config/

      也可以配置成从其他指定的位置读取配置文件。

  • ClasspathLoggingApplicationListener:对环境就绪事件ApplicationEnvironmentPreparedEvent/应用失败事件ApplicationFailedEvent做出响应,往日志DEBUG级别输出TCCL(thread context class loader)classpath
  • FileEncodingApplicationListener:如果系统文件编码和环境变量中指定的不同则终止应用启动。具体的方法是比较系统属性file.encoding和环境变量spring.mandatory-file-encoding是否相等(大小写不敏感)。

listeners.contextPrepared->ApplicationContextInitializedEvent

相关监听器参考上面的描述。

listeners.contextLoaded->ApplicationPreparedEvent

相关监听器参考上面的描述。

refresh->ContextRefreshedEvent

  • ConditionEvaluationReportLoggingListener:实际上实现的是 ApplicationContextInitializer接口,其目的是将 ConditionEvaluationReport 写入到日志,使用DEBUG级别输出。程序崩溃报告会触发一个消息输出,建议用户使用调试模式显示报告。它是在应用初始化时绑定一个ConditionEvaluationReportListener事件监听器,然后相应的事件发生时输出ConditionEvaluationReport报告。
  • ClearCachesApplicationListener:应用上下文加载完成后对缓存做清除工作,响应事件ContextRefreshedEvent
  • SharedMetadataReaderFactoryContextInitializer: 向context注册了一个BeanFactoryPostProcessorCachingMetadataReaderFactoryPostProcessor实例。
  • ResourceUrlProvider:handling mappings处理

started->ApplicationStartedEvent


相关监听器参考上面的描述。

running->ApplicationReadyEvent


相关监听器参考上面的描述。

BackgroundPreinitializer&DelegatingApplicationListener

这两个贯穿了整个过程,这里拎出来单独解释下:

  • BackgroundPreinitializer:对于一些耗时的任务使用一个后台线程尽早触发它们开始执行初始化,这是SpringBoot的缺省行为。这些初始化动作也可以叫做预初始化。可以通过设置系统属性spring.backgroundpreinitializer.ignoretrue可以禁用该机制。该机制被禁用时,相应的初始化任务会发生在前台线程。
  • DelegatingApplicationListener:监听应用事件,并将这些应用事件广播给环境属性context.listener.classes指定的那些监听器。

小结

到此,SpringBoot 中的事件相关的东西就结束了。本文从SpringApplicationRunListener这个类说起,接着介绍 SpringBoot 启动过程的事件以及事件的生命周期。最后介绍了 SpringBoot中的内置的这些 监听器在启动过程中对应的各个阶段。

新年伊始,祝大家新年快乐!

参考

原文作者:GuoLei Song

原文链接:http://www.glmapper.com/2019/04/13/springboot-series-event/

发表日期:April 13th 2019, 10:55:41 pm

更新日期:December 16th 2019, 12:14:42 pm

版权声明:转载请注明出处

CATALOG
  1. 1. SpringApplicationRunListener
  2. 2. SpringApplicationRunListeners
    1. 2.1. EventPublishingRunListener
    2. 2.2. ApplicationStartingEvent
    3. 2.3. ApplicationEnvironmentPreparedEvent
    4. 2.4. ApplicationContextInitializedEvent
    5. 2.5. ApplicationPreparedEvent
    6. 2.6. ApplicationStartedEvent
    7. 2.7. ApplicationReadyEvent
    8. 2.8. ApplicationFailedEvent
    9. 2.9. demo 及各个事件的执行顺序
  3. 3. SpringBoot 中的事件体系
    1. 3.1. SimpleApplicationEventMulticaster
    2. 3.2. 事件体系的初始化
    3. 3.3. 事件注册
    4. 3.4. 事件广播
    5. 3.5. 事件执行
  4. 4. SpringBoot 启动过程中的事件阶段
    1. 4.1. starting -> ApplicationStartingEvent
    2. 4.2. listeners.environmentPrepared->ApplicationEnvironmentPreparedEvent
    3. 4.3. listeners.contextPrepared->ApplicationContextInitializedEvent
    4. 4.4. listeners.contextLoaded->ApplicationPreparedEvent
    5. 4.5. refresh->ContextRefreshedEvent
    6. 4.6. started->ApplicationStartedEvent
    7. 4.7. running->ApplicationReadyEvent
    8. 4.8. BackgroundPreinitializer&DelegatingApplicationListener
  5. 5. 小结
  6. 6. 参考