Android之EventBus框架源码解析下（源码解析）

转载请标明出处:【顾林海的博客】

个人开发的微信小程序，目前功能是书籍推荐，后续会完善一些新功能，希望大家多多支持！

---

前言

EventBus是典型的发布订阅模式，多个订阅者可以订阅某个事件，发布者通过发布事件使多个订阅者接受到并处理事件。在EventBus中，事件会被发布到总线中，然后根据订阅者查找到对应的事件，同时把事件传递给订阅者。通过这种形式，可以在Activity与Activity、Fragment与Fragment、Activity与Fragment之间进行通信，降低了通信的成本，但随着事件的增多，整个事件传递的复杂程度会提高，对于刚加入项目的队员来说难以阅读，因此在使用EventBus作为项目之间通信时，可以专门创建一个Event的module，专门用于各个模块或各个页面之间的事件传递，当然良好的注释是非常有必要的。

---

register方法流程概要

public void register(Object subscriber) {
    Class subscriberClass = subscriber.getClass();
    List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
    synchronized (this) {
        for (SubscriberMethod subscriberMethod : subscriberMethods) {
            subscribe(subscriber, subscriberMethod);
        }
    }
}

register是EventBus的订阅者的注册方法，传入订阅者的对象，通过该对象可以找到该订阅者订阅的方法。在方法中通过getClass方法获取订阅者的类型，拿到订阅者类型后通过它获取该订阅者订阅的所有方法，获取对应订阅者所有的订阅方法的操作是在SubscriberMethodFinder类执行的，这个在稍后会讲到，之后通过遍历订阅方法执行subscriber方法。

总结register做的工作：

1. 拿到订阅者类型。
2. 拿到订阅者类中定义所有订阅方法和对应的订阅事件
3. 遍历订阅者中订阅方法并调用subscribe方法。

在发送事件后，EventBus是如何找到订阅该事件的订阅者呢？从上面我们拿到了订阅者以及订阅者相关的订阅信息，接着要做的事情就是将订阅者和订阅事件进行绑定，subscriber方法做了就是这些事情，我们来看看subscriber方法的具体实现。

private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
    //获取订阅方法内的事件类型
    Class eventType = subscriberMethod.eventType;
    //将订阅者与订阅方法存储在Subscription对象中
    Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
    //根据事件类型获取Subscription对象集合
    CopyOnWriteArrayList subscriptions = subscriptionsByEventType.get(eventType);
    if (subscriptions == null) {
        subscriptions = new CopyOnWriteArrayList<>();
        //存储对应事件类型的Subscription集合
        subscriptionsByEventType.put(eventType, subscriptions);
    } else {
        //如果多次注册会报以下异常
        if (subscriptions.contains(newSubscription)) {
            throw new EventBusException("Subscriber " + subscriber.getClass() + " already registered to event "
                    + eventType);
        }
    }

    int size = subscriptions.size();
    for (int i = 0; i <= size; i++) {
        if (i == size || subscriberMethod.priority > subscriptions.get(i).subscriberMethod.priority) {
            //优先级插入
            subscriptions.add(i, newSubscription);
            break;
        }
    }

    //根据订阅者获取所有订阅方法
    List> subscribedEvents = typesBySubscriber.get(subscriber);
    if (subscribedEvents == null) {
        subscribedEvents = new ArrayList<>();
        typesBySubscriber.put(subscriber, subscribedEvents);
    }
    //添加到订阅者对应的事件集合中
    subscribedEvents.add(eventType);

    //是否为粘性事件
    if (subscriberMethod.sticky) {
        if (eventInheritance) {
            //遍历粘性事件集合（事件类包含自身或当前事件类的子类或子接口）并处理
            Set, Object>> entries = stickyEvents.entrySet();
            for (Map.Entry, Object> entry : entries) {
                Class candidateEventType = entry.getKey();
                if (eventType.isAssignableFrom(candidateEventType)) {
                    Object stickyEvent = entry.getValue();
                    checkPostStickyEventToSubscription(newSubscription, stickyEvent);
                }
            }
        } else {
            //直接获取事件类对应的粘性事件并处理
            Object stickyEvent = stickyEvents.get(eventType);
            checkPostStickyEventToSubscription(newSubscription, stickyEvent);
        }
    }
}


