EventBus 3.0进阶：源码及其设计模式 完全解析

前言

在上一篇文章：EventBus 3.0初探: 入门使用及其使用 完全解析中，笔者为大家介绍了EventBus 3.0的用法，相信大家对其的使用也比较熟悉了。我们学习使用一个开源库，不但要知道其怎么使用，也要对其的实现原理有一定的熟悉，学习并借鉴它优秀的实现思想，这样对我们以后的开发又或者是自己的开源项目都有很大的意义。那么今天的文章，就是EventBus 3.0的进阶，剖析它的实现原理以及对其使用的设计模式进行解析。

本文导读

由于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;
}

可以看出，这里使用了单例模式，而且是双重校验的单例，确保在不同线程中也只存在一个EvenBus的实例。

单例模式：一个类有且仅有一个实例，并且自行实例化向整个系统提供。

然而，我们看看EventBus的构造方法：

/** 
  * Creates a new EventBus instance; each instance is a separate scope in which events are delivered. To use a 
  * central bus, consider {@link #getDefault()}.
  */
public EventBus() {
    this(DEFAULT_BUILDER);
}

它的构造方法并没有设置成私有的！这是为什么？从注解我们看到，每一个EventBus都是独立地、处理它们自己的事件，因此可以存在多个EventBus，而通过getDefault()方法获取的实例，则是它已经帮我们构建好的EventBus，是单例，无论在什么时候通过这个方法获取的实例都是同一个实例。除此之外，我们可以通过建造者帮我们建造具有不同功能的EventBus。
我们继续看上面的this(DEFAULT_BUILDER)调用了另一个构造方法：

  EventBus(EventBusBuilder builder) {
    subscriptionsByEventType = new HashMap<>();
    typesBySubscriber = new HashMap<>();
    stickyEvents = new ConcurrentHashMap<>();
    mainThreadPoster = new HandlerPoster(this, Looper.getMainLooper(), 10);
    backgroundPoster = new BackgroundPoster(this);
    asyncPoster = new AsyncPoster(this);
    //一系列的builder赋值
}

可以看出，对成员变量进行了一系列的初始化，那么我们来看看几个关键的成员变量：

private final Map, CopyOnWriteArrayList> subscriptionsByEventType;
private final Map>> typesBySubscriber;
private final Map, Object> stickyEvents;

subscriptionsByEventType:以event(即事件类)为key，以订阅列表(Subscription)为value，事件发送之后，在这里寻找订阅者,而Subscription又是一个CopyOnWriteArrayList，这是一个线程安全的容器。你们看会好奇，Subscription到底是什么，其实看下去就会了解的，现在先提前说下：Subscription是一个封装类，封装了订阅者、订阅方法这两个类。
typesBySubscriber：以订阅者类为key，以event事件类为value，在进行register或unregister操作的时候，会操作这个map。
stickyEvents:保存的是粘性事件，粘性事件上一篇文章有详细描述。
回到EventBus的构造方法，接下来实例化了三个Poster，分别是mainThreadPoster、backgroundPoster、asyncPoster等，这三个Poster是用来处理粘性事件的，我们下面会展开讲述。接着，就是对builder的一系列赋值了，这里使用了建造者模式。

建造者模式：将一个复杂对象的构造与它的表示分离，使同样的构建过程可以创建不同的表示。

这里的建造者是EventBusBuilder，它的一系列方法用于配置EventBus的属性，使用getDefault()方法获取的实例，会有着默认的配置，上面说过，EventBus的构造方法是公有的，所以我们可以通过给EventBusBuilder设置不同的属性，进而获取有着不同功能的EventBus。那么我们来列举几个常用的属性加以讲解：

//默认地，EventBus会考虑事件的超类，即事件如果继承自超类，那么该超类也会作为事件发送给订阅者。
//如果设置为false，则EventBus只会考虑事件类本身。
boolean eventInheritance = true;
public EventBusBuilder eventInheritance(boolean eventInheritance) {
    this.eventInheritance = eventInheritance;
    return this;
}

