eventbus

先吐槽一下博客园的MarkDown编辑器,推出的时候还很高兴博客园支持MarkDown了,试用了下发现支持不完善就没用了,这次这篇是在其他编辑器下写的,复制过来后发现。。太烂了。怎么着作为一个技术博客社区,对代码的支持应该完善一下吧,`行内代码块`不支持就算了,代码段内还不能有空行,一有空行就识别不了了。而且试着用MarkDown发了篇草稿,右边的侧边栏竟然被挤到屏幕下方了,还影响到了博客布局。。不说了。。简单修改下标题、代码直接发表。

概述及基本概念

**EventBus**是一个Android端优化的publish/subscribe消息总线,简化了应用程序内各组件间、组件与后台线程间的通信。比如请求网络,等网络返回时通过Handler或Broadcast通知UI,两个Fragment之间需要通过Listener通信,这些需求都可以通过**EventBus**实现。

作为一个消息总线,有三个主要的元素:

Event:事件

Subscriber:事件订阅者,接收特定的事件

Publisher:事件发布者,用于通知Subscriber有事件发生

Event

**Event**可以是任意类型的对象。

Subscriber

在EventBus中,使用约定来指定事件订阅者以简化使用。即所有事件订阅都都是以onEvent开头的函数,具体来说,函数的名字是onEvent,onEventMainThread,onEventBackgroundThread,onEventAsync这四个,这个和ThreadMode有关,后面再说。

Publisher

可以在任意线程任意位置发送事件,直接调用EventBus的`post(Object)`方法,可以自己实例化EventBus对象,但一般使用默认的单例就好了:`EventBus.getDefault()`,根据post函数参数的类型,会自动调用订阅相应类型事件的函数。

ThreadMode

前面说了,Subscriber函数的名字只能是那4个,因为每个事件订阅函数都是和一个`ThreadMode`相关联的,ThreadMode指定了会调用的函数。有以下四个ThreadMode:

PostThread:事件的处理在和事件的发送在相同的进程,所以事件处理时间不应太长,不然影响事件的发送线程,而这个线程可能是UI线程。对应的函数名是onEvent。

MainThread: 事件的处理会在UI线程中执行。事件处理时间不能太长,这个不用说的,长了会ANR的,对应的函数名是onEventMainThread。

BackgroundThread:事件的处理会在一个后台线程中执行,对应的函数名是onEventBackgroundThread,虽然名字是BackgroundThread,事件处理是在后台线程,但事件处理时间还是不应该太长,因为如果发送事件的线程是后台线程,会直接执行事件,如果当前线程是UI线程,事件会被加到一个队列中,由一个线程依次处理这些事件,如果某个事件处理时间太长,会阻塞后面的事件的派发或处理。

Async:事件处理会在单独的线程中执行,主要用于在后台线程中执行耗时操作,每个事件会开启一个线程(有线程池),但最好限制线程的数目。

根据事件订阅都函数名称的不同,会使用不同的ThreadMode,比如果在后台线程加载了数据想在UI线程显示,订阅者只需把函数命名为onEventMainThread。

简单使用

基本的使用步骤就是如下4步,点击此链接查看例子及介绍。

定义事件类型:

`public class MyEvent {}`

定义事件处理方法:

`public void onEventMainThread`

注册订阅者:

`EventBus.getDefault().register(this)`

发送事件:

`EventBus.getDefault().post(new MyEvent())`

实现

**EventBus**使用方法很简单,但用一个东西,如果不了解它的实现用起来心里总是没底,万一出问题咋办都不知道,所以还是研究一下它的实现,肯定要Read the fucking Code。其实主要是`EventBus`这一个类,在看看Code时需要了解几个概念与成员,了解了这些后实现就很好理解了。

EventType:onEvent\*函数中的参数,表示事件的类型

Subscriber:订阅源,即调用register注册的对象,这个对象内包含onEvent\*函数

SubscribMethod:`Subscriber`内某一特定的onEvent\*方法,内部成员包含一个`Method`类型的method成员表示这个onEvent\*方法,一个`ThreadMode`成员threadMode表示事件的处理线程,一个`Class`类型的eventType成员表示事件的类型`EventType`。

Subscription,表示一个订阅对象,包含订阅源`Subscriber`,订阅源中的某一特定方法`SubscribMethod`,这个订阅的优先级`priopity`

了解了以上几个概念后就可以看`EventBus`中的几个重要成员了

