借助Spring可以非常简单的实现事件监听机制,本文简单介绍下面向接口与注解监听的两种姿势
I. 项目环境
本项目借助SpringBoot 2.2.1.RELEASE
+ maven 3.5.3
+ IDEA
进行开发
为了后面的发布事件验证,起一个web服务
1 | <dependencies> |
II. 事件机制
1. 事件对象
在Spring中,所有的事件需要继承自ApplicationEvent
,一个最基础的MsgEvent
如下
1 | public class MsgEvent extends ApplicationEvent { |
2. 接口方式消费
消费事件有两种方式,接口的声明,主要是实现ApplicationListener
接口;注意需要将listener声明为Spring的bean对象
1 |
|
3. 注解方式消费
实现接口需要新建实现类,更简单的方法是直接在消费方法上加一个注解@EventListener
1 | .class) (MsgEvent |
这个注解,支持根据Event参数类型进行匹配,即上面的实例中,方法上直接加@EventListener
不指定圆括号内部的也没关系
4. 发布事件
前面是消费事件,消费的前提是有事件产生,在Spring中,发布事件主要需要借助ApplicationContext
来实现
1 |
|
5. 测试
一个简单的测试demo
1 |
|
访问: curl http://localhost:8082/pub?msg=一灰灰blog
输出日志:
1 | receive msg by @anno: MsgEvent{msg='一灰灰blog'} |
上面这个测试两种消费方式都可以成功,但是,在实测的过程中发现一种case,注解消费方式不生效,测试姿势如下
1 |
|
直接在启动类的构造方法中发布事件,发现接口方式可以接收事件,但是注解方式不生效,why?
在stockoverstack上有个相似的问题 https://stackoverflow.com/questions/38487474/springboot-eventlistener-dont-receive-events,这里主要提了一个观点
- 发布消息比事件消费注册的要早
那么是这个原因么? 静待下次源码分析
II. 其他
0. 项目
- 工程:https://github.com/liuyueyi/spring-boot-demo
- 源码:https://github.com/liuyueyi/spring-boot-demo/blob/master/spring-boot/012-context-listener/
1. 一灰灰Blog
尽信书则不如,以上内容,纯属一家之言,因个人能力有限,难免有疏漏和错误之处,如发现bug或者有更好的建议,欢迎批评指正,不吝感激
下面一灰灰的个人博客,记录所有学习和工作中的博文,欢迎大家前去逛逛
- 一灰灰Blog个人博客 https://blog.hhui.top
- 一灰灰Blog-Spring专题博客 http://spring.hhui.top
Be the first person to leave a comment!