//当订阅方法是以onEvent开头的时候，可以调用该方法来跳过方法名字的验证，订阅这类会保存在List中
List> skipMethodVerificationForClasses;
public EventBusBuilder skipMethodVerificationFor(Class clazz) {
    if (skipMethodVerificationForClasses == null) {
        skipMethodVerificationForClasses = new ArrayList<>();
    }
    skipMethodVerificationForClasses.add(clazz);
    return this;
}

//更多的属性配置请参考源码，均有注释
//...

那么，我们通过建造者模式来手动创建一个EventBus，而不是使用getDefault()方法：

EventBus eventBus = EventBus.builder()
        .eventInheritance(false)
        .sendNoSubscriberEvent(true)
        .skipMethodVerificationFor(MainActivity.class)
        .build();

注册

好了，以上说了一大推关于EventBus的创建，接下来，我们继续讲它的注册过程。要想使一个类成为订阅者，那么这个类必须有一个订阅方法，以@Subscribe注解标记的方法，接着调用register()方法来进行注册。那么我们直接来看EventBus#register()。

register

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

先获取了订阅者类的class，接着交给SubscriberMethodFinder.findSubscriberMethods()处理，返回结果保存在List中，由此可推测通过上面的方法把订阅方法找出来了，并保存在集合中，那么我们直接看这个方法，SubscriberMethodFinder#findSubscriberMethods()。

findSubscriberMethods

List findSubscriberMethods(Class subscriberClass) {
    //首先从缓存中取出subscriberMethodss，如果有则直接返回该已取得的方法
    List subscriberMethods = METHOD_CACHE.get(subscriberClass);
    if (subscriberMethods != null) {
        return subscriberMethods;
    }
    //从EventBusBuilder可知，ignoreGenerateIndex一般为false
    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 {
        //将获取的subscriberMeyhods放入缓存中
        METHOD_CACHE.put(subscriberClass, subscriberMethods);
        return subscriberMethods;
    }
}

从上面的逻辑可以知道，一般会调用findUsingInfo方法，我们接着看SubscriberMethodFinder#findUsingInfo方法：

findUsingInfo

private List findUsingInfo(Class subscriberClass) {
    //准备一个FindState，该FindState保存了订阅者类的信息
    FindState findState = prepareFindState();
    //对FindState初始化
    findState.initForSubscriber(subscriberClass);
    while (findState.clazz != null) {
        //获得订阅者的信息，一开始会返回null
        findState.subscriberInfo = getSubscriberInfo(findState);
        if (findState.subscriberInfo != null) {
            SubscriberMethod[] array = findState.subscriberInfo.getSubscriberMethods();
            for (SubscriberMethod subscriberMethod : array) {
                if (findState.checkAdd(subscriberMethod.method, subscriberMethod.eventType)) {
                    findState.subscriberMethods.add(subscriberMethod);
                }
            }
        } else {
            //1 、到了这里
            findUsingReflectionInSingleClass(findState);
        }
        //移动到父类继续查找
        findState.moveToSuperclass();
    }
    return getMethodsAndRelease(findState);
}

上面用到了FindState这个内部类来保存订阅者类的信息，我们看看它的内部结构：

FindState

static class FindState {
    //订阅方法的列表
    final List subscriberMethods = new ArrayList<>();
    //以event为key，以method为value
    final Map anyMethodByEventType = new HashMap<>();
    //以method的名字生成一个method为key，以订阅者类为value
    final Map subscriberClassByMethodKey = new HashMap<>();
    final StringBuilder methodKeyBuilder = new StringBuilder(128);

    Class subscriberClass;
    Class clazz;
    boolean skipSuperClasses;
    SubscriberInfo subscriberInfo;

    //对FindState初始化
    void initForSubscriber(Class subscriberClass) {
        this.subscriberClass = clazz = subscriberClass;
        skipSuperClasses = false;
        subscriberInfo = null;
    }

    //省略...
}

可以看出，该内部类保存了订阅者及其订阅方法的信息，用Map一一对应进行保存，接着利用initForSubscriber进行初始化，这里subscriberInfo初始化为null，因此在SubscriberMethodFinder#findUsingInfo里面，会直接调用到①号代码，即调用SubscriberMethodFinder#findUsingReflectionInSingleClass，这个方法非常重要！！！在这个方法内部，利用反射的方式，对订阅者类进行扫描，找出订阅方法，并用上面的Map进行保存，我们来看这个方法。

