Android每周一轮子：EventBus

前言

开篇要说声sorry，限于各种原因，Okhttp的下篇和OKIO要delay 了，本周先来一个简单一些的。

EventBus 是一个基于观察者模式的事件发布/订阅框架，开发者可以通过极少的代码去实现多个模块之间的通信，而不需要以层层传递接口的形式去单独构建通信桥梁。从而降低因多重回调导致的模块间强耦合，同时避免产生大量内部类。其可以很好的应用于Activity之间，Fragment之间，后台线程之间的通信，避免使用intent或者handler所带来的复杂度。其缺点则是可能会造成接口的膨胀。特别是当程序要求大量形式各异的通知，而没有做出良好的抽象时，代码中会包含大量的接口，接口数量的增长又会带来命名、注释等等一大堆问题。本质上说观察者要求从零开始实现事件的产生、分发与处理过程，这就要求参与者必须对整个通知过程有着良好的理解。当程序代码适量时，这是一个合理的要求，然而当程序太大时，这将成为一种负担。

EventBus基于观察者模式的Android事件分发总线。

EventBus基本使用

1.定义消息事件MessageEvent，也就是创建事件类型

public class MessageEvent {
    public final String message;
    public MessageEvent(String message) {
        this.message = message;
    }
}

2.注册观察者并订阅事件

选择要订阅该事件的订阅者（subscriber），Activity即在onCreate()加入，调用EventBus的register方法，注册。

 EventBus.getDefault().register(this);

在不需要接收事件发生时可以

EventBus.getDefault().unregister(this);

在订阅者里需要用注解关键字 @Subscribe来告诉EventBus使用什么方法处理event。

@Subscribe
public void onMessageEvent(MessageEvent event) {
    Toast.makeText(this, event.message, Toast.LENGTH_SHORT).show();
}

注意方法只能被public修饰，在EventBus3.0之后该方法名字就可以自由的取了，之前要求只能是onEvent().

3.发送事件

通过EventBus的post方法，发出我们要传递的事件。

EventBus.getDefault().post(new MessageEvent("HelloEveryone"));

这样选择的Activity就会接收到该事件，并且触发onMessageEvent方法。

EventBus源码解析

了解了对于EventBus的基础使用，解析来，我们针对其基础使用的调用流程，来了解EventBus的实现流程和源码细节。

注册观察者

EventBus.getDefault().register(this);

getDefault（）

EventBus.getDefault()是一个单例，实现如下：

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

保证了App单个进程中只会有一个EventBus实例。

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

register方法中，首先获得订阅实例的类，然后调用SubscriberMethodFinder实例的findSubscriberMethods方法来找到该类中订阅的相关方法，然后对这些方法调用订阅方法。注册的过程涉及到两个问题，一个是如何查找注册方法？另一个是如何将这些方法进行存储，方便后面的调用？

SubscriberMethodFinder是如何从实例中查找到相关的注册方法的呢？

List findSubscriberMethods(Class subscriberClass) {
    //根据类信息丛缓存中查找订阅方法
    List subscriberMethods = METHOD_CACHE.get(subscriberClass);
    if (subscriberMethods != null) {
        return subscriberMethods;
    }
    
    //查找注册方法    
    if (ignoreGeneratedIndex) {
        subscriberMethods = findUsingReflection(subscriberClass);
    } else {
        subscriberMethods = findUsingInfo(subscriberClass);
    }
    
    //将得到的订阅方法加入到缓存中
    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;
    }
}

首先从缓存的方法中，通过Class作为Key进行查找，如何查找内容为空，则会调用findUsingReflection或者findUsingInfo来从相关类中查找，得到注册的方法列表之后，将其添加到缓存之中。

缓存的数据结构如下：

Map, List> METHOD_CACHE = new ConcurrentHashMap<>();

订阅方法

private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
     //获取订阅方法要监听的事件类型
    Class eventType = subscriberMethod.eventType;
    
    Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
    
    //根据事件类型查找相应的订阅者
    CopyOnWriteArrayList subscriptions = subscriptionsByEventType.get(eventType);
    
    //如果不存在该事件类型，则创建，如果已经包含该订阅者，抛出异常
    if (subscriptions == null) {
        subscriptions = new CopyOnWriteArrayList<>();
        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);
        }
    }
}

subscribe方法的执行流程是先根据事件类型，判断该注册者是否已经进行过注册，如果未注册将其中的方法进行保存，以事件类型为键保存一份，然后以注册者实例为键保存一份。

发送事件

对于事件的发送，调用的是post函数

post(Object event)

public void post(Object event) {
    //获取当前线程的Event队列，并将其添加到队列中
    PostingThreadState postingState = currentPostingThreadState.get();
    List