Spring|[Spring手撸专栏学习笔记]——容器事件和事件监听器容器|java|spring

本文是学习《Spring 手撸专栏》第 10 章笔记，主要记录我的一些debug调试过程，方便后期复习。具体学习，大家可以去看一下这个专栏，强烈推荐。

目标 【Spring|[Spring手撸专栏学习笔记]——容器事件和事件监听器】在 Spring 中有一个 Event 事件功能，它可以提供事件的定义、发布以及监听事件来完成一些自定义的动作。比如你可以定义一个新用户注册的事件，当有用户执行注册完成后，在事件监听中给用户发送一些优惠券和短信提醒，这样的操作就可以把属于基本功能的注册和对应的策略服务分开，降低系统的耦合。以后在扩展注册服务，比如需要添加风控策略、添加实名认证、判断用户属性等都不会影响到依赖注册成功后执行的动作。
那么在本章节我们需要以观察者模式的方式，设计和实现 Spring Event 的容器事件和事件监听器功能，最终可以让我们在现有实现的 Spring 框架中可以定义、监听和发布自己的事件信息。
方案其实事件的设计本身就是一种观察者模式的实现，它所要解决的就是一个对象状态改变给其他对象通知的问题，而且要考虑到易用和低耦合，保证高度的协作。
在功能实现上我们需要定义出事件类、事件监听、事件发布，而这些类的功能需要结合到 Spring 的 AbstractApplicationContext#refresh()，以便于处理事件初始化和注册事件监听器的操作。整体设计结构如下图：

文章图片

在整个功能实现过程中，仍然需要在面向用户的应用上下文 AbstractApplicationContext 中添加相关事件内容，包括：初始化事件发布者、注册事件监听器、发布容器刷新完成事件。
使用观察者模式定义事件类、监听类、发布类，同时还需要完成一个广播器的功能，接收到事件推送时进行分析处理符合监听事件接受者感兴趣的事件，也就是使用 isAssignableFrom 进行判断。
isAssignableFrom 和 instanceof 相似，不过 isAssignableFrom 是用来判断子类和父类的关系的，或者接口的实现类和接口的关系的，默认所有的类的终极父类都是Object。如果A.isAssignableFrom(B)结果是true，证明B可以转换成为A,也就是A可以由B转换而来

容器事件和事件监听器实现类关系，如图 11-2

文章图片

以上整个类关系图以围绕实现 event 事件定义、发布、监听功能实现和把事件的相关内容使用 AbstractApplicationContext#refresh 进行注册和处理操作。
在实现的过程中主要以扩展 spring context 包为主，事件的实现也是在这个包下进行扩展的，当然也可以看出来目前所有的实现内容，仍然是以IOC为主。
ApplicationContext 容器继承事件发布功能接口 ApplicationEventPublisher，并在实现类中提供事件监听功能。
ApplicationEventMulticaster 接口是注册监听器和发布事件的广播器，提供添加、移除和发布事件方法。
最后是发布容器关闭事件，这个仍然需要扩展到 AbstractApplicationContext#close 方法中，由注册到虚拟机的钩子实现

debug调试起始

public void test_event() { //(1) ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:spring.xml"); //(9) applicationContext.publishEvent(new CustomEvent(applicationContext, 1019129009086763L, "成功了！")); //(10) applicationContext.registerShutdownHook(); }

(1)AbstractApplicationContext

public void refresh() throws BeansException { //1 创建BeanFactory,并加载BeanDefinition refreshBeanFactory(); //2 获取BeanFactory ConfigurableListableBeanFactory beanFactory = getBeanFactory(); //3 添加ApplicationContextAwareProcessor,让继承ApplicationContextAware的Bean对象 //都能感知所属的ApplicationContext beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this)); //3 在Bean实例化之前，执行BeanFactoryPostProcessor(调用在上下文中注册为bean的工厂处理器) invokeBeanFactoryPostProcessors(beanFactory); //4 BeanPostProcessor 需要提前于其他Bean对象实例化之前执行注册操作 registerBeanPostProcessors(beanFactory); //5 提前实例化单例Bean对象 beanFactory.preInstantiateSingletons(); //6 初始化事件发布者 initApplicationEventMulticaster(); //(2)//7 注册事件监听器 registerListeners(); //(3)//8 发布容器刷新完成事件 finishRefresh(); //(5)}

(2) AbstractApplicationContext
将其广播者属性applicationEventMulticaster赋值，且将其添加到beanFactory的单例集合中

private ApplicationEventMulticaster applicationEventMulticaster;

private void initApplicationEventMulticaster(){ ConfigurableListableBeanFactory beanFactory = getBeanFactory(); applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory); beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, applicationEventMulticaster); }

（3）AbstractApplicationContext
通过 getBeansOfType 方法获取到所有从 spring.xml 中加载到的事件配置 Bean 对象。

private void registerListeners(){ Collection applicationListeners = getBeansOfType(ApplicationListener.class).values(); for (ApplicationListener listener:applicationListeners){ applicationEventMulticaster.addApplicationLister(listener); //(4) } }

(4)AbstractApplicationEventMulticaster
将监听事件添加到applicationListeners集合中

public final Set> applicationListeners = new LinkedHashSet<>();

@Override public void addApplicationLister(ApplicationListener listener) { applicationListeners.add((ApplicationListener) listener); }

(5)AbstractApplicationContext
发布了第一个服务器启动完成后的事件，这个事件通过 publishEvent 发布出去
利用applicationEventMulticaster广播出去

//属性 private ApplicationEventMulticaster applicationEventMulticaster;

private void finishRefresh(){ publishEvent(new ContextRefreshedEvent(this)); }

@Override public void publishEvent(ApplicationEvent event) { applicationEventMulticaster.multicastEvent(event); //(6) }

(6)SimpleApplicationEventMulticaster
先过滤出符合的监听处理器，然后再把消息发到符合的监听器中

@Override public void multicastEvent(final ApplicationEvent event) { for (final ApplicationListener listener:getApplicationListener(event)){ //(7) listener.onApplicationEvent(event); //(8) } }

(7) AbstractApplicationEventMulticaster
摘取符合广播事件中的监听处理器,具体过滤动作在 supportsEvent 方法中。

protected Collection getApplicationListener(ApplicationEvent event){ LinkedList allListeners = new LinkedList<>(); for (ApplicationListener listener :applicationListeners){ if (supportsEvent(listener,event)){ allListeners.add(listener); } } return allListeners; }

(8)ContextRefreshedEventListener
implements ApplicationListener
调用我们自己实现 ApplicationListener接口的类中的刷新方法