//EventType -> List,事件到订阅对象之间的映射privatefinalMap, CopyOnWriteArrayList>subscriptionsByEventType;//Subscriber -> List,订阅源到它订阅的的所有事件类型的映射privatefinalMap>>typesBySubscriber;//stickEvent事件,后面会看到privatefinalMap, Object>stickyEvents;//EventType -> List,事件到它的父事件列表的映射。即缓存一个类的所有父类privatestaticfinalMap, List>> eventTypesCache =newHashMap, List>>();

注册事件:Register

通过`EventBus.getDefault().register`方法可以向`EventBus`注册来订阅事件,`register`有很多种重载形式,但大都被标记为`Deprecated`了,所以还是不用为好,前面说了事件处理方法都是以*onEvent*开头,其实是可以通过register方法修改的,但相应的方法被废弃了,还是不要用了,就用默认的*onEvent*,除下废弃的register方法,还有以下4个**public**的`register`方法

publicvoidregister(Object subscriber) {

register(subscriber, defaultMethodName,false, 0);

}publicvoidregister(Object subscriber,intpriority) {

register(subscriber, defaultMethodName,false, priority);

}publicvoidregisterSticky(Object subscriber) {

register(subscriber, defaultMethodName,true, 0);

}publicvoidregisterSticky(Object subscriber,intpriority) {

register(subscriber, defaultMethodName,true, priority);

}

可以看到,这4个方法都调用了同一个方法:

privatesynchronizedvoidregister(Object subscriber, String methodName,booleansticky,intpriority) {

List subscriberMethods =subscriberMethodFinder.findSubscriberMethods(subscriber.getClass(),

methodName);for(SubscriberMethod subscriberMethod : subscriberMethods) {

subscribe(subscriber, subscriberMethod, sticky, priority);

}

}

第一个参数就是订阅源,第二个参数就是用到指定方法名约定的,默认为*onEvent*开头,说默认是其实是可以通过参数修改的,但前面说了,方法已被废弃,最好不要用。第三个参数表示是否是*Sticky Event*,第4个参数是优先级,这两个后面再说。

在上面这个方法中,使用了一个叫`SubscriberMethodFinder`的类,通过其`findSubscriberMethods`方法找到了一个`SubscriberMethod`列表,前面知道了`SubscriberMethod`表示Subcriber内一个onEvent\*方法,可以看出来`SubscriberMethodFinder`类的作用是在Subscriber中找到所有以methodName(即默认的onEvent)开头的方法,每个找到的方法被表示为一个`SubscriberMethod`对象。

`SubscriberMethodFinder`就不再分析了,但有两点需要知道:

所有事件处理方法**必需是`public void`类型**的,并且只有一个参数表示*EventType*。

`findSubscriberMethods`不只查找*Subscriber*内的事件处理方法,**同时还会查到它的继承体系中的所有基类中的事件处理方法**。

找到*Subscriber*中的所有事件处理方法后,会对每个找到的方法(表示为`SubscriberMethod`对象)调用`subscribe`方法注册。`subscribe`方法干了三件事:

根据`SubscriberMethod`中的*EventType*类型将`Subscribtion`对象存放在`subscriptionsByEventType`中。建立*EventType*到*Subscription*的映射,每个事件可以有多个订阅者。

根据`Subscriber`将`EventType`存放在`typesBySubscriber`中,建立*Subscriber*到*EventType*的映射,每个Subscriber可以订阅多个事件。

如果是*Sticky*类型的订阅者,直接向它发送上个保存的事件(如果有的话)。

通过*Subscriber*到*EventType*的映射,我们就可以很方便地使一个Subscriber取消接收事件,通过*EventType*到*Sucscribtion*的映射,可以方便地将相应的事件发送到它的每一个订阅者。

Post事件

