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