专栏首页技术墨客Spring核心——全局事件管理 原

Spring核心——全局事件管理 原

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

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

Spring事件管理的内容包括标准事件、自定义事件、注解标记处理器、异步事件处理、通用实体包装。下面将通过几个例子来说明这些内容,可执行代码请到本人的gitee库下载,本文的内容在包chkui.springcore.example.javabase.event中。

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

标准事件

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

先指定2个订阅者:

package chkui.springcore.example.javabase.event.standard;
public class ContextStartedListener implements ApplicationListener<ContextStartedEvent> {
	@Override
	public void onApplicationEvent(ContextStartedEvent event) {
		System.out.println("Start Listener: I am start");
	}
}
package chkui.springcore.example.javabase.event.standard;
public class ContextStopListener implements ApplicationListener<ContextStoppedEvent> {
	@Override
	public void onApplicationEvent(ContextStoppedEvent event) {
		System.out.println("Stop Listener: I am stop");
	}
}

 然后运行使用他们:

package chkui.springcore.example.javabase.event;
@Configuration
public class EventApp {

	@Bean
	ContextStopListener contextStopListener() {
		return new ContextStopListener();
	}
	
	@Bean
	ContextStartedListener contextStartedListener() {
		return new ContextStartedListener();
	}
	
	public static void main(String[] args) {
		ConfigurableApplicationContext context = new AnnotationConfigApplicationContext(EventApp.class);
		//发布start事件
		context.start();
		//发布stop事件
		context.stop();
        //关闭容器
		context.close();
	}
}

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

  1. ContextRefreshedEvent:ConfigurableApplicationContext::refresh方法被调用后触发。事件发出的时机是所有的后置处理器已经执行、所有的Bean已经被加载、所有的ApplicationContext接口方法都可以提供服务。
  2. ContextStartedEvent:ConfigurableApplicationContext::start方法被调用后触发。
  3. ContextStoppedEvent:ConfigurableApplicationContext::stop方法被调用后触发。
  4. ContextClosedEvent:ConfigurableApplicationContext::close方法被调用后触发。
  5. RequestHandledEvent:这是一个用于Web容器的事件(例如启用了DispatcherServlet),当接收到前端请求时触发。

自定义事件

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

继承ApplicationEvent实现自定义事件:

package chkui.springcore.example.javabase.event.custom;
public class MyEvent extends ApplicationEvent {

	private String value = "This is my event!";
	
	public MyEvent(Object source,String value) {
		super(source);
		this.value = value;
	}

	public String getValue() {
		return value;
	}
}

定义事件对应的Listener:

package chkui.springcore.example.javabase.event.custom;
public class MyEventListener implements ApplicationListener<MyEvent> {
	public void onApplicationEvent(MyEvent event) {
		System.out.println("MyEventListener :" + event.getValue());
	}
}

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

package chkui.springcore.example.javabase.event.custom;
@Service
public class MyEventService implements ApplicationEventPublisherAware {
	private ApplicationEventPublisher publisher;
	@Override
	public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
		publisher = applicationEventPublisher;
	}

	public void publish(String value) {
		publisher.publishEvent(new MyEvent(this, value));
	}
}

使用@EventListener实现订阅者

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

package chkui.springcore.example.javabase.event.custom;
public class MyEventListenerAnnotation{
	@EventListener
    public void handleMyEvent(MyEvent event) {
		System.out.println("MyEventListenerAnnotation :" + event.getValue());
    }
}

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

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

package chkui.springcore.example.javabase.event.custom;
public class MyEventListenerAnnotation{
	@EventListener(ContextStartedEvent.class})
    public void handleMyEvent() {
        //----
    }
}

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

package chkui.springcore.example.javabase.event.standard;
public class MultiEventListener {
	@EventListener({ContextStartedEvent.class, ContextStoppedEvent.class})
    @Order(2)
	void contenxtStandadrEventHandle(ApplicationContextEvent event) {
		System.out.println("MultiEventListener:" + event.getClass().getSimpleName());
	}
}

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

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

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

事件:

package chkui.springcore.example.javabase.event.custom;
public class MyEvent extends ApplicationEvent {
	private String value = "This is my event!";
	public MyEvent(Object source,String value) {
		super(source);
		this.value = value;
	}

