开源框架 | EventBus 深入理解

EventBus 官方给出的说明是：EventBus 是一致基于发布/订阅模式的事件总线，适用于 Android/Java；

了解 EventBus 之前，应该先明白以下问题：

  1. 什么是发布/订阅模式？
  2. 什么又是事件总线？
  3. Android 已经有了广播机制，为什么还要使用 EventBus 实现组件间通信？

1. 使用

  • 定义一个事件
public class TestMessageEvent {
    public String msg;
    public TestMessageEvent(String msg) {
        this.msg = msg;
    }
}
  • 注册和取消注册
    @Override
    protected void onStart() {
        super.onStart();
        EventBus.getDefault().register(this); //注册
    }

    @Override
    protected void onStop() {
        EventBus.getDefault().unregister(this); //取消注册
        super.onDestroy();
    }
  • 定义接收事件的方法
    @Subscribe(threadMode = ThreadMode.MAIN，stickey = true)
    public void onTestMessageEvent(TestMessageEvent event) {
        //update UI
    }
  • 发送一条消息
    EventBus.getDefault().post(new TestMessageEvent("这是一条事件"));
    EventBus.getDefault().postSticky(new TestMessageEvent("这是一条黏性事件"));

2. 源码分析

2.1 EventBus.getDefault()

从上面的介绍中不难发现，在使用 EventBus 时都是通过 EventBus.getDefault() 来进行调用的，而正好这个方法是通过单例模式获取一个 EventBus 实例，我们在整个应用进程的任何时刻任何地方调用该方法可以确保调用的是唯一的且是同一个 EventBus 实例。

    public static EventBus getDefault() {
        EventBus instance = defaultInstance;
        if (instance == null) {
            synchronized (EventBus.class) {
                instance = EventBus.defaultInstance;
                if (instance == null) {
                    instance = EventBus.defaultInstance = new EventBus();
                }
            }
        }
        return instance;
    }

当应用进程中还没有 EventBus 实例时则创建一个，通过 EventBus 的构造方法结合建造者模式返回了一个 EventBus 实例。

2.2 register(Object subscriber)

由于 EventBus 是基于观察者模式实现的，调用 register() 方法用于注册接收事件的类，即注册观察者模式中的观察者，register() 方法中这个代表类的参数是 Object 修饰的，这表明我们可以在任何一个类中注册并接收事件，也可以在任何一个类中发送事件，比如常用 Activity、Fragment、Service、Adapter 等。

当一个类调用了注册方法之后，首先会解析该类中带有 @Subscribe 注解的方法并保存在一个集合中，这些方法是用于接收事件的，即观察者方法，接着会遍历这个集合里的方法：

  1. 判断优先级：根据注解中定义的优先级排序方法，在同一线程的方法，优先级相同则按照代码中方法编写的顺序排列，优先级越高的方法排在集合靠前的位置并且会优先接收到事件消息，每个带有 @Subscribe 注解的方法优先级默认是0；

  2. 判断观察方法是否用于接收黏性事件：如果该方法是用于接收黏性事件的，首先从存有黏性事件的 Map 中获取黏性事件，如果存在黏性事件则发送给观察者。由此可见观察者在注册就可以收到之前保存的黏性事件，黏性事件是怎么来的呢？它必定是在注册这个观察者之前就已经准备好了的且也调用了发送方法 post()，由于接受该黏性事件的观察者还没有创建所以并没有发送成功，我们的被观察者会优先把黏性事件保存起来，接着观察者在被创建并注册时会再次调用发送消息的方法，观察者便能收到这个黏性事件；

黏性事件不同于普通事件的是，普通事件是先创建观察者并注册，然后等待被观察者发送消息，一旦有消息发送出来便能立即收到；黏性事件在发送时，先会通过 Map 保存起来，观察者不需要立即接收事件并处理，允许观察者在需要的时候通过 getStickEvent() 获取被观察者发送的黏性事件并处理。

来看看 EventBus 中的几个集合，有点绕，要细细品味一下：

    //保存每种事件类型的订阅信息（所有订阅该事件观察者方法），用于被观察者发布消息给订阅了该事件的观察者方法
    private final Map<Class<?>, CopyOnWriteArrayList<Subscription>> subscriptionsByEventType; 
    //保存每个观察者观察的事件类型，主要用于标记观察者的注册状态
    private final Map<Object, List<Class<?>>> typesBySubscriber; 
    //保存每种事件类型对应的黏性事件，用于观察者在需要时获取黏性事件
    private final Map<Class<?>, Object> stickyEvents;
