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

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

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

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

（二）定义了监听器后，还需要配置一下，让spring boot能识别它，有几种方式：

（1）配置"context.listener.classes"

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

（2） 在META-INF/spring.factories配置：

在resources下新建META-INF\spring.factoies，然后和spring的监听器配置一样配置自己定义的监听器，就可以啦

（3）最简单用@Component注解标注它是个bean就行

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

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

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

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

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

这里可以看到getApplicationListeners(event, type)，就是根据事件类型获取需要广播的ApplicationListener，而applicationListener列表是在SpringApplication构造方法从spring.factories中获取的，这也是我们第2种配置可以生效的原因。详情可参看我写《spring-boot启动源码分析（一）之SpringApplication实例构造》

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

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

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

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

我们可以看到，是通过我们配置的context.listener.classes获得类名，然后通过反射实例化返回。这样整个监听器的过程就完整了。我们注意到代理类是从ApplicationEnvironmentPreparedEvent开始响应的，所以之前的事件我们自定义的ApplicationListener是无法监听的。

而对于第3种方式，监听器不在SpringApplication的listeners，而是在ApplicationContext中，是在bean创建时，通过ApplicationListenerDetector后置处理器进行判断bean是否实现了ApplicationListener接口，如果是则加入到ApplicationContext的监听器列表中：

所以这三种方式虽然都能实现监听器，但也会略有不同：

（1）context.listener.classes此种方式是从ApplicationEnvironmentPreparedEvent开始响应的，所以之前的事件我们自定义的ApplicationListener是无法监听的

（2）在spring.factories中配置会在SpringApplication实例化时被获取到，可以监听最全的事件

（3）使用@Component标识bean的方式，需要等bean创建后才能被放进ApplicationContext的监听器列表，所以之前的事件也是无法监听的