掏空EventBus3.0-源码分析

EventBus 是 Android 和 Java 的发布/订阅事件总线。

可以在任意一个地方抛出事件，所有注册这个事件的地方(这里指标记了@Subscribe注解的订阅方法)都能收到事件(被触发调用)，EventBus同时支持线程控制，可以在注解上直接声明ThreadMode，指名该方法最后期望执行在哪个线程。用法这里不在赘述，网上教程都很详细，这里主要从源码角度分析EventBus。

一.EventBus创建

EventBus提供了一个getDefault() 方法，懒汉式的单例模式获取EventBus对象。

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

同时EventBus提供了EventBusBuilder去构建特殊配置的对象，EventBusBuilder是一个建造者，可以直接使用build()创建一个EventBus也可以构建出EventBusBuilder对象再传给EventBus的构造方法。
getDefault()中构造的EventBus对象是使用DEFAULT_BUILDER去创建的：

    private static final EventBusBuilder DEFAULT_BUILDER = new EventBusBuilder();

    public 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);
        indexCount = builder.subscriberInfoIndexes != null ? builder.subscriberInfoIndexes.size() : 0;
       //subscriberMethodFinder是在这里创建的，查找注解修饰的方法都是通过这个对象处理的
        subscriberMethodFinder = new SubscriberMethodFinder(builder.subscriberInfoIndexes,
                builder.strictMethodVerification, builder.ignoreGeneratedIndex);
        logSubscriberExceptions = builder.logSubscriberExceptions;
        logNoSubscriberMessages = builder.logNoSubscriberMessages;
        sendSubscriberExceptionEvent = builder.sendSubscriberExceptionEvent;
        sendNoSubscriberEvent = builder.sendNoSubscriberEvent;
        throwSubscriberException = builder.throwSubscriberException;
        eventInheritance = builder.eventInheritance;
        executorService = builder.executorService;
    }

DEFAULT_BUILDER的属性都是EventBusBuilder中的默认值，一般我们都是通过getDefault()去拿默认的EventBus，这里EventBusBuilder我们可以先忽略。
上面代码会创建一个subscriberMethodFinder对象，SubscriberMethodFinder这个类是负责去查找注解标注的方法的，后面会说到。

二.注册流程

如果一个类对象需要接收Event事件处理，我们称该对象为『订阅者』，除了要对其接收事件的方法加上@Subscribe注解外，还需要对该对象进行主动的注册：调用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);
            }
        }
    }

注册时，我们传入了订阅者的对象subscriber：
传入的subscriber主要用于以下两点：

• 1.通过subscriber对象可以很方便的找到subscriber类型中需要监听事件的方法（@Subscribe注解标注的方法，后面直接称『订阅方法』）。
  所以如果事件抛出（EventBus.post）在注册之前，订阅方法就不会被触发了，但是EventBus也设计了sticky的概念，可以通过postSticky抛出，可以在注册后收到之前已经抛出的事件，这个原理后面也会说。
• 2.事件触发后，订阅者的方法之所以能执行，就是通过此对象去调用的订阅方法(订阅方法需要是public的)。

register的代码分析：
register主要是调用了下面两个方法

• findSubscriberMethods()：通过subscriberMethodFinder查找订阅者Subscribe注解修饰的方法(含有"祖先类"的)。
• subscribe()：主要是对查找到的方法做一个存放；维护了两个map，方便后面事件抛出后，找到需要调用的SubscriberMethod(subscriberMethodFinder查找到的结果)
  subscriptionsByEventType:事件类型和方法订阅方法Subscription的映射；
  typesBySubscriber:以及订阅者对象subscriber和这个订阅者对象关心的所有事件类型的映射。

我们具体看下这两个方法做的事情：

• 1.findSubscriberMethods(Class subscriberClass)：

findSubscriberMethods方法返回了SubscriberMethod集合，SubscriberMethod这个对象存放的就是订阅者被@Subscribe注解修饰的方法相关信息：

