Spring事件驱动模型

今天说说我们项目中使用的spring事件驱动模型：

首先看一下Spring提供的事件驱动模型体系图： 

事件

具体代表者是：ApplicationEvent：

1、其继承自JDK的EventObject，JDK要求所有事件将继承它，并通过source得到事件源，比如我们的AWT事件体系也是继承自它；

2、系统默认提供了如下ApplicationEvent事件实现：

只有一个ApplicationContextEvent，表示ApplicationContext容器事件，且其又有如下实现：

• ContextStartedEvent：ApplicationContext启动后触发的事件；（目前版本没有任何作用）
• ContextStoppedEvent：ApplicationContext停止后触发的事件；（目前版本没有任何作用）
• ContextRefreshedEvent：ApplicationContext初始化或刷新完成后触发的事件；（容器初始化完成后调用）
• ContextClosedEvent：ApplicationContext关闭后触发的事件；（如web容器关闭时自动会触发spring容器的关闭，如果是普通java应用，需要调用ctx.registerShutdownHook();注册虚拟机关闭时的钩子才行）

注：org.springframework.context.support.AbstractApplicationContext抽象类实现了LifeCycle的start和stop回调并发布ContextStartedEvent和ContextStoppedEvent事件；但是无任何实现调用它，所以目前无任何作用。

 

目标（发布事件者）

具体代表者是：ApplicationEventPublisher及ApplicationEventMulticaster，系统默认提供了如下实现：

1、ApplicationContext接口继承了ApplicationEventPublisher，并在AbstractApplicationContext实现了具体代码，实际执行是委托给ApplicationEventMulticaster（可以认为是多播）：

Java代码  

1. public void publishEvent(ApplicationEvent event) {  
2.     //省略部分代码  
3.     }  
4.     getApplicationEventMulticaster().multicastEvent(event);  
5.     if (this.parent != null) {  
6.         this.parent.publishEvent(event);  
7.     }  
8. }  

我们常用的ApplicationContext都继承自AbstractApplicationContext，如ClassPathXmlApplicationContext、XmlWebApplicationContext等。所以自动拥有这个功能。

 

2、ApplicationContext自动到本地容器里找一个名字为”“的ApplicationEventMulticaster实现，如果没有自己new一个SimpleApplicationEventMulticaster。其中SimpleApplicationEventMulticaster发布事件的代码如下：

Java代码  

1. public void multicastEvent(final ApplicationEvent event) {  
2.     for (final ApplicationListener listener : getApplicationListeners(event)) {  
3.         Executor executor = getTaskExecutor();  
4.         if (executor != null) {  
5.             executor.execute(new Runnable() {  
6.                 public void run() {  
7.                     listener.onApplicationEvent(event);  
8.                 }  
9.             });  
10.         }  
11.         else {  
12.             listener.onApplicationEvent(event);  
13.         }  
14.     }  
15. }  

 大家可以看到如果给它一个executor（java.util.concurrent.Executor），它就可以异步支持发布事件了。佛则就是通过发送。

 

所以我们发送事件只需要通过ApplicationContext.publishEvent即可，没必要再创建自己的实现了。除非有必要。 

 

监听器

具体代表者是：ApplicationListener

1、其继承自JDK的EventListener，JDK要求所有监听器将继承它，比如我们的AWT事件体系也是继承自它；

2、ApplicationListener接口：

Java代码  

1. public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {  
2.     void onApplicationEvent(E event);  
3. }  

其只提供了onApplicationEvent方法，我们需要在该方法实现内部判断事件类型来处理，也没有提供按顺序触发监听器的语义，所以Spring提供了另一个接口，SmartApplicationListener：

Java代码  

1. public interface SmartApplicationListener extends ApplicationListener<ApplicationEvent>, Ordered {  
2.         //如果实现支持该事件类型 那么返回true  
3.     boolean supportsEventType(Class<? extends ApplicationEvent> eventType);  
4.     
5.         //如果实现支持“目标”类型，那么返回true  
6.     boolean supportsSourceType(Class<?> sourceType);  
7.          
8.         //顺序，即监听器执行的顺序，值越小优先级越高  
9.         int getOrder();  
10. }  

该接口可方便实现去判断支持的事件类型、目标类型，及执行顺序。 

上面是spring事件驱动的原理图，我们就是在此基础上扩展的：

比如事件发布使用SimpleApplicationEventMulticaster我们项目支持同步和异步两种方式，根据外面传过来的布尔值来判断，便于扩展，代码如下：

protected EventMulticaster(boolean async){
applicationEventMulticaster = new SimpleApplicationEventMulticaster();
if(async){
EventExecutor eventExecutor = new EventExecutor();
            //因为SimpleApplicationEventMulticaster默认的executor实现是同步的，所以这里传进了一个异步的，开启新的一个线程，来做到异步
((SimpleApplicationEventMulticaster)applicationEventMulticaster).setTaskExecutor(eventExecutor);
}
}

private class EventExecutor implements Executor{
@Override
public void execute(Runnable command) {
Thread thread = new Thread(command);
thread.start();
}
}

SimpleApplicationEventMulticaster发布事件源码是支持异步的。

事件监听使用SmartApplicationListener因为支持执行顺序，我们项目一个事件有多个监听事件，对于多个监听事件时我们跟每个监听事件里属性order值去判断，order值越小优先执行。