findUsingReflectionInSingleClass

  private void findUsingReflectionInSingleClass(FindState findState) {
    Method[] methods;
    try {
        // This is faster than getMethods, especially when subscribers are fat classes like Activities
        methods = findState.clazz.getDeclaredMethods();
    } catch (Throwable th) {
        // Workaround for java.lang.NoClassDefFoundError, see https://github.com/greenrobot/EventBus/issues/149
        methods = findState.clazz.getMethods();
        findState.skipSuperClasses = true;
    }
    for (Method method : methods) {
        //获取方法的修饰符
        int modifiers = method.getModifiers();
        if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {
            //获取方法的参数类型
            Class[] parameterTypes = method.getParameterTypes();
            //如果参数个数为一个，则继续
            if (parameterTypes.length == 1) {
                //获取该方法的@Subscribe注解
                Subscribe subscribeAnnotation = method.getAnnotation(Subscribe.class);
                if (subscribeAnnotation != null) {
                    //参数类型 即为 事件类型
                    Class eventType = parameterTypes[0];
                    // 2 、调用checkAdd方法
                    if (findState.checkAdd(method, eventType)) {
                        //从注解中提取threadMode
                        ThreadMode threadMode = subscribeAnnotation.threadMode();
                        //新建一个SubscriberMethod对象，并添加到findState的subscriberMethods这个集合内
                        findState.subscriberMethods.add(new SubscriberMethod(method, eventType, threadMode,
                                subscribeAnnotation.priority(), subscribeAnnotation.sticky()));
                    }
                }
            //如果开启了严格验证，同时当前方法又有@Subscribe注解，对不符合要求的方法会抛出异常
            } else if (strictMethodVerification && method.isAnnotationPresent(Subscribe.class)) {
                String methodName = method.getDeclaringClass().getName() + "." + method.getName();
                throw new EventBusException("@Subscribe method " + methodName +
                        "must have exactly 1 parameter but has " + parameterTypes.length);
            }
        } else if (strictMethodVerification && method.isAnnotationPresent(Subscribe.class)) {
            String methodName = method.getDeclaringClass().getName() + "." + method.getName();
            throw new EventBusException(methodName +
                    " is a illegal @Subscribe method: must be public, non-static, and non-abstract");
        }
    }
}

虽然该方法比较长，但是逻辑非常清晰，逐一判断订阅者类是否存在订阅方法，如果符合要求，并且②号代码调用FindState#checkAdd方法返回true的时候,才会把方法保存在findState的subscriberMethods内。而SubscriberMethod则是用于保存订阅方法的一个类。那么我们来看看FindState#checkAdd做了什么工作。

checkAdd

boolean checkAdd(Method method, Class eventType) {
    // 2 level check: 1st level with event type only (fast), 2nd level with complete signature when required.
    // Usually a subscriber doesn't have methods listening to the same event type.
    Object existing = anyMethodByEventType.put(eventType, method);
    if (existing == null) {
        return true;
    } else {
        if (existing instanceof Method) {
            if (!checkAddWithMethodSignature((Method) existing, eventType)) {
                // Paranoia check
                throw new IllegalStateException();
            }
            // Put any non-Method object to "consume" the existing Method
            anyMethodByEventType.put(eventType, this);
        }
        return checkAddWithMethodSignature(method, eventType);
    }
}

从注释可知，这里包含两重检验，第一层检验是判断eventType的类型，而第二次检验是判断方法的完整签名。首先通过anyMethodByEventType.put(eventType, method) 将eventType以及method放进anyMethodByEventType这个Map中(上面提到),同时该put方法会返回同一个key的上一个value值，所以如果之前没有别的方法订阅了该事件，那么existing应该为null，可以直接返回true；否则为某一个订阅方法的实例，要进行下一步的判断。接着往下走，会调用checkAddWithMethodSignature()方法。

checkAddWithMethodSignature