直接调用`EventBus.getDefault().post(Event)就可以发送事件,根据Event的类型就可以发送到相应事件的订阅者。

publicvoidpost(Object event) {

PostingThreadState postingState=currentPostingThreadState.get();

List eventQueue =postingState.eventQueue;

eventQueue.add(event);if(postingState.isPosting) {return;

}else{

postingState.isMainThread= Looper.getMainLooper() ==Looper.myLooper();

postingState.isPosting=true;if(postingState.canceled) {thrownewEventBusException("Internal error. Abort state was not reset");

}try{while(!eventQueue.isEmpty()) {

postSingleEvent(eventQueue.remove(0), postingState);

}

}finally{

postingState.isPosting=false;

postingState.isMainThread=false;

}

}

}

可以看到post内使用了`PostingThreadState`的对象,并且是`ThreadLocal`,来看`PostingThreadState`的定义:

finalstaticclassPostingThreadState {

List eventQueue =newArrayList();booleanisPosting;booleanisMainThread;

Subscription subscription;

Object event;booleancanceled;

}

主要是有个成员`eventQueue`,由于是ThreadLocal,所以结果就是,每个线程有一个`PostingThreadState`对象,这个对象内部有一个事件的队列,并且有一个成员`isPosting`表示现在是否正在派发事件,当发送事件开始时,会依次取出队列中的事件发送出去,如果正在派发事件,那么post直接把事件加入队列后返回,还有个成员`isMainThread`,这个成员在实际派发事件时会用到,在`postSingleEvent`中会用到。

privatevoidpostSingleEvent(Object event, PostingThreadState postingState)throwsError {

Class eventClass =event.getClass();

List> eventTypes = findEventTypes(eventClass);//1booleansubscriptionFound =false;intcountTypes =eventTypes.size();for(inth = 0; h < countTypes; h++) {//2Class clazz =eventTypes.get(h);

CopyOnWriteArrayListsubscriptions;synchronized(this) {

subscriptions=subscriptionsByEventType.get(clazz);

}if(subscriptions !=null&& !subscriptions.isEmpty()) {//3for(Subscription subscription : subscriptions) {

postingState.event=event;

postingState.subscription=subscription;booleanaborted =false;try{

postToSubscription(subscription, event, postingState.isMainThread);//4aborted =postingState.canceled;

}finally{

postingState.event=null;

postingState.subscription=null;

postingState.canceled=false;

}if(aborted) {break;

}

}

subscriptionFound=true;

}

}if(!subscriptionFound) {

Log.d(TAG,"No subscribers registered for event " +eventClass);if(eventClass != NoSubscriberEvent.class&& eventClass != SubscriberExceptionEvent.class) {

post(newNoSubscriberEvent(this, event));

}

}

}

来看一下`postSingleEvent`这个函数,首先看第一点,调用了`findEventTypes`这个函数,代码不帖了,这个函数的应用就是,把这个类的类对象、实现的接口及父类的类对象存到一个List中返回.

接下来进入第二步,遍历第一步中得到的List,对List中的每个类对象(即事件类型)执行第三步操作,即找到这个事件类型的所有订阅者向其发送事件。可以看到,**当我们Post一个事件时,这个事件的父事件(事件类的父类的事件)也会被Post,所以如果有个事件订阅者接收Object类型的事件,那么它就可以接收到所有的事件**。

还可以看到,实际是通过第四步中的`postToSubscription`来发送事件的,在发送前把事件及订阅者存入了`postingState`中。再来看`postToSubscription`

privatevoidpostToSubscription(Subscription subscription, Object event,booleanisMainThread) {switch(subscription.subscriberMethod.threadMode) {casePostThread:

invokeSubscriber(subscription, event);break;caseMainThread:if(isMainThread) {

invokeSubscriber(subscription, event);

}else{

mainThreadPoster.enqueue(subscription, event);

}break;caseBackgroundThread:if(isMainThread) {

backgroundPoster.enqueue(subscription, event);

}else{

invokeSubscriber(subscription, event);

}break;caseAsync:

asyncPoster.enqueue(subscription, event);break;default:thrownewIllegalStateException("Unknown thread mode: " +subscription.subscriberMethod.threadMode);

}

}

这里就用到`ThreadMode`了:

如果是PostThread,直接执行

如果是MainThread,判断当前线程,如果本来就是UI线程就直接执行,否则加入`mainThreadPoster`队列

如果是后台线程,如果当前是UI线程,加入`backgroundPoster`队列,否则直接执行

如果是Async,加入`asyncPoster`队列

BackgroundPoster

privatefinalPendingPostQueue queue;publicvoidenqueue(Subscription subscription, Object event) {

PendingPost pendingPost=PendingPost.obtainPendingPost(subscription, event);synchronized(this) {

queue.enqueue(pendingPost);if(!executorRunning) {

executorRunning=true;

EventBus.executorService.execute(this);

}

}

}

代码比较简单,其实就是,待发送的事件被封装成了`PendingPost`对象,`PendingPostQueue`是一个`PendingPost`对象的队列,当`enqueue`时就把这个事件放到队列中,`BackgroundPoster`其实就是一个Runnable对象,当`enqueue`时,如果这个Runnable对象当前没被执行,就将`BackgroundPoster`加入EventBus中的一个线程池中,当`BackgroundPoster`被执行时,会依次取出队列中的事件进行派发。当长时间无事件时`BackgroundPoster`所属的线程被会销毁,下次再Post事件时再创建新的线程。

HandlerPoster

`mainThreadPoster`是一个`HandlerPoster`对象,`HandlerPoster`继承自`Handler`,构造函数中接收一个`Looper`对象,当向`HandlerPoster` enqueue事件时,会像`BackgroundPoster`一样把这个事件加入队列中, 只是如果当前没在派发消息就向自身发送Message

voidenqueue(Subscription subscription, Object event) {

PendingPost pendingPost=PendingPost.obtainPendingPost(subscription, event);synchronized(this) {

queue.enqueue(pendingPost);if(!handlerActive) {

handlerActive=true;if(!sendMessage(obtainMessage())) {thrownewEventBusException("Could not send handler message");

}

}

}

}

在`handleMessage`中会依次取出队列中的消息交由`EventBus`直接调用事件处理函数,而`handleMessage`执行所在的线程就是构造函数中传进来的`Looper`所属的线程,在`EventBus`中构造`mainThreadPoster`时传进来的是MainLooper,所以会在UI线程中执行。

AsyncPoster

`AsyncPoster`就简单了,把每个事件都加入线程池中处理

publicvoidenqueue(Subscription subscription, Object event) {

PendingPost pendingPost=PendingPost.obtainPendingPost(subscription, event);

queue.enqueue(pendingPost);

EventBus.executorService.execute(this);

}

Stick Event

通过`registerSticky`可以注册Stick事件处理函数,前面我们知道了,无论是`register`还是`registerSticky`最后都会调用`Subscribe`函数,在`Subscribe`中有这么一段代码:

也就是会根据事件类型从`stickyEvents`中查找是否有对应的事件,如果有,直接发送这个事件到这个订阅者。而这个事件是什么时候存起来的呢,同`register`与`registerSticky`一样,和`post`一起的还有一个`postSticky`函数:

if(sticky) {

Object stickyEvent;synchronized(stickyEvents) {

stickyEvent=stickyEvents.get(eventType);

}if(stickyEvent !=null) {//If the subscriber is trying to abort the event, it will fail (event is not tracked in posting state)//--> Strange corner case, which we don't take care of here.postToSubscription(newSubscription, stickyEvent, Looper.getMainLooper() ==Looper.myLooper());

}

}

当通过`postSticky`发送一个事件时,这个类型的事件的最后一次事件会被缓存起来,当有订阅者通过`registerSticky`注册时,会把之前缓存起来的这个事件直接发送给它。

事件优先级Priority

`register`的函数重载中有一个可以指定订阅者的优先级,我们知道`EventBus`中有一个事件类型到List的映射,在这个映射中,所有的Subscription是按priority排序的,这样当post事件时,优先级高的会先得到机会处理事件。

优先级的一个应用就事,高优先级的事件处理函数可以终于事件的传递,通过`cancelEventDelivery`方法,但有一点需要注意,`这个事件的ThreadMode必须是PostThread`,并且只能终于它在处理的事件。

# 缺点

无法进程间通信,如果一个应用内有多个进程的话就没办法了

# 注意事项及要点

同一个onEvent函数不能被注册两次,所以不能在一个类中注册同时还在父类中注册

当Post一个事件时,这个事件类的父类的事件也会被Post。

Post的事件无Subscriber处理时会Post `NoSubscriberEvent`事件,当调用Subscriber失败时会Post `SubscriberExceptionEvent`事件。

其他

`EventBus`中还有个Util包,主要作用是可以通过`AsyncExecutor`执行一个Runnable,通过内部的RunnableEx(可以搜索异常的Runnable)当Runnable抛出异常时通过`EventBus`发消息显示错误对话框。没太大兴趣,不作分析

项目主页:https://github.com/greenrobot/EventBus

一个很简单的Demo,Activity中包含列表和详情两个Fragment,Activity启动时加载一个列表,点击列表后更新详情数据:EventBusDemo

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容