2.3 unRegister(Object subscriber)

解除注册就比较简单了，基本就是将在注册时添加的信息进行清除即可：

  1. 清除 subscriptionsByEventType：清除所有事件类型订阅信息中属于当前观察者的 subscriptions；
  2. 清除 typesBySubscriber：清除当前观察者观察的事件类型列表；
2.4 post(Object event)

发送一条指定事件类型的消息时，首先获取到订阅了当前事件类型相关的 Subscription 集合（Subscription 包含了观察者和观察方法的对应关系），即所有订阅了该事件类型的观察方法，遍历集合依次发送给每一个订阅了该事件类型的观察方法，由于所有的观察方法在 register() 注册观察者时已经根据优先级进行了排序，所以遍历集合的顺序就是优先级的顺序；接着根据观察者方法的 线程模型（threadMode）的不同决定观察者方法在主线程还是子线程执行，最后通过反射的方式调用观察方法。

2.5 postSticky(Object event)
发送黏性事件流程.jpg

发送黏性事件，事件先保存再发送，发送逻辑和普通事件一致都是调用 post() 方法发送，不同的是会先将这个事件保存在 stickEvents 中，stickyEvents 是一个 Map 集合，事件类为键，事件类的对象为值，这表明一个事件类只能保存一个事件对象，当有多条属于同一事件类的黏性事件发送时，之前发送的黏性事件都会被覆盖，stickEvents 中只能保存最后发送的那一条黏性事件，所以观察者在获取黏性事件时也只能获取到最后发送的那一条黏性事件：

    private final Map<Class<?>, Object> stickyEvents;

    public void postSticky(Object event) {
        synchronized (stickyEvents) {
            stickyEvents.put(event.getClass(), event);
        }
        // Should be posted after it is putted, in case the subscriber wants to remove immediately
        post(event);
    }
2.6 五种线程模型：

线程模型可以指定观察方法在哪个线程被调用，默认是 POSTING；

  • POSTING
    默认值，观察者方法在被观察者发送消息的同一线程被调用，不存在线程切换的开销；这种模式下如果被观察者在主线程发送消息，观察者需要立即接受消息避免造成主线程阻塞；
  • MAIN
    观察者方法在 UI 主线程调用，如果被观察者在在主线程发送消息，观察者方法也在主线程接受消息，那么观察者方法将立即收到消息，通过 invokeSubscriber()，观察者需要立即接收消息避免造成主线程阻塞；如果被观察者在子线程发送消息，通过 Handler （HandlerPoster）将消息发送到主线程并调用观察者方法；
    这种模式下消息发送一般是在主线程，且消息可以被立即接受，如果是在子线程发送消息，则通过一个在主线程创建的 Handler 将消息发送到主线程接收；
  • MAIN_ORDERED
    和 MAIN 一样，观察者方法都是在主线程调用，不同的是该模式下消息都是通过 Handler 按照发送的顺序依次发送到主线程并在主线程调用观察者方法，这确保了主线程不会有阻塞的风险；
    这种模式下消息既可以在主线程发送也可以在子线程发送，但都是通过 Handler 确保消息一定是在主线程接收的；
  • BACKGROUND
    观察者方法在子线程调用，如果被观察者也是在子线程发送消息，那么观察者方法会立即收到消息，通过 invokeSubscriber()，如果被观察者是在主线程发送消息，EventBus 使用自带的线程池按照发送的顺序依次传递消息；
  • ASYNC
    多用于需要在接收方法中处理耗时操作，如网络请求，该类观察方法属于异步方法，EventBus 使用线程池处理这类方法的调用。

3. 总结

3.1 优点：
  • EventBus 使得组件间通信更加简单：
    • 解耦观察者和被观察者；
    • 可以在 Activity、Fragment 和后台线程之间通信；
    • 避免了复杂且容易出错的依赖性和生命周期问题；
  • 效率高，jar 包体积小；
  • 实现代码量少，便于维护；
  • 可以自定义观察方法的优先级和线程模型，决定观察者接受事件的先后顺序以及在主线程还是子线程接受消息；
3.2 不足

针对不同的事件类型，需要定义不同的事件类以及接收不同事件类型的观察方法，当事件类型种类过多，代码量也就增加了。

4. 参考

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,080评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,422评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,630评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,554评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,662评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,856评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,014评论 3赞 408
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,752评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,212评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,347评论 4赞 331
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,973评论 3赞 315
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2赞 349