EventBus全解析系列(一)

前言

EventBus是一个Android开源库,其使用发布/订阅模式,以提供代码间的松耦合。EventBus使用中央通信方式,仅仅使用几行简单的代码,就可以达到解耦代码的目的。从而,简化代码,移除依赖,加快APP的开发速度。


源代码地址:github


EventBus优点

  • 简化组件之间的通信
  • 解耦事件的发送者和接受者
  • 很好的应用于Activity之间,Fragment之间,后台线程之间的通信,避免使用intent或者handler所带来的复杂度
  • 可以避免复杂的,易于出错的依赖和生命周期问题
  • 速度快,尤其是在做了优化之后
  • 轻量 (大概 50k 的jar包)
  • 被有100,000,000+安装量的众多app 在实际应用中验证
  • 有诸多高级特性,例如多种类型的线程模式,subscriber的优先级,等等

EventBus特性

  • 简单易用的基于注解的API:简单地把@Subscribe注解放在你的订阅方法前面即可。通过编译期的订阅者索引,app不需要在运行期做注解反射。
  • 支持事件投递到Android主线程:当订阅者需要和UI做交互的时候,EventBus能发送事件到主线程中去,而不管该事件是从哪个线程中发出来的。
  • 支持事件投递到后台线程:当订阅者需要做耗时任务时,EventBus能发送事件到后台线程中去,避免阻塞主线程。
  • 支持事件&订阅者继承关系:在EventBus中,面向对象也被应用到事件和订阅者类中。例如,事件类A是事件类B的父类,这时,发送B类型的事件,该事件也会发送给对于事件类A感兴趣的订阅者。对于订阅者类,也存在相似的继承关系。
  • 零设定即可使用:不需要任何设定,在你代码的任何地方,使用一个现成的默认的EventBus实例对象,你就可以开始工作了。
  • 可配置:使用建造者模式,你可以调整EventBus的行为,使之满足你的需求。

EventBus 3.0与2.x的区别

1.包名不同

  • EventBus 2.x

de.greenrobot.event

  • EventBus 3.0

org.greenrobot.eventbus

2.订阅方法

  • EventBus 2.x:
    使用固定的方法名标识订阅方法,方法名也代表了threadMode

onEvent() —— POST线程,订阅方法运行在发布者所在的线程
onEventMainThread() —— UI主线程,订阅方法运行在主线程
onEventBackground() —— 后台线程,发布者是主线程,订阅方法运行在新开子线程;发布者是子线程,订阅方法运行在发布者所在的线程;
onEventAsync() —— 异步线程,订阅方法运行在新开子线程,无论发布者是在哪个线程

  • EventBus 3.0:
    使用注解来标识订阅方法。同时可以指定threadMode,代表订阅方法所运行的线程;指定sticky,代表是否是粘性事件;指定priority,代表优先级。
public @interface Subscribe {
    ThreadMode threadMode() default ThreadMode.POSTING;

    /**
     * If true, delivers the most recent sticky event (posted with
     * {@link EventBus#postSticky(Object)}) to this subscriber (if event available).
     */
    boolean sticky() default false;

    /** Subscriber priority to influence the order of event delivery.
     * Within the same delivery thread ({@link ThreadMode}), higher priority subscribers will receive events before
     * others with a lower priority. The default priority is 0. Note: the priority does *NOT* affect the order of
     * delivery among subscribers with different {@link ThreadMode}s! */
    int priority() default 0;
}

ThreadMode.POSTING —— POST线程,订阅方法运行在发布者所在的线程(默认)
ThreadMode.MAIN —— UI主线程,订阅方法运行在主线程
ThreadMode.BACKGROUND —— 后台线程,发布者是主线程,订阅方法运行在新开子线程;发布者是子线程,订阅方法运行在发布者所在的线程;
ThreadMode.ASYNC —— 异步线程,订阅方法运行在新开子线程,无论发布者是在哪个线程

sticky,与Android广播机制中的sticky概念相同。即在订阅者注册之前,便已经把事件发送出去,等到注册之后,订阅者便会收到最近发送的粘性事件。注意是最近,即重复发送同一种类型的粘性事件,订阅者只能收到最后一条。

priority,当事件发送后,指定多个订阅者收到事件的顺序

    @Subscribe(threadMode = ThreadMode.MAIN, sticky = true, priority = 10)
    public void onEvent(EventBusEvent eventBusEvent) {
        tv.setText(eventBusEvent.info);
    }

3.参数配置的颗粒度

  • EventBus 2.x:
    priority 和 stickyness 仅仅以类为单位进行配置,迫使该类中所有订阅方法不得不共享同一配置
  • EventBus 3.0 :
    priority 和 stickyness 以方法为单位进行配置,颗粒度更细,显然更加灵活

4.性能提升

  • EventBus 2.x:
    运行时,使用反射的方式来查找回调方法,性能比较慢
  • EventBus 3.0:
    提供了EventBusAnnotationProcessor注解处理器,可以在编译期读取@Subscribe()注解并且解析其中所包含的信息,以供运行时直接使用,从而运行时的性能大大提高了

环境搭建

  • 不使用订阅者索引:

compile 'org.greenrobot:eventbus:3.0.0'

  • 使用订阅者索引:

稍微复杂些,而且需要一定的说明,放在下面的章节专门描述,在此不再赘述。


如何使用(分3步)(怎么想起了大象放冰箱...)

1.定义events,如果你需要更多的扩展性,可以考虑加入泛型:

    public class EventBusEvent {
        public final String info;
        public EventBusEvent (String Info) {
            this.info = Info;
        }
    }

2.准备 subscribers:
订阅者实现了事件处理方法,在事件被发送时,它将被调用。这相当于经典观察者模式中的update()方法。在EventBus3.0中,在你的订阅方法上加上注解, 可以指定一个thread mode。并且,方法必须是public权限,其方法参数有且只能有一个,另外类型必须为第一步定义好的事件类型:

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onEvent(EventBusEvent eventBusEvent) {
        tv.setText(eventBusEvent.info);
    }

同时,register 和 unregister 你的 subscriber。仅仅当订阅者被注册后,它们才能接收到事件。对于Android , activity 和 fragment 一般情况下应该依据生命周期来register,大部分情况下,可以放在onStart/onStop中:

    @Override
    public void onStart() {
        super.onStart();
        EventBus.getDefault().register(this);
    }
    
    @Override
    public void onStop() {
        super.onStop();
        EventBus.getDefault().unregister(this);
    }

3.发送 events:
这相当于经典观察者模式中的notifyObservers()方法。你可以在你的代码中的任何地方发送事件,所有当前被注册的并且匹配该事件类型的订阅者,都将接收到它。

    EventBus.getDefault().post(new EventBusEvent("Wild Android Monster"));

参考

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

推荐阅读更多精彩内容