EventBus封装

EventBus是一款针对Android优化的发布/订阅事件总线。可以替代广播、startActivityForResultHandler、异步回调等来实现各组件间、组件与后台线程间的通信。它的优点是开销小,代码更优雅,以及将发送者和接收者解耦。

通常我们在使用EventBus的时候都是直接需要接收通信的Activity/Fragment中通过EventBus.getDefault().register(this)订阅事件,在需要发起通信的逻辑直接调用EventBus.getDefault().post(Object event)来发布事件。但是要是一个项目中有很多地方都使用EventBus来通信,比如重新登录后更新各个页面的登录状态,或者是接收到通知更新消息提示等,都这样直接使用的话代码重复率很高,并且呢,如果以后升级或者更换EventBus时,各个地方都要修改,这就比较麻烦了。因此我一般是将EventBus的发布和订阅封装到BaseActivity/BaseFragment中。

在Gradle中添加EventBus依赖:

compile 'org.greenrobot:eventbus:3.0.0'

封装一下EventBus的订阅、取消订阅、发布等方法:

public class EventBusUtil {

    public static void register(Object subscriber) {
        EventBus.getDefault().register(subscriber);
    }

    public static void unregister(Object subscriber) {
        EventBus.getDefault().unregister(subscriber);
    }

    public static void sendEvent(Event event) {
        EventBus.getDefault().post(event);
    }
    
    public static void sendStickyEvent(Event event) {
        EventBus.getDefault().postSticky(event);
    }

    // 其他
}

BaseActivity/BaseFragment中的onCreateonDestroy方法中订阅和取消订阅,这里添加了一个isRegisterEventBus()方法,默认返回false,即不订阅EventBus,子类Activity/Fragment如果需要订阅的话复写这个方法并返回true即可。

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    if (isRegisterEventBus()) {
        EventBusUtil.register(this);
    }
}

/**
 * 是否注册事件分发
 *
 * @return true绑定EventBus事件分发,默认不绑定,子类需要绑定的话复写此方法返回true.
 */
protected boolean isRegisterEventBus() {
    return false;
}

@Override
public void onDestroy() {
    super.onDestroy();
    if (isRegisterEventBus()) {
        EventBusUtil.unregister(this);
    }
}

定义事件Event

public class Event<T> {
    private int code;
    private T data;

    public Event(int code) {
        this.code = code;
    }

    public Event(int code, T data) {
        this.code = code;
        this.data = data;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

通过泛型<T>指定事件通信过程中的数据类型,code为事件码,使用的时候给不同的事件类型指定不同的code

BaseActivity\BaseFragment中添加接收到EventBus的方法:

/**
 * 是否注册事件分发
 *
 * @return true绑定EventBus事件分发,默认不绑定,子类需要绑定的话复写此方法返回true.
 */
protected boolean isRegisterEventBus() {
    return false;
}

@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventBusCome(Event event) {
    if (event != null) {
        receiveEvent(event);
    }
}

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onStickyEventBusCome(Event event) {
    if (event != null) {
        receiveStickyEvent(event);
    }
}

/**
 * 接收到分发到事件
 *
 * @param event 事件
 */
protected void receiveEvent(Event event) {

}

/**
 * 接受到分发的粘性事件
 *
 * @param event 粘性事件
 */
protected void receiveStickyEvent(Event event) {

}

根据自己项目的需求,在订阅了EventBusActivity/Fragment中复写receiveEvent(Event event)receiveStickyEvent(Event event)来处理接收到事件后的逻辑。

这里也可以不用在BaseActivty/BaseFragment中添加接受事件的方法(因为添加了过后不能确定的子类的Event泛型)。那么就直接在订阅的Activity/Fragment中给接收事件的方法添加EventBus对应的事件接受注解,并指定参数Event的泛型。

@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventReceived(Event<User> event) {
    if (event != null && event.getCode() == C.EventCode.C) {
        User user = event.getData();
    }
}

在给定Eventcode的时候最好在常量池中定义一个类专门用来定义不同类型的EventBuscode,这样在接收到EventBus的地方可以根据这些code值来判断Event的来源。

public final class C {
    // EventBus Code
    public static final class EventCode {
        public static final int A = 0x111111;
        public static final int B = 0x222222;
        public static final int C = 0x333333;
        public static final int D = 0x444444;
        // other more
    }
}

使用示例:
MainActivity中复写isRegisterEventBus()并返回true注册EventBus,复写receiveEvent(Event event)接收发布的事件。

@Override
protected boolean isRegisterEventBus() {
    return true;
}

@Override
protected void receiveEvent(Event event) {
    // 接受到Event后的相关逻辑
    switch (event.getCode()) {
        case C.EventCode.A:
            Log.d("EventBus", "接收到A类型的Event");
            break;
        case C.EventCode.B:
            Log.d("EventBus", "接收到B类型的Event");
            break;
        case C.EventCode.C:
            Log.d("EventBus", "接收到B类型的Event,携带User");
            User user = (User) event.getData();
            break;
        case C.EventCode.D:
            Log.d("EventBus", "接收到D类型的Event,携带News");
            News news = (News) event.getData();
            break;
    }
}

receiveEvent(Event event)根据对应的事件的code,判断通信的数据来源和传递的数据类型,以完成对应的逻辑。

InfoActivity中发送事件,InfoActivity只发送不需要接收Event的话就不注册,也不用复写isRegisterEventBus()receiveEvent(Event event)方法了。

public void sendEventA(View view) {
    EventBusUtil.sendEvent(new Event(C.EventCode.A));
}

public void sendEventB(View view) {
    EventBusUtil.sendEvent(new Event(C.EventCode.B));
}

public void sendEventC(View view) {
    Event<User> event = new Event<>(C.EventCode.C, new User());
    EventBusUtil.sendEvent(event);
}

public void sendEventD(View view) {
    Event<News> event = new Event<>(C.EventCode.D, new News());
    EventBusUtil.sendEvent(event);
}

通过上面的方式,将EventBus封装到BaseActivity/BaseFragment中,使得EventBus和项目解耦更加彻底,同时在需要使用的子Activity/Fragment中只需要复写isRegisterEventBus()receiveEvent(Event event)即可,不用每个地方都去订阅和取消订阅。并且给Event给定code和泛型能够很好的区分不同的事件来源和数据类型。


源码:https://github.com/xiaoyanger0825/EventBusExample

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • 先吐槽一下博客园的MarkDown编辑器,推出的时候还很高兴博客园支持MarkDown了,试用了下发现支持不完善就...
    Ten_Minutes阅读 549评论 0 2
  • 面试有一种技巧据说叫做反客为主,当遇到Activity-Fragment通信,甚至模块化开发时的通信问题等等,可以...
    TruthKeeper阅读 517评论 0 6
  • 我们通过一个简单的权限控制需求(RABC,Role-Based Access Control,基于角色的访问控制)...
    开心跳蚤阅读 3,043评论 0 13
  • 2004年,我第一次来到深圳。 我是坐长途汽车去的,那时的汽车还是卧铺,坐在车上,就是睡觉。车上被子有一股怪味,但...
    亦农阅读 376评论 10 13