当前位置：首页 > article >正文

spring-boot自定义ApplicationListener及源码分析

article 2024/12/2 4:25:01

ApplicationListener是spring boot应用启动时的事件监听器。监听的事件有（包括但不限于）：

（1）接下来，我们先通过一个例子实现自定义ApplicationListener：

监听器需要实现ApplicationListener<T>，参数类型为ApplicationEvent，表示监听所有事件，当然也可以将参数类型设置为单独的事件，下面这个只会接收ApplicationEnvironmentPreparedEvent事件：

（2）定义了监听器后，还需要配置一下，让spring boot启动时加载它，即配置"context.listener.classes"

（3）启动后可以看到，监听器监听了如下事件：

（4）源码分析，我们来看看自定义的监听器是怎么工作的：

ApplicationListener是采用观察者模式实现的，我们的启动时入口是执行SpringApplication.run方法

如下两处代码，分别是获取SpringApplicationRunListeners（这个是各个事件的发布者）和进行环境的准备，

在环境准备好后发布ApplicationEnvironmentPreparedEvent事件

虽然这里listeners是容器类，但默认只有一个EventPublishingRunListener，我们看一下它是怎么发布事件的，如下代码很明显，进行了一个事件的广播，但还没看到广播给谁，继续往下

这里可以看到getApplicationListeners(event, type)，就是根据事件类型获取需要广播的ApplicationListener

在调试状态下，我们看一下getApplicationListeners(event, type)有哪些

发现只有6个ApplicationListener响应了ApplicationEnvironmentPreparedEvent事件，而且没有我们自定义的ApplicationListener，怎么回事呢？

实际上，我们的ApplicationListener是通过代理类执行的，即上面的DelegatingApplicationListener，我们可以看一下它怎么执行的：

上面代码可以看到代理类也监听了所有的事件，然后在ApplicationEnvironmentPreparedEvent事件时才初次响应，并且通过getListeners获取所有代理的ApplicationListeners，然后它自己实现了一个事件广播器，然后把获取的ApplicationListeners通过到addApplicationListener加入到广播器中，最后进行事件的广播转发。我们重点看一下getListeners，看是如何获取到我们自定义的ApplicationListeners的：

我们可以看到，是通过我们配置的context.listener.classes获得类名，然后通过反射实例化返回。

这样整个监听器的过程就完整了。我们注意到代理类是从ApplicationEnvironmentPreparedEvent开始响应的，所以之前的事件我们自定义的ApplicationListener是无法监听的。实际上前面只有一个ApplicationStartingEvent，此时应用才刚启动，也没啥好监听的。如果需要监听所有的事件可以在自己在spring.factories配置：