Spring核心——全局事件管理

ApplicationContext是一个Context策略（见上下文与IoC），他除了提供最基础的IoC容器功能，还提供了MessageSource实现的国际化、全局事件、资源层级管理等等功能。本文将详细介绍Spring核心模块的事件管理机制。

Spring核心模块的事件机制和常规意义上的“事件”并没有太大区别（例如浏览器上的用户操作事件）都是通过订阅/发布模式实现的。

Spring事件管理的内容包括标准事件、自定义事件、注解标记处理器、异步事件处理、通用实体包装。

我们都知道在订阅/发布模式中至少要涉及三个部分——发布者（publisher）、订阅者（listener/subscriber）和事件（event）。针对这个模型Spring也提供了对应的两个接口——ApplicationEventPublisher、ApplicationListener以及一个抽象类ApplicationEvent。基本上，要使用Spring事件的功能，只要实现/继承这这三个接口/抽象类并按照Spring定好的规则来使用即可。掌握这个原则那么接下来的内容就好理解了。

标准事件

Spring为一些比较常规的事件制定了标准的事件类型和固定的发布方法，我们只需要定制好订阅者（listener/subscriber）就可以监听这些事件。

先指定2个订阅者：

packagechkui.springcore.example.javabase.event.standard;publicclassContextStartedListenerimplementsApplicationListener{@OverridepublicvoidonApplicationEvent(ContextStartedEvent event){System.out.println("Start Listener: I am start");}}

packagechkui.springcore.example.javabase.event.standard;publicclassContextStopListenerimplementsApplicationListener{@OverridepublicvoidonApplicationEvent(ContextStoppedEvent event){System.out.println("Stop Listener: I am stop");}}

 然后运行使用他们：