private boolean checkAddWithMethodSignature(Method method, Class eventType) {
    methodKeyBuilder.setLength(0);
    methodKeyBuilder.append(method.getName());
    methodKeyBuilder.append('>').append(eventType.getName());

    //methodKey由方法名与事件名组成
    String methodKey = methodKeyBuilder.toString();
    //获取当前方法所在的类的类名
    Class methodClass = method.getDeclaringClass();
    //给subscriberClassByMethodKey赋值，并返回上一个相同key的 类名
    Class methodClassOld = subscriberClassByMethodKey.put(methodKey, methodClass);
    if (methodClassOld == null || methodClassOld.isAssignableFrom(methodClass)) {
        // Only add if not already found in a sub class
        return true;
    } else {
        // Revert the put, old class is further down the class hierarchy
        subscriberClassByMethodKey.put(methodKey, methodClassOld);
        return false;
    }
}

从上面的代码看出，该方法首先获取了当前方法的methodKey、methodClass等，并赋值给subscriberClassByMethodKey，如果方法签名相同，那么返回旧值给methodClassOld，接着是一个if判断，判断methodClassOld是否为空，由于第一次调用该方法的时候methodClassOld肯定是null，此时就可以直接返回true了。但是，后面还有一个判断即methodClassOld.isAssignableFrom(methodClass)，这个的意思是：methodClassOld是否是methodClass的父类或者同一个类。如果这两个条件都不满足，则会返回false，那么当前方法就不会添加为订阅方法了。

那么，说了一大堆关于checkAdd和checkAddWithMethodSignature方法的源码，那么这两个方法到底有什么作用呢？从这两个方法的逻辑来看，第一层判断根据eventType来判断是否有多个方法订阅该事件，而第二层判断根据完整的方法签名(包括方法名字以及参数名字)来判断。下面是笔者的理解：

第一种情况：比如一个类有多个订阅方法，方法名不同，但它们的参数类型都是相同的(虽然一般不这样写，但不排除这样的可能)，那么遍历这些方法的时候，会多次调用到checkAdd方法，由于existing不为null，那么会进而调用checkAddWithMethodSignature方法，但是由于每个方法的名字都不同，因此methodClassOld会一直为null，因此都会返回true。也就是说，允许一个类有多个参数相同的订阅方法。

第二种情况：类B继承自类A，而每个类都是有相同订阅方法，换句话说，类B的订阅方法继承并重写自类A，它们都有着一样的方法签名。方法的遍历会从子类开始，即B类，在checkAddWithMethodSignature方法中，methodClassOld为null，那么B类的订阅方法会被添加到列表中。接着，向上找到类A的订阅方法，由于methodClassOld不为null而且显然类B不是类A的父类，methodClassOld.isAssignableFrom(methodClass)也会返回false，那么会返回false。也就是说，子类继承并重写了父类的订阅方法，那么只会把子类的订阅方法添加到订阅者列表，父类的方法会忽略。

让我们回到findUsingReflectionInSingleClass方法，当遍历完当前类的所有方法后，会回到findUsingInfo方法，接着会执行最后一行代码，即return getMethodsAndRelease(findState);那么我们继续看SubscriberMethodFinder#getMethodsAndRelease方法。

getMethodsAndRelease

private List getMethodsAndRelease(FindState findState) {
    //从findState获取subscriberMethods，放进新的ArrayList
    List subscriberMethods = new ArrayList<>(findState.subscriberMethods);
    //把findState回收
    findState.recycle();
    synchronized (FIND_STATE_POOL) {
        for (int i = 0; i < POOL_SIZE; i++) {
            if (FIND_STATE_POOL[i] == null) {
                FIND_STATE_POOL[i] = findState;
                break;
            }
        }
    }
    return subscriberMethods;
}

通过该方法，把subscriberMethods不断逐层返回，直到返回EventBus#register()方法，最后开始遍历每一个订阅方法，并调用subscribe(subscriber, subscriberMethod)方法，那么，我们继续来看EventBus#subscribe方法。

subscribe

在该方法内，主要是实现订阅方法与事件直接的关联，即注册，即放进我们上面提到关键的几个Map中：subscriptionsByEventType、typesBySubscriber、stickyEvents。