private void checkPostStickyEventToSubscription(Subscription newSubscription, Object stickyEvent) {
    if (stickyEvent != null) {
        //进行事件处理
        postToSubscription(newSubscription, stickyEvent, isMainThread());
    }
}

subscribe方法传入的是订阅者和订阅方法，这个方法可以理解为做一些存储性的工作，subscriptionByEventType集合以事件为键，Subscription集合为值，Subscription存储着订阅者以及对应的订阅方法，我们可以通过事件类型从subscriptionByEventType集合中拿到所有该事件类型对应的订阅信息，处理subscriptionByEventType集合的时机是在后面执行post方法，事件发出后，所有注册过该事件的方法都需要执行，这时就需要subscriptionByEventType来获取对应事件的所有订阅信息。
值得注意的是EventBus在某个订阅者中是不能多次注册的，否则会报订阅类已注册的错误，事件对应的订阅信息添加会通过优先级添加。
订阅信息存储完毕后，通过typesBySubscriber集合以订阅者的类型为键，以该订阅者中的所有订阅事件为值，通过订阅者类型可以从typesBySubscriber集合中获取该订阅者的所有事件类型。
之后会判断当前的订阅方法订阅的事件是否为粘性事件，如果是粘性事件会执行相关的粘性事件，通过postToSubscription方法处理相关逻辑，后面会讲到。

总结subscribe做的工作：

1. 相关事件(key)与对应的所有订阅信息（value:订阅者和订阅方法）的一个映射，通过subscriptionByEventType集合存储。
2. 订阅者(key)与对应的所有事件(value)的一个映射，通过typesBySubscriber集合存储。
3. 对粘性事件的处理。

---

EventBus的线程模式

subscribe方法最后是对粘性事件进行了处理，在讲解粘性事件之前，我们先来看看EventBus的线程模式。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Subscribe {
    //线程模式
    ThreadMode threadMode() default ThreadMode.POSTING;

    //是否粘性事件
    boolean sticky() default false;

    //优先级
    int priority() default 0;
}

Subscribe是一个注解类，我们在定义订阅某个方法时会通过它来修饰该方法是EventBus中的事件方法，其中ThreadMode是一个枚举类，它被定义为线程模式，也就是事件处理在哪个线程是由它来指定，sticky方法返回boolean类型，true代表该事件为粘性事件，false代表该事件不是粘性事件，所谓的粘性事件是指当Event发送出去后，如果订阅者没有注册，之后当订阅者注册时，该事件还是会接收到。priority方法的返回的值是int类型，代表事件处理的优先级，默认为0。

public enum ThreadMode {
    POSTING,
    MAIN,
    MAIN_ORDERED,
    BACKGROUND,
    ASYNC
}

在ThreadMode线程模式的枚举类中定义了5中模式。
POSTING是默认的线程模式，发送事件和事件处理是在同一线程中执行，效率是高，因为在同一线程执行，避免了线程间的切换，当然使用POSTING线程模式时需要注意在主线程中的情况，因为主线程是不允许做耗时操作的，所以使用该模式必须要避免耗时操作，以免造成线程阻塞。
使用MAIN线程模式时，事件处理会在主线程（UI线程）中执行，如果发布事件所在的线程是主线程，事件会立即执行，否则事件会被放在队列中等待处理。
使用MAIN_ORDERED线程模式时，事件处理会在主线程中执行，它与MAIN不同之处在于，处于MAIN_ORDERED线程模式的事件会被放在队列中等待处理，而处于MAIN线程模式时，会立即执行。
使用BACKGROUND线程模式时，如果事件是在主线程中发布的，事件会被放在工作线程中的队列中，等待处理，如果事件不在主线程中发布，说明事件的发布和事件的处理是在同一线程中（工作线程）。
使用ASYNC线程模式时，事件发送和处理都与UI线程无关，并且发送事件是异步的，通过线程池来管理发送事件和处理事件的线程。
值得注意的是，如果发送事件在子线程，处理事件需要在UI线程中进行，这时就需要通过Handler来实现，后面会讲到。

