前言
今天去官网查看spring boot资料时,在特性中看见了系统的事件及监听章节。想想,spring的事件应该是在3.x版本就发布的功能了,并越来越完善,其为bean和bean之间的消息通信提供了支持。比如,我们可以在用户注册成功后,发送一份注册成功的邮件至用户邮箱或者发送短信。使用事件其实最大作用,应该还是为了业务解耦,毕竟用户注册成功后,注册服务的事情就做完了,只需要发布一个用户注册成功的事件,让其他监听了此事件的业务系统去做剩下的事件就好了。对于事件发布者而言,不需要关心谁监听了该事件,以此来解耦业务。今天,我们就来讲讲spring boot中事件的使用和发布。当然了,也可以使用像guava的eventbus或者异步框架Reactor来处理此类业务需求的。本文仅仅谈论ApplicationEvent以及Listener的使用。
一点知识
示例前,我们来了解下相关知识点。
Java的事件机制
java中的事件机制一般包括3个部分:EventObject,EventListener和Source。
EventObject
java.util.EventObject是事件状态对象的基类,它封装了事件源对象以及和事件相关的信息。所有java的事件类都需要继承该类。
EventListener
java.util.EventListener是一个标记接口,就是说该接口内是没有任何方法的。所有事件监听器都需要实现该接口。事件监听器注册在事件源上,当事件源的属性或状态改变的时候,调用相应监听器内的回调方法。
Source
事件源不需要实现或继承任何接口或类,它是事件最初发生的地方。因为事件源需要注册事件监听器,所以事件源内需要有相应的盛放事件监听器的容器。
java的事件机制是一个观察者模式。大家可以根据这个模式,自己实现一个。可以看看这篇博文:《java事件机制》一个很简单的实例。
Spring的事件
ApplicationEvent以及Listener是Spring为我们提供的一个事件监听、订阅的实现,内部实现原理是观察者设计模式,设计初衷也是为了系统业务逻辑之间的解耦,提高可扩展性以及可维护性。
ApplicationEvent就是Spring的事件接口ApplicationListener就是Spring的事件监听器接口,所有的监听器都实现该接口ApplicationEventPublisher是Spring的事件发布接口,ApplicationContext实现了该接口ApplicationEventMulticaster就是Spring事件机制中的事件广播器,默认实现SimpleApplicationEventMulticaster在Spring中通常是ApplicationContext本身担任监听器注册表的角色,在其子类AbstractApplicationContext中就聚合了事件广播器ApplicationEventMulticaster和事件监听器ApplicationListnener,并且提供注册监听器的addApplicationListnener方法。
其执行的流程大致为:
当一个事件源产生事件时,它通过事件发布器ApplicationEventPublisher发布事件,然后事件广播器ApplicationEventMulticaster会去事件注册表ApplicationContext中找到事件监听器ApplicationListnener,并且逐个执行监听器的onApplicationEvent方法,从而完成事件监听器的逻辑。
在Spring中,使用注册监听接口,除了继承ApplicationListener接口外,还可以使用注解@EventListener来监听一个事件,同时该注解还支持SpEL表达式,来触发监听的条件,比如只接受编码为001的事件,从而实现一些个性化操作。下文示例中会简单举例下。
简单来说,在Java中,通过java.util. EventObject来描述事件,通过java.util. EventListener来描述事件监听器,在众多的框架和组件中,建立一套事件机制通常是基于这两个接口来进行扩展。
SpringBoot的默认启动事件
在SpringBoot1.5.x中,提供了几种事件,供我们在开发过程中进行更加便捷的扩展及差异化操作。
ApplicationStartingEvent:springboot启动开始的时候执行的事件ApplicationEnvironmentPreparedEvent:spring boot对应Enviroment已经准备完毕,但此时上下文context还没有创建。在该监听中获取到ConfigurableEnvironment后可以对配置信息做操作,例如:修改默认的配置信息,增加额外的配置信息等等。ApplicationPreparedEvent:spring boot上下文context创建完成,但此时spring中的bean是没有完全加载完成的。在获取完上下文后,可以将上下文传递出去做一些额外的操作。值得注意的是:在该监听器中是无法获取自定义bean并进行操作的。ApplicationReadyEvent:springboot加载完成时候执行的事件。ApplicationFailedEvent:spring boot启动异常时执行事件。
从官网文档中,我们可以知道,由于一些事件实在上下文为加载完触发的,所以无法使用注册bean的方式来声明,文档中可以看出,可以通过SpringApplication.addListeners(…)或者SpringApplicationBuilder.listeners(…)来添加,或者添加META-INF/spring.factories文件z中添加监听类也是可以的,这样会自动加载。
启动类中添加:
所以在需要的时候,可以通过适当的监听以上事件,来完成一些业务操作。
自定义事件发布和监听
通过以上的介绍,我们来定义一个自定义事件的发布和监听。
0.加入POM依赖,这里为了演示加入了web依赖。事件相关类都在spring-context包下。
1.自定义事件源和实体。
MessageEntity.java
CustomEvent.java
2.编写监听类使用@EventListener方式。
**注意:
Spring中,事件源不强迫继承ApplicationEvent接口的,也就是可以直接发布任意一个对象类。但内部其实是使用PayloadApplicationEvent类进行包装了一层。这点和guava的eventBus类似。**而且,使用@EventListener的condition可以实现更加精细的事件监听,condition支持SpEL表达式,可根据事件源的参数来判断是否监听。
使用ApplicationListener方式。
3.编写控制类,示例发布事件。
4.编写启动类。
这里,创建了个ApplicationStartingEvent事件监听类。
5.启动应用,控制台可以看出,在启动时,我们监听到了ApplicationStartingEvent事件
首先访问下:http://127.0.0.1:8080/push?code=lqdev&message=趔趄的猿,可以看见事件已经被监听到了,而监听了codeoKong的监听未触发
然后访问下:http://127.0.0.1:8080/push?code=oKong&message=趔趄的猿,可以看见此时三个监听事件都接收到了事件了
此时,由于写了一个监听所有事件的方法,可以看见请求结束后,会发布一个事件,ServletRequestHandledEvent,里面记录了请求的时间、请求url、请求方式等等信息。
异步监听处理
默认情况下,监听事件都是同步执行的。在需要异步处理时,可以在方法上加上@Async进行异步化操作。此时,可以定义一个线程池,同时开启异步功能,加入@EnableAsync。对于异步处理,可以查看之前发布的文章:《第二十一章:异步开发之异步调用》。里面有详细的介绍异步调用,这里就不阐述了。
异步简单示例:
关于事务绑定事件
当一些场景下,比如在用户注册成功后,即数据库事务提交了,之后再异步发送邮件等,不然会发生数据库插入失败,但事件却发布了,也就是邮件发送成功了的情况。此时,我们可以使用@TransactionalEventListener注解或者TransactionSynchronizationManager类来解决此类问题,也就是:事务成功提交后,再发布事件。当然也可以利用返回上层(事务提交后)再发布事件的方式了,只是不够优雅而已罢了,其实能起作用就好了,是吧~
本例中未使用到数据库,就不示例了,都在Spring-tx包下。
具体可查看文章:Spring Event 事件中的事务控制
参考资料
https://docs.spring.io/spring-boot/docs/1.5.15.RELEASE/reference/htmlsingle/#boot-features-application-events-and-listenershttps://blog.csdn.net/eos2009/article/details/77773551https://www.cnblogs.com/senlinyang/p/8496099.html总结
本章节主要简单介绍了spring的事件机制。感兴趣的同学,可以编写一个监听所有事件的方法,然后看看系统运行各类请求或者相关操作时,系统会发布哪些事件,了解后可以在之后碰见一些特殊业务需求时,可以适当的监听相关的事件来完成特定的业务公共。同时对这种观察者模式,大家还可以看看eventbus和reactor了。后者没用过,有时间倒是可以看看。最近买了本RxJava2书籍,确实要好好补课下了。
举报/反馈

计算机java编程

3.6万获赞 5215粉丝
擅长并专注于计算机java编程文化领域!
科技领域爱好者
关注
0
0
收藏
分享