private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
    Class eventType = subscriberMethod.eventType;
    //将subscriber和subscriberMethod封装成 Subscription
    Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
    //根据事件类型获取特定的 Subscription
    CopyOnWriteArrayList subscriptions = subscriptionsByEventType.get(eventType);
    //如果为null，说明该subscriber尚未注册该事件
    if (subscriptions == null) {
        subscriptions = new CopyOnWriteArrayList<>();
        subscriptionsByEventType.put(eventType, subscriptions);
    } else {
        //如果不为null，并且包含了这个subscription 那么说明该subscriber已经注册了该事件，抛出异常
        if (subscriptions.contains(newSubscription)) {
            throw new EventBusException("Subscriber " + subscriber.getClass() + " already registered to event "
                    + eventType);
        }
    }

    //根据优先级来设置放进subscriptions的位置，优先级高的会先被通知
    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;
        }
    }

    //根据subscriber(订阅者)来获取它的所有订阅事件
    List> subscribedEvents = typesBySubscriber.get(subscriber);
    if (subscribedEvents == null) {
        subscribedEvents = new ArrayList<>();
        //把订阅者、事件放进typesBySubscriber这个Map中
        typesBySubscriber.put(subscriber, subscribedEvents);
    }
    subscribedEvents.add(eventType);

    //下面是对粘性事件的处理
    if (subscriberMethod.sticky) {
        //从EventBusBuilder可知，eventInheritance默认为true.
        if (eventInheritance) {
            // Existing sticky events of all subclasses of eventType have to be considered.
            // Note: Iterating over all events may be inefficient with lots of sticky events,
            // thus data structure should be changed to allow a more efficient lookup
            // (e.g. an additional map storing sub classes of super classes: Class -> List).
            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 {
            //根据eventType，从stickyEvents列表中获取特定的事件
            Object stickyEvent = stickyEvents.get(eventType);
            //分发事件
            checkPostStickyEventToSubscription(newSubscription, stickyEvent);
        }
    }
}

到目前为止，注册流程基本分析完毕，而关于最后的粘性事件的处理，这里暂时不说，下面会详细进行讲述。可以看出，整个注册流程非常地长，方法的调用栈很深，在各个方法中不断跳转，那么为了方便读者理解，下面给出一个流程图，读者可结合该流程图以及上面的详解来进行理解。

注册流程

注销

与注册相对应的是注销，当订阅者不再需要事件的时候，我们要注销这个订阅者，即调用以下代码：

EventBus.getDefault().unregister(this);

那么我们来分析注销流程是怎样实现的，首先查看EventBus#unregister：

unregister

public synchronized void unregister(Object subscriber) {
    //根据当前的订阅者来获取它所订阅的所有事件
    List> subscribedTypes = typesBySubscriber.get(subscriber);
    if (subscribedTypes != null) {
        //遍历所有订阅的事件
        for (Class eventType : subscribedTypes) {
            unsubscribeByEventType(subscriber, eventType);
        }
        //从typesBySubscriber中移除该订阅者
        typesBySubscriber.remove(subscriber);
    } else {
        Log.w(TAG, "Subscriber to unregister was not registered before: " + subscriber.getClass());
    }
}

上面调用了EventBus#unsubscribeByEventType,把订阅者以及事件作为参数传递了进去，那么应该是解除两者的联系。

unsubscribeByEventType

private void unsubscribeByEventType(Object subscriber, Class eventType) {
    //根据事件类型从subscriptionsByEventType中获取相应的 subscriptions 集合
    List subscriptions = subscriptionsByEventType.get(eventType);
    if (subscriptions != null) {
        int size = subscriptions.size();
        //遍历所有的subscriptions，逐一移除
        for (int i = 0; i < size; i++) {
            Subscription subscription = subscriptions.get(i);
            if (subscription.subscriber == subscriber) {
                subscription.active = false;
                subscriptions.remove(i);
                i--;
                size--;
            }
        }
    }
}

可以看到，上面两个方法的逻辑是非常清楚的，都是从typesBySubscriber或subscriptionsByEventType移除相应与订阅者有关的信息，注销流程相对于注册流程简单了很多，其实注册流程主要逻辑集中于怎样找到订阅方法上。

发送事件

接下来，我们分析发送事件的流程，一般地，发送一个事件调用以下代码：

EventBus.getDefault().post(new MessageEvent("Hello !....."));`

我们来看看EventBus#post方法。

post

public void post(Object event) {
    //1、 获取一个postingState
    PostingThreadState postingState = currentPostingThreadState.get();
    List