Eventbus初探

本文主要介绍一下EventBus的基础使用和其对应的源码实现,如有问题,麻烦各位指出,谢谢大家。

EventBus简介

EventBus是一个用于解偶消息处理者和发送者的第三方库,常用于一些模块化开发中,多个模块或者页面的消息分发和处理,使用该库后能使代码更加简洁,让开发者能主要关注在业务细节上,而且该jar很小(50k内)

基本使用

在EventBus的github主页上可以看到,其最简单的用法如下:
1.定义一个事件类

public static class MessageEvent { /* Additional fields if needed */ }

2.在需要接收/处理该事件的类(例如类A.java)中使用注解(@Subscribe)标注一个方法用于接收事件

@Subscribe(threadMode = ThreadMode.MAIN)  
public void onMessageEvent(MessageEvent event) {/* Do something */};

3.将类A的对象注册到EventBus对象中:

EventBus.getDefault().register(this);

4.接下来你可以在其他类中发送该消息给A的对象了:

EventBus.getDefault().post(new MessageEvent());

源码实现

上述基本上算一个最简单的EventBus的使用实例,也已经基本包含了EventBus中涉及的角色,下面将整个流程分为两个步骤来详细介绍下源码中的实现:

初始化阶段

初始化阶段主要负责创建EventBus对象和注册事件处理者两步:

  1. 创建EventBus
    默认构造

    上述使默认的构造函数,可以看出其使用了默认的构建器,其中相关的成员变量作用说明如下:
    subscriptionsByEventType:存储订阅关系的HashMap,其中key为事件类型(类似上面的MesageEvent的class),value为Subscription对象的集合,其中Subscription类用于描述订阅关系(哪个对象订阅了什么类型的消息)
    typesBySubscriber: 存储某个订阅者订阅的多个事件的事件类型的HashMap,结合subscriptionsByEventType变量,就可以描述一个事件的多个处理者和一个处理者订阅多个事件类型
    mainThreadPoster:主线程的消息发射器,基本上后缀为Poster的类都是消息的发射器,只是发射的场景不一样(子线程或者后台或者异步等)
    subscriberMethodFinder:负责查找某个订阅者订阅的方法信息
    eventInheritance:是否支持事件继承关系
  2. 注册事件处理者
注册入口

注册的时候,首先通过方法查找器去找到该订阅者所订阅的事件对应的方法实现,之后会创建事件和订阅者之间的联系。


查找订阅者注解方法
在这里插入图片描述

在findSubscriberMethods方法中会先检查缓存是否有该类对应的方法列表,如果没有会调findUsingInfo,该方法返回List<SubscriberMethod>,所以Eventbus是支持一个订阅者订阅多个事件类的事件,其次可以看到其会遍历子类的父类,所以订阅者的子类也是可以收到事件的。接下来看一下它是怎么去查找订阅的方法的,实现在findUsingReflectionInSingleClass中:


查找类中的订阅方法

findUsingReflectionInSingleClass的参数是FindState对象,该类是用来暂时存储订阅者和订阅方法的中间对象,且使用了对象池的方式避免重复创建,一开始findState.clazz就是订阅者(参照基本使用中类A)的class,通过getDeclaredMethod方法获取到该类所有的方法,然后遍历去查找方法修饰符为public,且参数长度等于1的方法,如果没有,则会抛出异常,如果有,则会查找该方法是否有Subscribe注解所标注,如果是,则会进行添加前的检查,检查规则如下:
  • 一个类可以订阅多个事件类型,但是不能多次订阅一个事件类型
  • 子类可以覆盖或隐藏父类的相同事件类型的订阅
    当检查返回true时,会将订阅方法相关的信息(SubscriberMethod类)存储到List中,到这里,查找工作已经完成,接下来就是将建立订阅关系:


    建立订阅关系

    创建订阅关系的过程就是将订阅者和订阅的事件类型捆绑到Subscription对象中,并将Subscription对象按照事件类型和优先级顺序有序存储HashMap中的的过程;之后再将订阅者订阅的所有事件按照订阅者为key的方式存储,上述过程其实就是在实现一个订阅者的多个事件订阅和一个事件的多个订阅者的关系存储

事件分发

分发入口

上述是默认的事件分发入口函数,PostingThreadState类是分发状态类,使用ThreadLocal保存不同线程间的事件分发状态,这里获取到了当前线程的分发状态对象,将事件加入到其事件队列中,如果状态对象已经在分发,就直接跳过,如果没有分发,则进行分发,具体的分发实现在postSingleEvent函数中


分发单个事件

默认evenInheritance变量是为true,表示允许事件之间的继承或者实现关系(即一个事件如果继承了父事件,那么分发子事件的时候,也会发送父事件),其中lookupAllEventTypes方法就是去找到当前事件的所有类关系,如果当前事件是Object的直接子类,则evenTypes中只含有当前事件的class,之后会调用postSingleEventForEventType去发送单个事件,如果没有找到该事件的接收者,则会有可能去发送一个NoSubscriberEvent事件


发送单个事件

postSingleEventForEvenType方法首先根据事件类型查找到该事件所有的订阅关系描述实体,之后遍历各个实体,按顺序发送事件,如果发送过程中取消消息,则会中断消息发送,具体的发送代码在postToSubscription方法中
发送事件给订阅者

这里主要关注case MAIN中的流程,如果不是在主线程,则调用poster的enqueue方法,这个mainThreadPoster实际是一个主线程的Handler,这里enqueue方法是将订阅关系和事件通过发送消息的方式给了主线程,主线程会调用invokeSubscriber方法;如果是在主线程,则直接调用invokeSubscriber方法
调用订阅者的方法

可以看到这里直接使用的反射来调用订阅者的订阅方法,将事件传递给接收者,这样就将事件的发送者和事件的处理者通过订阅的关系成功解偶。
上述就是EventBus最简单的使用方式所对应的源码流程,如果有问题,请各位斧正,谢谢大家的指导。

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

推荐阅读更多精彩内容

  • EventBus源码分析(一) EventBus官方介绍为一个为Android系统优化的事件订阅总线,它不仅可以很...
    蕉下孤客阅读 3,972评论 4 42
  • 前面对EventBus 的简单实用写了一篇,相信大家都会使用,如果使用的还不熟,或者不够6,可以花2分钟瞄一眼:h...
    gogoingmonkey阅读 314评论 0 0
  • 项目到了一定阶段会出现一种甜蜜的负担:业务的不断发展与人员的流动性越来越大,代码维护与测试回归流程越来越繁琐。这个...
    fdacc6a1e764阅读 3,158评论 0 6
  • 我想,这世上的人和事,只要念念不忘,必有回响!
    有风来过19阅读 398评论 0 1
  • 我们都生活在一个空间里 这个空间到处都是未知的迷题 我们总是在寻找答案 一层一层地揭露剥离 但一切像是和我们开了 ...
    孟浔阅读 324评论 0 0