//SubscriberMethod.java
class SubscriberMethod {
    final Method method;
    final ThreadMode threadMode;
    final Class eventType;
    final int priority;
    final boolean sticky;
    /** Used for efficient comparison */
    String methodString;
}

method是Subscribe注解所修饰的方法；threadMode是声明此方法最后期望运行线程模式；eventType对应定义的Event事件类型；priority也比较重要，优先级，同一个事件被多个方法订阅时，遵循这个优先级顺序执行；sticky是一个粘性标记，需要搭配EventBus.postSticky方法发出事件。

findSubscriberMethods：

//SubscriberMethodFinder.java
    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;
        }
    }

METHOD_CACHE是个cache，ignoreGeneratedIndex由于EventBusBuilder是默认实现，所以是false，所以直接看findUsingInfo就行了。

//SubscriberMethodFinder.java
 private List findUsingInfo(Class subscriberClass) {
        //FindState使用了一个池（FIND_STATE_POOL）避免在查找过程中的过多开销
        FindState findState = prepareFindState();
        //赋值class对象
        findState.initForSubscriber(subscriberClass);
        while (findState.clazz != null) {
            //getSubscriberInfo这里返回faluse，直接看false的分支
            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 {
                //此处是最终的订阅方法的查找，结果会存放到findState对象里面
                findUsingReflectionInSingleClass(findState);
            }
            //这里向上查找，向订阅者的父类查找，所以只需要在子类中注册即可
            findState.moveToSuperclass();
        }
        return getMethodsAndRelease(findState);
    }

    //返回查找结果并且recycle findState对象，重新放回FIND_STATE_POOL池
    private List getMethodsAndRelease(FindState findState) {
        List subscriberMethods = new ArrayList<>(findState.subscriberMethods);
        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;
    }

   //与findUsingInfo的while (findState.clazz != null) 一起实现了向上查找
    void moveToSuperclass() {
            if (skipSuperClasses) {
                clazz = null;
            } else {
                clazz = clazz.getSuperclass();
                String clazzName = clazz.getName();
                /** Skip system classes, this just degrades performance. */
                if (clazzName.startsWith("java.") || clazzName.startsWith("javax.") || clazzName.startsWith("android.")) {
                    clazz = null;
                }
            }
        }

上诉代码中关键处我已经加上了注释，很容易理解。while (findState.clazz != null) 和findState.moveToSuperclass()相结合实现了一个向上查找，最后可以找到包含当前订阅者subscriber以及其向上的父类、"爷爷类"等所有"祖先类"中被@Subscribe修饰的方法。

查找SubscriberMethod的关键方法findUsingReflectionInSingleClass：

//SubscriberMethodFinder.java
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();
           //方法必须是public并且不是abstract和static的
            if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {
                Class[] parameterTypes = method.getParameterTypes();
                if (parameterTypes.length == 1) {
                    Subscribe subscribeAnnotation = method.getAnnotation(Subscribe.class);
                    if (subscribeAnnotation != null) {
                       //读取注解信息组装SubscriberMethod
                        Class eventType = parameterTypes[0];
                        if (findState.checkAdd(method, eventType)) {
                            ThreadMode threadMode = subscribeAnnotation.threadMode();
                            findState.subscriberMethods.add(new SubscriberMethod(method, eventType, threadMode,
                                    subscribeAnnotation.priority(), subscribeAnnotation.sticky()));
                        }
                    }
                } 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");
            }
        }
    }

由于上面moveToSuperclass逻辑的存在，这个方法会被调用多次直到没有向上的父类为止，通过反射拿到订阅者类以及其父类中的所有方法，通过筛选，首先要满足以下条件：