EventBus的粘性事件

理解了ThreadMode线程模式后，我们继续对register流程最后粘性事件处理的讲解，在前面register方法流程概要中，subscribe方法做了事件的存储工作并对粘性事件进行了处理。为了方便查看，这里再次贴出subscribe方法中对粘性事件处理的代码。

private final Map, Object> stickyEvents;
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
    subscriptionsByEventType集合处理
    ...
    typesBySubscriber集合处理
    ...
    
    //是否为粘性事件
    if (subscriberMethod.sticky) {
        if (eventInheritance) {
            //遍历粘性事件集合（事件类包含自身或当前事件类的子类或子接口）并处理
            Set, Object>> entries = stickyEvents.entrySet();
            for (Map.Entry, Object> entry : entries) {
                Class candidateEventType = entry.getKey();
                if (eventType.isAssignableFrom(candidateEventType)) {
                    Object stickyEvent = entry.getValue();
                    checkPostStickyEventToSubscription(newSubscription, stickyEvent);
                }
            }
        } else {
            //直接获取事件类对应的粘性事件并处理
            Object stickyEvent = stickyEvents.get(eventType);
            checkPostStickyEventToSubscription(newSubscription, stickyEvent);
        }
    }
}

private void checkPostStickyEventToSubscription(Subscription newSubscription, Object stickyEvent) {
    if (stickyEvent != null) {
        //进行事件处理
        postToSubscription(newSubscription, stickyEvent, isMainThread());
    }
}

在上面注册时，需要知道发送的事件是否为粘性事件，如果是粘性事件，需要检查该粘性事件之前是否发送过，如果发送过，需要立即处理对应的粘性事件。
eventInheritance是boolean类型，在获取EventBus实例时，eventInheritance值被初始化为true，说明我们在对事件进行处理时，需要对事件类的子类或接口也进行处理，上面代码中是对stickyEvents集合进行遍历，查看当前的粘性事件与集合中的粘性事件是否存在是子类或接口的关系，如果是就对事件进行处理。
stickyEvents是粘性事件的集合，并且该集合使用了ConcurrentHashMap，ConcurrentHashMap在线程安全的基础上提供了更好的写并发能力。eventInheritance如果为false，就是对当前的粘性事件进行处理，不管eventInheritance为何值，最后都会调用checkPostStickyEventToSubscription方法。

private void checkPostStickyEventToSubscription(Subscription newSubscription, Object stickyEvent) {
    if (stickyEvent != null) {
        //进行事件处理
        postToSubscription(newSubscription, stickyEvent, isMainThread());
    }
}

checkPostStickyEventToSubscription方法做的事情是对粘性事件进行了判断，如果粘性事件存在，调用postToSubscription方法，根据subscription（订阅者和订阅方法信息）和事件就可以执行事件的处理。

发送粘性事件是通过EventBus的postSticky方法来发送的，源码如下。

public void postSticky(Object event) {
    synchronized (stickyEvents) {
        stickyEvents.put(event.getClass(), event);
    }
    post(event);
}

postSticky方法中会通过同步代码块，将粘性事件存储在stickyEvents集合中，将粘性事件存储完毕，还会执行post方法，也就是将事件发送出去，为什么这么做，这是因为粘性事件处理的情况有两种：一是如果粘性事件先被注册，之后通过postSticky发送粘性事件，由于该粘性事件已经存在所以需要进行处理；二是粘性事件先发送，之后订阅者去订阅该粘性事件，这时需要去处理粘性事件。

---

事件发送与处理

在平时发送事件是通过EventBus的post方法来发送的，只不过postSticky方法比post方法多做了一步，就是存储粘性事件，post方法代码如下：

private final ThreadLocal currentPostingThreadState = new ThreadLocal() {
    @Override
    protected PostingThreadState initialValue() {
        return new PostingThreadState();
    }
};

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