spring 事件监听器原理分析

先搭建源码分析环境，这里引用的是org.springframework4.3.12.RELEASE版本分析的，debug之前github上下载相关源码-地址 除了在上述代码中打上断点之外，增加EventListenerMethodProcessor的afterSingletonsInstantiated方法打上断点，AbstractApplicationContext的initApplicationEventMulticaster方法和registerListeners上打上断点。

@ComponentScan("com.atguigu.ext") @Configuration public class ExtConfig { @Bean public Blue blue(){ return new Blue(); } } @Component public class MyApplicationListener implements ApplicationListener<ApplicationEvent> { //当容器中发布此事件以后，方法触发 @Override public void onApplicationEvent(ApplicationEvent event) { // TODO Auto-generated method stub //断点 System.out.println("收到事件："+event); } } @Service public class UserService { @EventListener(classes={ApplicationEvent.class}) public void listen(ApplicationEvent event){ //断点 System.out.println("UserService。。监听到的事件："+event); } } <dependencies> <!-- https://mvnrepository.com/artifact/org.springframework/spring-context --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>4.3.12.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aspects</artifactId> <version>4.3.12.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>4.3.12.RELEASE</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> <!-- https://mvnrepository.com/artifact/javax.inject/javax.inject --> <dependency> <groupId>javax.inject</groupId> <artifactId>javax.inject</artifactId> <version>1</version> </dependency> </dependencies> @Test public void test01(){ AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(ExtConfig.class); //发布事件； //断点 applicationContext.publishEvent(new ApplicationEvent(new String("我发布的时间")) { }); applicationContext.close(); }

开始debug，进入断点

1.事件多播器（派发器）的生成

查看调用栈发现有refresh中有专门初始化该事件多播器（派发器）的方法

代码向下走发现，当容器中没有applicationEventMulticaster对象时，这里new了一个事件多播器（派发器）对象

2.注册监听器

继续debug，F9，进入监听器注册方法 查看调用栈发现，这个方法时refresh中的专门监听器注册方法

继续debug，F9，进入SmartInitializingSingleton 的->afterSingletonsInstantiated()方法，主要是userservice的listen方法没有注册到事件多播器中，此方法完成这个操作。

继续F9 ，发现事件监听器监听到事件了

查看调用栈

总结：

public interface ApplicationListener<E extends ApplicationEvent> 监听 ApplicationEvent 及其下面的子事件； 步骤： 1）、写一个监听器（ApplicationListener实现类）来监听某个事件（ApplicationEvent及其子类） @EventListener; 原理：使用EventListenerMethodProcessor处理器来解析方法上的@EventListener； 2）、把监听器加入到容器； 3）、只要容器中有相关事件的发布，我们就能监听到这个事件； ContextRefreshedEvent：容器刷新完成（所有bean都完全创建）会发布这个事件； ContextClosedEvent：关闭容器会发布这个事件； 4）、发布一个事件： applicationContext.publishEvent()； 原理： ContextRefreshedEvent、IOCTest_Ext$1[source=我发布的时间]、ContextClosedEvent； 1）、ContextRefreshedEvent事件： 1）、容器创建对象：refresh()； 2）、finishRefresh();容器刷新完成会发布ContextRefreshedEvent事件 2）、自己发布事件； 3）、容器关闭会发布ContextClosedEvent； 【事件发布流程】： 3）、publishEvent(new ContextRefreshedEvent(this)); 1）、获取事件的多播器（派发器）：getApplicationEventMulticaster() 2）、multicastEvent派发事件： 3）、获取到所有的ApplicationListener； for (final ApplicationListener<?> listener : getApplicationListeners(event, type)) { 1）、如果有Executor，可以支持使用Executor进行异步派发； Executor executor = getTaskExecutor(); 2）、否则，同步的方式直接执行listener方法；invokeListener(listener, event); 拿到listener回调onApplicationEvent方法； 【事件多播器（派发器）】 1）、容器创建对象：refresh(); 2）、initApplicationEventMulticaster();初始化ApplicationEventMulticaster； 1）、先去容器中找有没有id=“applicationEventMulticaster”的组件； 2）、如果没有this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory); 并且加入到容器中，我们就可以在其他组件要派发事件，自动注入这个applicationEventMulticaster； 【容器中有哪些监听器】 1）、容器创建对象：refresh(); 2）、registerListeners(); 从容器中拿到所有的监听器，把他们注册到applicationEventMulticaster中； String[] listenerBeanNames = getBeanNamesForType(ApplicationListener.class, true, false); //将listener注册到ApplicationEventMulticaster中 getApplicationEventMulticaster().addApplicationListenerBean(listenerBeanName); SmartInitializingSingleton 原理：->afterSingletonsInstantiated();