EventBus源码解析

前言：在现在的android项目开发小伙伴们越来越多的在使用EventBus了作为事件的同步了，EventBus是针对Android优化的发布-订阅事件总线，简化了Android组件间的通信，以其简单易懂、优雅、开销小等优点而备受欢迎。所以在之前已经整理了EventBus与Otto使用和区别之后，我最近再次梳理了EventBus的源码原理。

友情提示：该篇文章主要是介绍梳理EventBus的源码原理，所以如果只是想要了解EventBus的使用方法，请查看网上其他的相关资料。

EventBus简介

EventBus属于观察者模式：观察者模式是设计模式中的一种。它是为了定义对象间的一种一对多的依赖关系，即当一个对象的状态发生改变时，所有依赖于它的对象都得到通知并被自动更新。

1.EventBus的三要素：

• Event：事件，可以是任意类型的对象。
• Subscriber：事件订阅者，在EventBus3.0之前，消息处理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，他们分别代表四种线程模型。在EventBus3.0之后，事件处理的方法可以随便取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTING），四种线程模型下面会讲到。
• Publisher：事件发布者，可以在任意线程任意位置发送事件，直接调用EventBus的post(Object)方法。可以自己实例化EventBus对象，但一般使用EventBus.getDefault()就好了，根据post函数参数的类型，会自动调用订阅相应类型事件的函数。

2. EventBus的四种ThreadMode（线程模型）：

• POSTING（默认）：如果使用事件处理函数指定了线程模型为POSTING，那么该事件在哪个线程发布出来的，事件处理函数就会在这个线程中运行，也就是说发布事件和接收事件在同一个线程。在线程模型为POSTING的事件处理函数中尽量避免执行耗时操作，因为它会阻塞事件的传递，甚至有可能会引起ANR。

• MAIN:事件的处理会在UI线程中执行。事件处理时间不能太长，长了会ANR的。

• BACKGROUND：如果事件是在UI线程中发布出来的，那么该事件处理函数就会在新的线程中运行，如果事件本来就是子线程中发布出来的，那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。

• ASYNC：无论事件在哪个线程发布，该事件处理函数都会在新建的子线程中执行，同样，此事件处理函数中禁止进行UI更新操作。

EventBus使用

1. 自定义一个事件类：

   public class MessageEvent {
   }

2. 在需要订阅事件的地方注册事件：

   EventBus.getDefault().register(this);

3. 发送事件：

   EventBus.getDefault().post(messageEvent);

4. 处理事件：需要添加一个注解@Subscribe，并且要指定线程模型，如果没有添加，那就是默认为POSTING。

   @Subscribe(threadMode = ThreadMode.MAIN)
   public void Hhhh(MessageEvent messageEvent) {
   ...
   }

5. 取消事件订阅：

   EventBus.getDefault().unregister(this);

EventBus源码解析

1、注册源码解析

在创建EventBus实例的时候，一种方式是按照我们上面的形式，通过EventBus的静态方法getDefault来获取一个实例。getDefault本身会调用其内部的构造方法，通过传入一个默认的EventBusBuilder来创建EventBus。此外，我们还可以直接通过EventBus的builder()方法获取一个EventBusBuilder的实例，然后通过该构建者模式来个性化地定制自己的EventBus。

EventBus.getDefault()获取对象，下面看该方法的源码：

// 静态的单例实例
static volatile EventBus defaultInstance;

// 默认的构建者
private static final EventBusBuilder DEFAULT_BUILDER = new EventBusBuilder();

public EventBus() {
    this(DEFAULT_BUILDER);
}

// 调用getDefault的时候，最终会调用该方法，使用DEFAULT_BUILDER创建一个实例
EventBus(EventBusBuilder builder) {
    // ...
}

// 也可以使用下面的方法获取一个构建者，然后使用它来个性化定制EventBus
public static EventBusBuilder builder() {
    return new EventBusBuilder();
}

/** Convenience singleton for apps using a process-wide EventBus instance. */
public static EventBus getDefault() {
    if (defaultInstance == null) {
        synchronized (EventBus.class) {
            if (defaultInstance == null) {
                defaultInstance = new EventBus();
            }
        }
    }
    return defaultInstance;
}

分析：使用单例模式， 使用了双重判断的方式，防止并发的问题，还能极大的提高效率。

register(this)注册源码解析，看下面源码：

public void register(Object subscriber) {
    //首先获取订阅者的类对象
    Class<?> subscriberClass = subscriber.getClass();
    //用 subscriberMethodFinder 提供的方法，找到在 subscriber 这个类里面订阅的内容。
    List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
    synchronized (this) {
        for (SubscriberMethod subscriberMethod : subscriberMethods) {
            subscribe(subscriber, subscriberMethod);
        }
    }
}

这里的SubscriberMethod封装了订阅方法（使用@Subscribe注解的方法）类型的信息，它的定义如下所示。从下面可以的代码中我们可以看出，实际上该类就是通过几个字段来存储@Subscribe注解中指定的类型信息，以及一个方法的类型变量。

public class SubscriberMethod {
    final Method method;
    final ThreadMode threadMode;
    final Class<?> eventType;
    final int priority;
    final boolean sticky;

    // ...
}

接下来看findSubscriberMethods(subscriberClass)里面的源码：

List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {
    //首先从缓存中读取
    List<SubscriberMethod> subscriberMethods = METHOD_CACHE.get(subscriberClass);
    if (subscriberMethods != null) {
        return subscriberMethods;
    }
    //是否忽略注解器生成的MyEventBusIndex类
    if (ignoreGeneratedIndex) {
        //利用反射来获取订阅类中的订阅方法信息
        subscriberMethods = findUsingReflection(subscriberClass);
    } else {
        //从注解器生成的MyEventBusIndex类中获得订阅类的订阅方法信息
        subscriberMethods = findUsingInfo(subscriberClass);
    }

    //在获得subscriberMethods以后，如果订阅者中不存在@Subscribe注解并且为public的订阅方法，则会抛出异常。
    if (subscriberMethods.isEmpty()) {
        throw new EventBusException("Subscriber " + subscriberClass
                + " and its super classes have no public methods with the @Subscribe annotation");
    } else {
        //保存进缓存
        METHOD_CACHE.put(subscriberClass, subscriberMethods);
        return subscriberMethods;
    }
}
//METHOD_CACHE，是一个map集合，键是class类型
Map<Class<?>, List<SubscriberMethod>> METHOD_CACHE = new ConcurrentHashMap<>();

上面源码分析：首先从缓存中查找，如果找到了就立马返回。如果缓存中没有的话，则根据 ignoreGeneratedIndex 选择如何查找订阅方法，ignoreGeneratedIndex属性表示是否忽略注解器生成的MyEventBusIndex。最后，找到订阅方法后，放入缓存，以免下次继续查找。ignoreGeneratedIndex 默认就是false，可以通过EventBusBuilder来设置它的值。我们在项目中经常通过EventBus单例模式来获取默认的EventBus对象，也就是ignoreGeneratedIndex为false的情况，这种情况调用了findUsingInfo方法。

接下来看findUsingInfo(subscriberClass)源码：

private List<SubscriberMethod> findUsingInfo(Class<?> subscriberClass) {
    FindState findState = prepareFindState();
    findState.initForSubscriber(subscriberClass);
    while (findState.clazz != null) {
        //获取订阅者信息，没有配置MyEventBusIndex返回null
        findState.subscriberInfo = getSubscriberInfo(findState);
        if (findState.subscriberInfo != null) {
            SubscriberMethod[] array = findState.subscriberInfo.getSubscriberMethods();
            for (SubscriberMethod subscriberMethod :