	public String getValue() {
		return value;
	}
}

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

package chkui.springcore.example.javabase.event.custom;
public class MyEventListenerElSp {
	@EventListener(condition="#p0.value == 'Second publish!'")
    public void handleMyEvent(MyEvent event) {
		System.out.println("MyEventListenerElSp :" + event.getValue());
    }
}

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

通用包装事件

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

我们先定义2个实体类:

package chkui.springcore.example.javabase.event.generics;
class PES {
	public String toString() {
		return "PRO EVOLUTION SOCCER";
	}
}
class WOW {
	public String toString() {
		return "World Of Warcraft";
	}
}

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

package chkui.springcore.example.javabase.event.generics;
public class EntityWrapperEvent<T> extends ApplicationEvent implements ResolvableTypeProvider {

	public EntityWrapperEvent(T entity) {
		super(entity);
	}

	public ResolvableType getResolvableType() {
		return ResolvableType.forClassWithGenerics(getClass(),
                ResolvableType.forInstance(getSource()));
	}

}

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

package chkui.springcore.example.javabase.event.generics;
public class EntiryWrapperEventListener {
	@EventListener
	public void handlePES(EntityWrapperEvent<PES> evnet) {
		System.out.println("EntiryWrapper PES: " +  evnet);
	}
	@EventListener
	public void handleWOW(EntityWrapperEvent<WOW> 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的方式来组合功能,而事件的订阅/发布仅仅用于辅助。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Spring@Configuration、@Bean、@Import 、@ImportResource、@DependsOn 说明

    使用spring的这几个配置,可以将旧<xml>配置形式完全使用Java实现,也可以和<xml>嵌套使用。

    随风溜达的向日葵
  • Jolokia架构介绍 原

        虽然jolokia是为了满足JSR-160的要求,但是他和JSR-160连接器有巨大的差异。其中最引人注目的区别是jolokia传递数据是无类型的数据(...

    随风溜达的向日葵
  • Spring核心——Bean的依赖注入 原

    在设计模式与IoC这篇文章中,介绍了Spring基础的三大支柱的两项内容——IoC、Bean。本篇将继续围绕着Bean的创建时的注入方式来介绍Spring的核心...

    随风溜达的向日葵
  • Spring事务监听机制---使用@TransactionalEventListener处理数据库事务提交成功后再执行操作(附:Spring4.2新特性讲解)【享学Spring】

    从标题就可以看出,本篇文章内容既和Spring的事件/监听机制有关,同时还和Spring事务以及Spring事务同步机制有关。

    YourBatman
  • Spring之事件监听(观察者模型)

      本文介绍下Spring中的事件监听,其本质也就是观察者模型(发布/订阅模式),具体的观察者模式参考下文

    用户4919348
  • 实战:简书爬取之多线程爬取(二)速度提升何止10倍

    其次就是这样的代码往往会有很严重的竞争问题,需要很多的资源锁来保证线程安全,这样就拉低了程序执行的速度。

    渔父歌
  • 八篇 ICCV 2019 最新图神经网络、CV相关论文

    为了带大家抢先领略高质量论文,小编特意整理了八篇ICCV 2019最新GNN相关论文,并附上arXiv论文链接供参考——点云结合、姿态估计、行为定位、视觉传感、...

    新智元
  • Spring Boot中读取配置属性的几种方式

      本文介绍Spring Boot中读取配置属性的几种方式,项目示例中用到的application.yml和application.properties定义如下...

    happyJared
  • 只知道自媒体能赚钱?你可知新媒体的来龙去脉?受益匪浅,很受用

    前段时间通过申请加入了今日头条新媒体训练营,我将在今日头条新媒体训练营进行为期五个月的学习课程。下面一段时间,我将会把在今日头条训练营学习到的内容,整理思考,分...

    做全栈攻城狮
  • 前端学习(53)~键盘事件

    onmousewheel:鼠标滚轮滚动的事件,会在滚轮滚动时触发。但是火狐不支持该属性。

    Vincent-yuan

扫码关注云+社区

领取腾讯云代金券