private static final int MODIFIERS_IGNORE = Modifier.ABSTRACT | Modifier.STATIC | BRIDGE | SYNTHETIC;
(modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0

即需要是public的并且不是abstract和static的，因为只有这些方法才能被外部通过对象调用。
其次，肯定是含有Subscribe注解修饰的方法：

Subscribe subscribeAnnotation = method.getAnnotation(Subscribe.class);
      if (subscribeAnnotation != null) {
               Class eventType = parameterTypes[0];
                if (findState.checkAdd(method, eventType)) {
                   ThreadMode threadMode = subscribeAnnotation.threadMode();
                    findState.subscriberMethods.add(new SubscriberMethod(method, eventType, threadMode,
                   subscribeAnnotation.priority(), subscribeAnnotation.sticky()));
                }
      }

找到这些方法，从Subscribe注解中什么的配置信息，组装成SubscriberMethod对象返回，至此，我们在register时得到订阅者subscriber所有的SubscriberMethod。

到这里注册过程就完成了一半，拿到了subscriberMethods后还需要按一个比较好查找的数据结构存储下来方便我们后续查找，这就是subscribe()方法做的事情。

• 2.subscribe(Object subscriber, SubscriberMethod subscriberMethod)：

//EventBus.java
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
        //注册的事件类型
        Class eventType = subscriberMethod.eventType;
       //组装Subscription
        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();
       //根据优先级写入到subscriptions
        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) {
                // 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 {
                Object stickyEvent = stickyEvents.get(eventType);
                checkPostStickyEventToSubscription(newSubscription, stickyEvent);
            }
        }
    }

此方法做的事情主要就是将查找的方法存放到EventBus中对应的数据集里面，注意添加时是按优先级顺序添加到对应顺序的，注解的priority属性在这里生效：

• Map, CopyOnWriteArrayList> subscriptionsByEventType
  存放的是Event事件的类型->对应的订阅方法Subscription的映射，Subscription会以注解中声明的优先级顺序放入 CopyOnWriteArrayList集合中。

• Map>> typesBySubscriber;
  存放的是订阅者对象subscriber->其关心的Event事件类型映射。

• 另外，如果这个subscriberMethod是sticky的，那么在注册时，会去缓存的粘性事件stickyEvents中取处事件，主动触发订阅方法(这里调用的postToSubscription()方法，后面说post流程的时候再细说)。这里解答了为什么sticky可以收到注册之前已经发送过的sticky事件。
  Map, Object> stickyEvents存放的是postSticky抛出的事件类型以及对象。

三.取消注册流程

清除了注册流程，取消流程也就是对subscriptionsByEventType和typesBySubscriber中的元素做一些删除操作。

除此以外，取消注册时可能事件已经抛出了，所以取消注册的过程中会对订阅方法Subscription的active属性置为false(EventBus.unsubscribeByEventType()方法中)。

 #EventBus.java
   public synchronized void unregister(Object subscriber) {
        List> subscribedTypes = typesBySubscriber.get(subscriber);
        if (subscribedTypes != null) {
            for (Class eventType : subscribedTypes) {
                unsubscribeByEventType(subscriber, eventType);
            }
            typesBySubscriber.remove(subscriber);
        } else {
            Log.w(TAG, "Subscriber to unregister was not registered before: " + subscriber.getClass());
        }
    }

      private void unsubscribeByEventType(Object subscriber, Class eventType) {
        List subscriptions = subscriptionsByEventType.get(eventType);
        if (subscriptions != null) {
            int size = subscriptions.size();
            for (int i = 0; i < size; i++) {
                Subscription subscription = subscriptions.get(i);
                if (subscription.subscriber == subscriber) {
                   //此处将subscription.active设置成false
                    subscription.active = false;
                    subscriptions.remove(i);
                    i--;
                    size--;
                }
            }
        }
    }

所以后续在执行订阅消息前，需要先检查active的状态，这个检查的逻辑可以在后面三种XXXPoster类在调用EventBus的invokeSubscriber()时可以看到，见下文HandlerPoster章节。

四.发送事件

如果不需要额外处理线程、中间过程取消等控制的话，从之前的注册流程我们已经可以很轻松的获取到所有事件的订阅者及方法，直接通过反射调用订阅者的方法，我们已经可以很轻松触发订阅者的方法。
但是显然，EventBus给我们提供了一些管控方法、线程管理等。

post(Object event) ：

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