
后端思维篇:如何抽一个观察者模板(二)
5. Spring观察者模式原理
Spring 中实现的观察者模式包含三部分:分别是Event事件(相当于消息)、Listener监听者(相当于观察者)、Publisher发送者(相当于被观察者)。用个图表示就是这样:这个ApplicationEvent是放到哪里的,监听者AppliactionListener是如何监听到的。接下来,我们来看下spring框架的观察者原理是怎样哈~
我们先来看下ApplicationEventPublisher源代码(被观察者/发布者)
ApplicationEventPublisher它只是一个函数式接口,我们再看下它接口方法的实现。它的具体实现类是AbstractApplicationContext,这个类代码有点多,我把关键部分代码贴出来了:
通过以上代码,我们可以发现,真正的消息发送,实际上是通过事件广播器ApplicationEventMulticaster 这个接口来完成的。multicastEvent是主要方法,这个方法的实现在类SimpleApplicationEventMulticaster中,我们一起来看下源码:
可以发现,默认情况下,spring实现的观察者模式,同步阻塞的。如果想异步执行事件,可以自定义SimpleApplicationEventMulticaster,然后构造一下executor线程池就好啦。代码如下:
demo跑一下,运行结果:
如果手动新建SimpleApplicationEventMulticaster,并设置taskExecutor的话,所有的监听响应事件,都是异步执行的哦。而有些有些场景我们希望同步执行的,这时候这种实现方式就不好了。
其实spring提供了@Async注解,可以用来实现异步。具体怎么实现呢?其实很简单,只需要在配置类加上@EnableAsync,接着在需要异步执行的监听实现方法。加上@Async即可。代码实现如下:
日常开发中,异步执行也可以自己手动通过线程池来开启啦。回到我们本文的后端思维主题,如果每个开发,都自己定义观察者模式的实现,这种代码会很混乱,所以最好是实现一个可扩展,通用的观察者模板。
6. 基于spring观察者模式,抽取一个模板
接下来的最后小节,跟大家一起基于spring的观察者模式,一步一步实现并抽取个模板哈。
我们要基于spring实现观察者模式的话,就包括这三步:
1.定义Event事件(相当于消息),一般定义一个Event对象,继承ApplicationEvent1.
2.定义Listener监听者(相当于观察者),实现接口ApplicationListener
3.Publisher发送者(相当于被观察者),通过ApplicationEventPublisher发布。
6.1 定义Event事件对象
既然我们要抽取观察者模板,那肯定不是每个人自己写自己的Event,然后都去继承ApplicationEvent。
我们可以自己定义一个项目相关的,通用的BaseEvent类,然后一些相关通用的信息属性可以放进去,比如eventId或者流水号bizSeq什么的,都可以,看你们项目需要哈。以下代码,我定义一个空空如也的BaseEvent
如果你的观察者模式,是注册成功之后,发个消息的,你就可以声明一个消息类事件对象RegisterMessageEvent,继承通用的BaseEvent即可。然后属性可以自定义就好,比如messageId。
同理,如果你想定义一个用户送礼物成功,然后发个广播,可以定义一个GiftSendEvent
其他业务场景类似,只要想接入你的观察者模板,只需要自己定义事件对象,继承于你的BaseEvent即可,是不是成就感满满啦。
6.2 定义Listener监听者(观察者啦)
定义完Event事件,我们就可以开始定义监听者了。我们定义的监听者,只需要实现接口ApplicationListener接口即可。如果每个人也是各写各的,这些就很乱,毫无模板规范可言了。
我们可以封装一下嘛,如何封装呢?很简单,可以先声明一个IEventListener,让它继承ApplicationListener接口,我们都知道,接口也是可以继承的哈。如下:
监听者的实现,关键在于实现ApplicationListener的onApplicationEvent的接口方法即可。又因为未来别的业务场景接入观察者模式,都是按你的模板来,所以各个Event事件对象,都是继承于你的BaseEvent的,所以我们可以把<T extends BaseEvent>的泛型加进去,如下:
有些时候,可能会有这种场景,就是执行监听逻辑,只对部分数据(或者说部分特殊用户才执行)。既然我们是抽取监听模板,考虑到可扩展性,我们可以优化下IEventListener的代码。我们可以声明一个support的方法,默认是执行的,子类可以覆盖重写(让子类去控制是否执行这个监听逻辑),如下:
然后呢,只有support方法返回true,才执行监听的逻辑,我们还可以定义一个handler方法,给子类去实现自己的业务逻辑,代码如下:
对着以上的代码模板,小伙伴们是否还有一些优化的想法呢?
如果方法产生了异常,我们是不是可以注意一下异常处理呢?以上小节,SimpleApplicationEventMulticaster源码分析的时候,不知道大家有没有细看,其实它就用了一个很巧妙的异常处理,我们可以借鉴一下,哈哈哈,这就是看源码的一个小小的好处了。
我们可以给onApplicationEvent的实现try...catch...一下,如果catch住异常的话,可以定义一个handlerException异常处理方法,给子类自定义去实现,当然,异常可以默认不处理嘛,代码如下:
最后呢,不同业务不同的监听者(观察者),直接实现你的IEventListener就好啦,比如注册成功那个,我们声明一个RegisterMessageListenerImpl类,如下:
6.3 定义Publisher发送者模板
我们的观察者模板,最后一步就是定义发送者模板。最简单的发送,就是利用ApplicationContext直接发送就好。
为什么可以直接使用applicationContext来发送,文章开始介绍,我们不是用ApplicationEventPublisher来发送嘛?其实是因为applicationContext继承了ApplicationEventPublisher接口
这个只是同步阻塞方式的观察者模式,一般来说,一个通用的观察者模板。也需要提供异步非阻塞方式的观察者模板。本文第5小节,我们知道了,在配置类加上@EnableAsync,在需要异步执行的监听加上@Async,即可实现异步。
为了方便管理,和API语义更明确,我们可以手动设置线程池,给我们的模板发布类,提供异步发送的接口。我们先自定义一个线程池,一般不建议直接使用JDK的线程池。
如何自定义线程池呢?
我们在application.properties配置文件,定义线程池一些属性(核心线程数、最大线程数等等)
然后声明一个线程配置类TianLuoExecutorsConfig:
通过线程配置类TianLuoExecutorsConfig,初始化线程池TianLuoExecutorPool,代码如下:
然后回到EventPublish,把异步发布的接口加上,如下:
7. 唠叨几句
本文大家学到了哪些知识呢?
1.观察者模式定义,观察者模式的使用场景
2.如何实现一个简单的观察者模式
3.Spring观察者模式的原理
4.同步阻塞、异步非阻塞、spring观察者模式的实现
5.后端思维:如何抽取一个观察者模板`
6.进阶篇?有些小伙伴说,实现观察者模式,可以使用guava的eventBus,大家可以去看看哈,其实原理类似的。
然后的话,本文的源代码,如果小伙伴需要的话,可以关注公众号:程序员田螺,回复:观察者模式。
