EventBus源码解析

EventBus是一个开源的事件总线项目,项目地址:EventBus

EventBus通过注册监听器和发布消息的方式来完成事件的传递,如下所示:

EventBus事件传递机制

其中Publisher为事件的发布者,Subscriber为事件的订阅者。下图为EventBus的DEMO使用方法:

DEMO使用方法

使用EventBus主要分为以下四步:

1、注册成为事件接受者:EventBus.getDefault().register(this)将当前类注册为事件接受者

2、注销:通过EventBus.getDefault().unregister(this)进行注销;

3、订阅事件:通过@Subscribe注解对方法进行注解,注解的方法必须有且仅有一个参数,这里我们定义了MyEvent作为订阅的事件。

4、发布事件:EventBus.getDefault().post(MyEvent)可以发布一个事件,EventBus会根据发布的消息的类型,找到该类型消息的订阅者,完成消息的传递。

@Subscribe注解

@Subscribe注解

@Subscribe注解的定义如上图所示,通过@Rentention将注解定义为TUNTIME,表示该注解将会保留到JVM运行时,也就是可以通过反射进行调用;通过@Target将注解定义为METHOD,表示该注解只能应用于method;在使用@Subscribe注解时,可以设置threadMode、sticky、priority属性。

threadMode:指定订阅方法运行的线程,根据其值在对应的线程调用订阅Method。

sticky:指定是否是粘性事件,如果为true,在调用register的时候,会接受到注册监听之前EventBus postSticky发送过的同一类型的消息。

priority:优先级,EventBus根据订阅者的优先级来顺序发布事件。

EventBus的主要成员

EventBus.getDefault()以单例的方式获取EventBus实例,这里重点介绍下EventBus的成员变量:

EventBus构造

1、subscriptionsByEventType

是一个Map对象,Key为@Subcribe注解的方法的参数类型,对应到本文一开始的DEMO的MyEvent的Class对象,Value为Subscription列表。

Subscription

Subscription的subscriber对象指的是EventBus.getDefault().register(this)的this对象,subscriberMethod指的是@Subcribe注解的方法的Method对象。

一句话:subscriptionsByEventType保存了订阅MyEvent事件的订阅者列表。

2、typesBySubscriber

是一个Map对象,Key为EventBus.getDefault().register(this)的this对象,Value为this对象中所有的@Subcribe注解方法的参数类型,也就是订阅的事件类型。

3、stickyEvents

是一个Map对象,postSticky发送的粘性事件会保存到该Map中。

发送粘性事件

Key为发送的粘性事件的Class对象,Value为粘性事件。

4、mainThreadSupport&mainThreadPoster(threadMode=MAIN 或者MAIN_ORDERED)

类型为mainThreadSupport类型为MainThreadSupport,mainThreadPoster类型为HandlerPoster。

mainThreadSupport的实现

通过Looper对象判断当前是否是主线程,创建HandlerPoster赋值给mainThreadPoster,HandlerPoster继承自Handler,handleMessage完成事件的分发,保证订阅方法运行在主线程。

5、backgroundPoster(threadMode=BACKGROUND)

和mainThreadPoster类似,实现类是BackgroundPoster,该类继承实现了Runnable接口,在异步线程调用订阅者的方法。

BackgroundPoster

6、asyncPoster(threadMode=ASYNC)

AsyncPoster

实现类是AsyncPoster,也是通过后台线程调用订阅者方法,完成事件发布。但与BackgroundPoster有如下区别:

BackgroundPoster:如果当前线程是主线程,就调用backgroundPoster发布事件;如果当前发布时已经是异步线程,那么就直接反射运行订阅者方法,不需要开启线程了。

AsyncPoster:无论在哪个线程post事件都开启新的线程执行。

7、subscriberMethodFinder

实现类是SubscriberMethodFinder,在EventBus.getDefault().register(this)的时候查询this对象及其父类对象的所有@Subcribe注解的方法。

到这里,介绍完EventBus主要的成员后,下面分析下EventBus.getDefault().register的流程。

注册事件订阅者

EventBus.getDefault().register(this);将当前类注册为事件订阅者。

register

register主要分为以下三步:

1、subscriber.getClass获取订阅者的Class对象

2、subscriberMethodFinder.findSubscriberMethods(subscriberClass)获取订阅者及其父类的所有@Subscribe注解的Method。

findSubscriberMethods

通过findUsingInfo来获取订阅者及其父类的所有订阅方法:

findUsingInfo

findUsingInfo首先初始化了FindState,FindState是个什么东东?

FindState

上图描述了FindState的作用和信息,FindState用来查找和保存订阅者及其父类的订阅信息,订阅的方法保存在subscriberMethods中;subscriberInfo默认为空,所以在初始化完FindState后会循环调用findUsingReflectionInSingleClass方法,该方法通过反射来获取FindState.clazz的@Subscribe注解方法,findUsingInfo会一直循环,直到clazz已经没有符合要求的父类了。

findUsingReflectionInSingleClass

在循环结束后,findState.subscriberMethods保存了订阅者及其父类的所有SubscriberMethod。

3、对每个subscriberMethod调用subscribe(subscriber, subscriberMethod)方法。

第2步获取到所有订阅方法后,就循环调用subscribe(subscriber, subscriberMethod)。

subscribe

至此,register方法运行结束了,subscriptionsByEventType中保存了某个类型消息对应的Subscription列表,Subscription中包含了订阅者和订阅方法;typesBySubscriber保存了某个订阅者的所有订阅事件类型;最后也完成了sticky事件的发布。

发布事件

通过EventBus.getDefault().post(postEvent);可以发布一个事件。

post

发布事件有以下过程:


1、获取当前的发布状态PostingThreadState

PostingThreadState

PostingThreadState定义了当前正在发布的事件状态。

2、将事件保存到等待队列

3、循环调用postSingleEvent发布事件

postSingleEvent

postSingleEvent调用了lookupAllEventTypes()获取要发布的事件及其父类的Class对象,也就是说如果发布MyEvent事件,订阅了MyEvent事件或者其父类事件的订阅者都能收到MyEvent事件(可以这样理解,订阅了MyEvent的父类事件,MyEvent是其父类的一种类型,也应该发布)。postSingleEventForEventType完成单个事件的发布:

postSingleEventForEventType

首先在subscriptionsByEventType获取eventClass对应的订阅列表,然后调用postToSubscription进行发布。

postToSubscription

postToSubscription会根据SubscriberMethod的ThreadMode确定调用哪个Poster就进行事件发布。无论在主线程还是异步线程,最终都是调用了invokeSubscriber:

invokeSubscriber

invokeSubscriber通过反射调用了subscriber的method,并传入了Event参数。

4、重置PostingThreadState状态

注销

通过EventBus.getDefault().unregister(this);可以完成注销,即订阅者不在关注任何事件了。

unregister
unsubscribeByEventType


至此,EventBus的注册、订阅消息、发布消息、注销的流程都已经分析完毕。

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

推荐阅读更多精彩内容