packagechkui.springcore.example.javabase.event;@ConfigurationpublicclassEventApp{@BeanContextStopListenercontextStopListener(){returnnewContextStopListener();}@BeanContextStartedListenercontextStartedListener(){returnnewContextStartedListener();}publicstaticvoidmain(String[] args){ConfigurableApplicationContext context =newAnnotationConfigApplicationContext(EventApp.class);//发布start事件context.start();//发布stop事件context.stop();//关闭容器context.close();}}

在例子代码中，ContextStartedListener和ContextStopListener类都实现了ApplicationListener接口，然后通过onApplicationEvent的方法参数来指定监听的事件类型。在ConfigurableApplicationContext接口中已经为“start”和“stop”事件提供对应的发布方法。除了StartedEvent和StoppedEvent，Spring还为其他几项操作提供了标准事件：

ContextRefreshedEvent：ConfigurableApplicationContext::refresh方法被调用后触发。事件发出的时机是所有的后置处理器已经执行、所有的Bean已经被加载、所有的ApplicationContext接口方法都可以提供服务。

ContextStartedEvent：ConfigurableApplicationContext::start方法被调用后触发。

ContextStoppedEvent：ConfigurableApplicationContext::stop方法被调用后触发。

ContextClosedEvent：ConfigurableApplicationContext::close方法被调用后触发。

RequestHandledEvent：这是一个用于Web容器的事件（例如启用了DispatcherServlet），当接收到前端请求时触发。

自定义事件

除了使用标准事件，我们还可以定义各种各样的事件。实现前面提到的三个接口/抽象类即可。

继承ApplicationEvent实现自定义事件：

packagechkui.springcore.example.javabase.event.custom;publicclassMyEventextendsApplicationEvent{privateString value ="This is my event!";publicMyEvent(Object source,String value){super(source);this.value = value;}publicStringgetValue(){returnvalue;}}

定义事件对应的Listener:

packagechkui.springcore.example.javabase.event.custom;publicclassMyEventListenerimplementsApplicationListener{publicvoidonApplicationEvent(MyEvent event){System.out.println("MyEventListener :"+ event.getValue());}}

然后通过ApplicationEventPublisher接口发布事件：

packagechkui.springcore.example.javabase.event.custom;@ServicepublicclassMyEventServiceimplementsApplicationEventPublisherAware{privateApplicationEventPublisher publisher;@OverridepublicvoidsetApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher){publisher = applicationEventPublisher;}publicvoidpublish(String value){publisher.publishEvent(newMyEvent(this, value));}}

使用@EventListener实现订阅者

在Spring Framework4.2之后可以直接使用@EventListener注解来指定事件的处理器，我们将上面的MyEventListener类进行简单的修改：

packagechkui.springcore.example.javabase.event.custom;publicclassMyEventListenerAnnotation{@EventListenerpublicvoidhandleMyEvent(MyEvent event){System.out.println("MyEventListenerAnnotation :"+ event.getValue());    }}

使用@EventListener可以不必实现ApplicationListener，只要添加为一个Bean即可。Spring会根据方法的参数类型订阅对应的事件。

我们也可以使用注解指定绑定的事件：

packagechkui.springcore.example.javabase.event.custom;publicclassMyEventListenerAnnotation{@EventListener(ContextStartedEvent.class})publicvoidhandleMyEvent(){//----}}

 还可以指定一次性监听多个事件：

packagechkui.springcore.example.javabase.event.standard;publicclassMultiEventListener{@EventListener({ContextStartedEvent.class, ContextStoppedEvent.class})@Order(2)voidcontenxtStandadrEventHandle(ApplicationContextEvent event){System.out.println("MultiEventListener:"+ event.getClass().getSimpleName());}}

注意上面代码中的@Order注解，同一个事件可以被多个订阅者订阅。在多个定于者存在的情况下可以使用@Order注解来指定他们的执行顺序，数值越小越优先执行。

EL表达式设定事件监听的条件

通过注解还可以使用Spring的EL表达式来更细粒度的控制监听的范围，比如下面的例子仅仅当事件的实例中MyEvent.value == "Second publish!"才触发处理器：

事件：

packagechkui.springcore.example.javabase.event.custom;publicclassMyEventextendsApplicationEvent{privateString value ="This is my event!";publicMyEvent(Object source,String value){super(source);this.value = value;}publicStringgetValue(){returnvalue;}}

通过EL表达式指定监听的数据：

packagechkui.springcore.example.javabase.event.custom;publicclassMyEventListenerElSp{@EventListener(condition="#p0.value == 'Second publish!'")publicvoidhandleMyEvent(MyEvent event){System.out.println("MyEventListenerElSp :"+ event.getValue());    }}

这样，当这个事件被发布，而且其中的成员变量value值等于"Second publish!"，对应的MyEventListenerElSp::handleMyEvent方法才会被触发。EL表达式还可以使用通配符等等丰富的表现形式来设定过滤规则，后续介绍EL表达式时会详细说明。

通用包装事件

Spring还提供一个方式使用事件来包装实体类，起到传递数据但是不用重复定义多个事件的作用。看下面的例子。

我们先定义2个实体类：

packagechkui.springcore.example.javabase.event.generics;classPES{publicStringtoString(){return"PRO EVOLUTION SOCCER";}}classWOW{publicStringtoString(){return"World Of Warcraft";}}

定义可以用于包装任何实体的事件，需要实现ResolvableTypeProvider接口：

packagechkui.springcore.example.javabase.event.generics;publicclassEntityWrapperEventextendsApplicationEventimplementsResolvableTypeProvider{publicEntityWrapperEvent(T entity){super(entity);}publicResolvableTypegetResolvableType(){returnResolvableType.forClassWithGenerics(getClass(),                ResolvableType.forInstance(getSource()));}}

订阅者可以根据被包裹的entity的不同来监听不同的事件：

packagechkui.springcore.example.javabase.event.generics;publicclassEntiryWrapperEventListener{@EventListenerpublicvoidhandlePES(EntityWrapperEvent evnet){System.out.println("EntiryWrapper PES: "+  evnet);}@EventListenerpublicvoidhandleWOW(EntityWrapperEvent evnet){System.out.println("EntiryWrapper WOW: "+  evnet);}}

上面的代码起到最用的主要是ResolvableType.forInstance(getSource())这一行代码，getSource()方法来自于EventObject类，它实际上就是返回构造方法中super(entity)设定的entity实例。

写在最后的

订阅/发布模式是几乎所有软件程序都会触及的问题，无论是浏览器前端、还是古老的winMFC程序。而在后端应用中，对于使用过MQ工具或者Vertx这种纯事件轮询驱动的框架码友，应该已经请清楚这种订阅/发布+事件驱动的价值。它除了能够降低各层的耦合度，还能更有效的利用多线程而大大的提执行效率（当然对开发人员的要求也会高不少）。

对于Spring核心框架来说，事件的订阅/发布只是IoC容器的一个附属功能，Spring的核心价值并不在这个地方。Spring的订阅发布功能在实现层面至少现在并没有使用EventLoop的方式，还是类与类之间的直接调用，所以在性能上是完全无法向Vertx看齐的。不过Spring事件的机制还是能够起到事件驱动的效果，可以用来全局控制一些状态。如果选用Spring生态中的框架（boot等）作为我们的底层框架，现阶段还是应该使用IoC的方式来组合功能，而事件的订阅/发布仅仅用于辅助。