Spring Boot 启动事件和监听器，太强大了！

大家都知道，在 Spring 框架中事件和监听无处不在，打通了 Spring 框架的任督二脉，事件和监听也是 Spring框架必学的核心知识之一。

一般来说，我们很少会使用到应用程序事件，但我们也不要忘了它们的存在，比如说在 Spring 框架内部都使用了各种不同的事件来处理不同的任务。

毫无疑问，在 Spring Boot 框架中，事件和监听也得到了发扬光大，除了常用的 SpringFramework事件(例如：ContextRefreshedEvent)之外，Spring Boot 在启动过程中还发送一系列其他的应用程序事件。

Spring Boot 启动事件顺序

1、ApplicationStartingEvent

这个事件在 Spring Boot 应用运行开始时，且进行任何处理之前发送(除了监听器和初始化器注册之外)。

2、ApplicationEnvironmentPreparedEvent

这个事件在当已知要在上下文中使用 Spring 环境(Environment)时，在 Spring 上下文(context)创建之前发送。

3、ApplicationContextInitializedEvent

这个事件在当Spring应用上下文(ApplicationContext)准备好了，并且应用初始化器(ApplicationContextInitializers)已经被调用，在bean的定义(bean definitions)被加载之前发送。

4、ApplicationPreparedEvent

这个事件是在 Spring 上下文(context)刷新之前，且在 bean 的定义(bean definitions)被加载之后发送。

5、ApplicationStartedEvent

这个事件是在 Spring 上下文(context)刷新之后，且在 application/ command-line runners被调用之前发送。

6、AvailabilityChangeEvent

这个事件紧随上个事件之后发送，状态：ReadinessState.CORRECT，表示应用已处于活动状态。

7、ApplicationReadyEvent

这个事件在任何 application/ command-line runners 调用之后发送。

8、AvailabilityChangeEvent

这个事件紧随上个事件之后发送，状态：ReadinessState.ACCEPTING_TRAFFIC，表示应用可以开始准备接收请求了。

9、ApplicationFailedEvent

这个事件在应用启动异常时进行发送。

上面所介绍的这些事件列表仅包括绑定到 SpringApplication 的SpringApplicationEvents事件，除了这些事件以外，以下事件也会在 ApplicationPreparedEvent 之后和ApplicationStartedEvent之前发送：

• WebServerInitializedEvent

这个 Web 服务器初始化事件在 WebServer启动之后发送，对应的还有ServletWebServerInitializedEvent(ServletWeb服务器初始化事件)、ReactiveWebServerInitializedEvent(响应式 Web 服务器初始化事件)。

• ContextRefreshedEvent

这个上下文刷新事件是在 Spring 应用上下文(ApplicationContext)刷新之后发送。

自定义启动事件监听器

既然我们知道了 SpringBoot在启动过程中的各个事件，那么我们就可以在每个环节来处理一些我们想做的事情，只需要自定义一个监听器来监听某个事件就可以了。

比如我们想在上面的第 8 步，即应用启动完成可以接收请求了，我们简单输出一个成功标识。

Spring Boot 基础的构建这里就不介绍了，如果你对 Spring Boot还不是很熟悉，或者只是会简单的使用，那还是建议你深入学习下吧，推荐这个Spring Boot 学习仓库，欢迎 Star 关注：

https://github.com/javastacks/spring-boot-best-practice

1、新建监听器

新建一个自定义监听器，实现了 ApplicationListener 接口，泛型 AvailabilityChangeEvent表示仅仅监听AvailabilityChangeEvent 事件。

因第 8 步的事件和第 6 步的事件同名，我们可以根据事件的状态来区分到底是哪一个环节的事件 。

2、注册监听器

注册监听器有两种方式：

1、在资源目录中的 META-INF/spring.factories 文件中自动注册：

2、如果是监听 Spring 应用上下文(ApplicationContext)创建之后的事件，可以直接在监听器上使用@Component注解即可，否则需要使用第一种方法的自动注册，因为 ApplicationContext 并未创建，这时的 Bean 是不能被加载的。

3、应用启动

下面来看下启动日志：

可以看到同时输出了第 6 步和 8 步的监听日志，但只输出第 8 步的启动完成日志，自定义监听实现成功。

总结

了解了 Spring Boot 启动过程中的各个事件及监听机制，大家可以依葫芦画瓢实现 SpringBoot启动过程中的各个自定义操作，比如说在启动过程上实现动态注册、移除 Bean 等。

一般来说，不建议使用事件和监听器来实现比较耗时和繁重的任务，这样会影响应用程序的正常启动，考虑使用 Spring Boot 的application/command-line runners 来进行实现。

本文只是介绍了一下 SpringBoot启动过程中的事件及如何实现自定义监听器，怎么实现一个业务上的自定义事件和监听器不在本文范围之类，后续栈长再开一篇，关注公众号Java技术栈第一时间推送，不要走开。

本文实践所有源代码已上传：

https://github.com/javastacks/spring-boot-best-practice

参考资料：

https://docs.spring.io/spring-boot/docs/2.3.5.RELEASE/reference/htmlsingle/#boot-features-application-events-and-listeners

本文转载自微信公众号「 Java技术栈」，可以通过以下二维码关注。转载本文请联系 Java技术栈公众号。