mazouri

【开源项目11】组件间通信利器EventBus

概述及基本概念

**EventBus**是一个Android端优化的publish/subscribe消息总线，简化了应用程序内各组件间、组件与后台线程间的通信。比如请求网络，等网络返回时通过Handler或Broadcast通知UI，两个Fragment之间需要通过Listener通信，这些需求都可以通过**EventBus**实现。

作为一个消息总线，有三个主要的元素：

Event：事件
Subscriber：事件订阅者，接收特定的事件
Publisher:事件发布者，用于通知Subscriber有事件发生

Event

**Event**可以是任意类型的对象。

Subscriber

在EventBus中，使用约定来指定事件订阅者以简化使用。即所有事件订阅都都是以onEvent开头的函数，具体来说，函数的名字是 onEvent，onEventMainThread，onEventBackgroundThread，onEventAsync这四个，这个和 ThreadMode有关，后面再说。

Publisher

可以在任意线程任意位置发送事件，直接调用EventBus的`post(Object)`方法，可以自己实例化EventBus对象，但一般使用默认的单例就好了：`EventBus.getDefault()`，根据post函数参数的类型，会自动调用订阅相应类型事件的函数。

ThreadMode

前面说了，Subscriber函数的名字只能是那4个，因为每个事件订阅函数都是和一个`ThreadMode`相关联的，ThreadMode指定了会调用的函数。有以下四个ThreadMode：

PostThread：事件的处理在和事件的发送在相同的进程，所以事件处理时间不应太长，不然影响事件的发送线程，而这个线程可能是UI线程。对应的函数名是onEvent。
MainThread: 事件的处理会在UI线程中执行。事件处理时间不能太长，这个不用说的，长了会ANR的，对应的函数名是onEventMainThread。
BackgroundThread：事件的处理会在一个后台线程中执行，对应的函数名是onEventBackgroundThread，虽然名字是BackgroundThread，事件处理是在后台线程，但事件处理时间还是不应该太长，因为如果发送事件的线程是后台线程，会直接执行事件，如果当前线程是UI线程，事件会被加到一个队列中，由一个线程依次处理这些事件，如果某个事件处理时间太长，会阻塞后面的事件的派发或处理。
Async：事件处理会在单独的线程中执行，主要用于在后台线程中执行耗时操作，每个事件会开启一个线程（有线程池），但最好限制线程的数目。

根据事件订阅都函数名称的不同，会使用不同的ThreadMode，比如果在后台线程加载了数据想在UI线程显示，订阅者只需把函数命名为onEventMainThread。

简单使用

基本的使用步骤就是如下4步，点击此链接查看例子及介绍。

定义事件类型：
`public class MyEvent {}`
定义事件处理方法：
`public void onEventMainThread`
注册订阅者：
`EventBus.getDefault().register(this)`
发送事件：
`EventBus.getDefault().post(new MyEvent())`

实现

**EventBus**使用方法很简单，但用一个东西，如果不了解它的实现用起来心里总是没底，万一出问题咋办都不知道，所以还是研究一下它的实现，肯定要Read the fucking Code。其实主要是`EventBus`这一个类，在看看Code时需要了解几个概念与成员，了解了这些后实现就很好理解了。

EventType：onEvent\*函数中的参数，表示事件的类型
Subscriber：订阅源，即调用register注册的对象，这个对象内包含onEvent\*函数
SubscribMethod：`Subscriber`内某一特定的onEvent\*方法，内部成员包含一个`Method`类型的 method成员表示这个onEvent\*方法，一个`ThreadMode`成员threadMode表示事件的处理线程，一个 `Class`类型的eventType成员表示事件的类型`EventType`。
Subscription，表示一个订阅对象，包含订阅源`Subscriber`，订阅源中的某一特定方法`SubscribMethod`，这个订阅的优先级`priopity`

了解了以上几个概念后就可以看`EventBus`中的几个重要成员了

// EventType -> List，事件到订阅对象之间的映射
private final Map, CopyOnWriteArrayList> subscriptionsByEventType;

// Subscriber -> List，订阅源到它订阅的的所有事件类型的映射 private final Map>> typesBySubscriber; // stickEvent事件，后面会看到 private final Map, Object> stickyEvents; // EventType -> List，事件到它的父事件列表的映射。即缓存一个类的所有父类 private static final Map, List>> eventTypesCache = new HashMap, List>>();

注册事件：Register

通过`EventBus.getDefault().register`方法可以向`EventBus`注册来订阅事件，`register`有很多种重载形式，但大都被标记为`Deprecated`了，所以还是不用为好，前面说了事件处理方法都是以*onEvent*开头，其实是可以通过 register方法修改的，但相应的方法被废弃了，还是不要用了，就用默认的*onEvent*，除下废弃的register方法，还有以下4 个**public**的`register`方法

public void register(Object subscriber) {
    register(subscriber, defaultMethodName, false, 0);
}

public void register(Object subscriber, int priority) { register(subscriber, defaultMethodName, false, priority); } public void registerSticky(Object subscriber) { register(subscriber, defaultMethodName, true, 0); } public void registerSticky(Object subscriber, int priority) { register(subscriber, defaultMethodName, true, priority); }

可以看到，这4个方法都调用了同一个方法：

private synchronized void register(Object subscriber, String methodName, boolean sticky, int priority) { List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriber.getClass(), methodName); for (SubscriberMethod subscriberMethod : subscriberMethods) { subscribe(subscriber, subscriberMethod, sticky, priority); } }

第一个参数就是订阅源，第二个参数就是用到指定方法名约定的，默认为*onEvent*开头，说默认是其实是可以通过参数修改的，但前面说了，方法已被废弃，最好不要用。第三个参数表示是否是*Sticky Event*，第4个参数是优先级，这两个后面再说。

在上面这个方法中，使用了一个叫`SubscriberMethodFinder`的类，通过其`findSubscriberMethods`方法找到了一个`SubscriberMethod`列表，前面知道了`SubscriberMethod`表示Subcriber内一个 onEvent\*方法，可以看出来`SubscriberMethodFinder`类的作用是在Subscriber中找到所有以 methodName（即默认的onEvent）开头的方法，每个找到的方法被表示为一个`SubscriberMethod`对象。

`SubscriberMethodFinder`就不再分析了，但有两点需要知道：

所有事件处理方法**必需是`public void`类型**的，并且只有一个参数表示*EventType*。
`findSubscriberMethods`不只查找*Subscriber*内的事件处理方法，**同时还会查到它的继承体系中的所有基类中的事件处理方法**。

找到*Subscriber*中的所有事件处理方法后，会对每个找到的方法（表示为`SubscriberMethod`对象）调用`subscribe`方法注册。`subscribe`方法干了三件事：

根据`SubscriberMethod`中的*EventType*类型将`Subscribtion`对象存放在`subscriptionsByEventType`中。建立*EventType*到*Subscription*的映射，每个事件可以有多个订阅者。
根据`Subscriber`将`EventType`存放在`typesBySubscriber`中，建立*Subscriber*到*EventType*的映射，每个Subscriber可以订阅多个事件。
如果是*Sticky*类型的订阅者，直接向它发送上个保存的事件（如果有的话）。

通过*Subscriber*到*EventType*的映射，我们就可以很方便地使一个Subscriber取消接收事件，通过*EventType*到*Sucscribtion*的映射，可以方便地将相应的事件发送到它的每一个订阅者。

Post事件

直接调用`EventBus.getDefault().post(Event)就可以发送事件，根据Event的类型就可以发送到相应事件的订阅者。

public void post(Object event) {
    PostingThreadState postingState = currentPostingThreadState.get();
    List