事件总线之greenrobot/EventBus 学习笔记

1. 概述

EventBus是一个Android端优化的publish/subscribe消息总线,简化了应用程序内各组件间、组件与后台线程间的通信。主要功能是替代Intent,Handler,BroadCast在Fragment,Activity,Service,线程之间传递消息。优点是开销小,代码更优雅,以及将发送者和接收者解耦。

EventBus是一个通用的叫法,常见的有如下几个:
Google出品的Guava,Guava是一个庞大的库,EventBus只是它附带的一个小功能,因此实际项目中使用并不多
square/otto:修改自 Guava ,用的人也不少
greenrobot/EventBus,这个库的优点是接口简洁,集成方便
AndroidEventBus : 模仿EventBus开发的,基本使用流程:事件的发送方把事件发出,通过EventBus将事件传递给该事件的订阅者使用。

实际开发中,经常遇到组件之间通信,Activity/Fragment/Service/Adapter等,这些问题使用Intent、广播、接口回调等方式也可以解决,但是还是比较繁琐,所以就有了事件总线这个框架。

2. 基本用法

简单点说,Eventbus的用法有点类似广播,需要注册,然后在合适的地方发送,这样注册的地方就能收到。

添加依赖
compile 'org.greenrobot:eventbus:3.0.0'

1.1 定义一个类,也就是事件


/**
 * Created by dell on 2016/9/12.
 *
 * 定义事件
 *
 * 所有能被实例化为 Object 的实例都可以作为事件
 * eventbus 3中如果用到了索引加速,事件类的修饰符必须为 public
 */
public class MessageEvent {
    private String message;
    public MessageEvent(String message) {
        this.message = message;
    }
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
}

1.2 注册

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        /**
         * 注册目标组件,让总线得到这个目标中的发布者和订阅者
         *
         */
        BusProvider.getBuss().register(this);
        //注册到Eventbus
//        EventBus eventBus = EventBus.builder().addIndex(new MyEventBusIndex()).build();
        //把订阅者索引 自定义的设置应用到 EventBus 默认的单例中 ,提高性能
//        EventBus.builder().addIndex(new MyEventBusIndex()).installDefaultEventBus();
        /**
         * 在 总线中注册,只有在注册了才能接收到事件
         */
        EventBus.getDefault().register(this);
    }
    //取消注册
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
        BusProvider.getBuss().unregister(this);
    }

1.3 订阅

/**
     * 事件处理
     * 所有事件处理方法必需是public void类型的,并且只有一个参数表示EventType
     *
     * @param event
     * @Subscribe 表示订阅了MessageEvent
     * @Subscribe(threadMode = ThreadMode.POSTING( 为回调所在的线程 ), priority = 0 (优先级), sticky = true(是否 接收粘性事件))
     * <p/>
     * StickyEvent=false的订阅者能否接收postSticky的事件
     */
    @Subscribe
    public void updateText(MessageEvent event) {
        Log.i(getClass().getSimpleName(), "updateText");
        tv.setText(event.getMessage());
    }

1.4 在合适的地方 ,发送事件 。

    @OnClick(R.id.btn)
    public void onClick() {
        MessageEvent event = new MessageEvent("EventBus 返回来的消息");
        EventBus.getDefault().post(event);//把事件发出,通过eventbus将事件传递给该事件的订阅者使用
//        MessageEvent event = new MessageEvent("EventBus 返回 来的 粘性事件 消息");
        //发送粘性事件,注册了的且匹配事件的订阅者能够接收到事件
//        EventBus.getDefault().postSticky("");
        finish();
    }

需要注意的是, 有一个粘性事件,即事件发出后,再注册,也可以收到。
注册代码

/**
     * 粘性事件 —— 事件发出后,再注册也能收到
     * 也可以收到post的事件
     * //     * @param event
     */
    @Subscribe(sticky = true)
    public void handleSticky(MessageEvent event) {
        Log.i(getClass().getSimpleName(), "updateRightText");
        tvRight.setText(event.getMessage());
    }

3. 线程模型 :EventBus的四种ThreadMode(线程模型)

POSTING(默认):该事件在哪个线程发布出来的,事件处理函数就会在这个线程中运行,也就是说发布事件和接收事件在同一个线程。
MAIN:事件的处理会在UI线程中执行。
BACKGROUND:如果事件是在UI线程中发布出来的,那么该事件处理函数就会在新的线程中运行,如果事件本来就是子线程中发布出来的,那么该事件处理函数直接在发布事件的线程中执行。
ASYNC:无论事件在哪个线程发布,该事件处理函数都会在新建的子线程中执行。

另外除了可以设置处理事件所在线程,还可以设置优先级

 /**
     * 事件处理
     * 所有事件处理方法必需是public void类型的,并且只有一个参数表示EventType
     *
     * @param event
     * @Subscribe 表示订阅了MessageEvent
     * 
     * @Subscribe(threadMode = ThreadMode.POSTING( 为回调所在的线程 ), 
     * 
     * priority = 0 (优先级), sticky = true(是否 接收粘性事件))
     * <p/>
     * StickyEvent=false的订阅者能否接收postSticky的事件
     */
    @Subscribe(threadMode = ThreadMode.BACKGROUND ,priority = 100)
    public void updateText(MessageEvent event) {
        Log.i(getClass().getSimpleName(), "updateText");
        tv.setText(event.getMessage());
    }

4. 原理分析

事件 (event) 通过 post() 发送到总线,然后再分发到匹配事件类型的订阅者 (subscribers) 。订阅者只有在总线中注册 (register) 了才能收到事件,注销 (unrigister) 之后就收不到任何事件了。事件方法必须带有 Subscribe 的注解,必须是 public ,没有返回类型 void 并且只能有一个参数。

通过反射,获取到订阅者的所有方法。判断修饰符是不是PUBLIC 、方法的参数是不是一个、方法是不是被Subcribe 注解修饰 。

事件的分发时匹配的原则是根据事件类型,也就是说一个事件有多个订阅,那么事件发送后,这几个订阅者都能收到。这个在实际开发中需要注意。Github上还有一个AndroidEventBus,这个是模仿greenrobot/EventBus开发的,但是这个库中的订阅事件是有个tag 标记,用来区分同一事件、不同类别。

5. 后记

Eventbus 这个库在实际开发中很多 人在用,确实可以帮我们减少很多工作量,实现多层之间的通讯。

参考文档
1、EventBus 3.0的用法详解
2、Android事件总线(一)EventBus3.0用法全解析
3、EventBus3.0源码解析: 对源码分析很详细。
4、Bugly 干货—老司机教你 “飙” EventBus 3
本文会把重点放在分析这个EventBusAnnotationProcessor(注解分析生成索引)新特性上。
5、Eventbus Github主页

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

推荐阅读更多精彩内容