EventBus3源码分析

上篇，我们学习了EventBus3的使用方法，本篇一起来分析一下EventBus3的主要源码。

我们主要分析以下重点即可，其他的都是围绕这几个重点做补充：

1. EventBus实例创建
2. register注册流程
3. post事件发送流程
4. unregister解注册流程

EventBus实例创建

EventBus实例的创建方式有2种

• EventBus.getDefault()，获取默认配置的实例。使用的是很常见的Double Check和volatile保证单例。

static volatile EventBus defaultInstance;

/**
 * Double Check 方式单例
 */
public static EventBus getDefault() {
    EventBus instance = defaultInstance;
    if (instance == null) {
        synchronized (EventBus.class) {
            instance = EventBus.defaultInstance;
            if (instance == null) {
                instance = EventBus.defaultInstance = new EventBus();
            }
        }
    }
    return instance;
}

• 自定义配置，使用的是Builder建造者模式，可对EventBus的一些配置进行自定义，例如配置子线程回调订阅者方法的线程池执行器等。最后build()方法可按配置成EventBus实例，后续使用需要自己保存好实例，如果调用getDefault()获取的还是默认实例。如果希望让EventBus保存默认实例则可调用installDefaultEventBus()来保存实例为EventBus的默认实例。

/**
 * 自定义配置EventBus实例
 */
public static EventBusBuilder builder() {
    return new EventBusBuilder();
}

/**
 * EventBus实例自定义Builder配置
 */
public class EventBusBuilder {
    private final static ExecutorService DEFAULT_EXECUTOR_SERVICE = Executors.newCachedThreadPool();
    boolean logSubscriberExceptions = true;
    boolean logNoSubscriberMessages = true;
    boolean sendSubscriberExceptionEvent = true;
    boolean sendNoSubscriberEvent = true;
    boolean throwSubscriberException;
    boolean eventInheritance = true;
    boolean ignoreGeneratedIndex;
    boolean strictMethodVerification;
    ExecutorService executorService = DEFAULT_EXECUTOR_SERVICE;
    List> skipMethodVerificationForClasses;
    List subscriberInfoIndexes;
    Logger logger;
    MainThreadSupport mainThreadSupport;

    EventBusBuilder() {
    }
    
    //省略其他配置的set方法...
    
    /**
     * 配置子线程执行的线程池执行器
     */
    public EventBusBuilder executorService(ExecutorService executorService) {
        this.executorService = executorService;
        return this;
    }

    //省略其他配置的set方法...

    /**
     * 将生成的实例安装到默认实例，后续则可以使用getDefault()获取回这个实例，注意只能安装一次
     * 因此installDefaultEventBus()之前也不能调用getDefault()获取过实例，否则抛出异常
     */
    public EventBus installDefaultEventBus() {
        synchronized (EventBus.class) {
            if (EventBus.defaultInstance != null) {
                throw new EventBusException("Default instance already exists." +
                        " It may be only set once before it's used the first time to ensure consistent behavior.");
            }
            EventBus.defaultInstance = build();
            return EventBus.defaultInstance;
        }
    }
    
    /**
     * 按Builder配置生成EventBus实例
     */
    public EventBus build() {
        return new EventBus(this);
    }
}

订阅者注册

订阅者的注册，通过调用register()方法，传入订阅者实例即可，一般我们为Activity、Fragment中使用。接下来分析注册流程。

• 获取订阅者的Class，通过subscriberMethodFinder.findSubscriberMethods()查找订阅者的所有订阅方法。
• 遍历每个订阅方法，为每个订阅方法进行注册。

/**
 * 订阅事件
 */
public void register(Object subscriber) {
    Class subscriberClass = subscriber.getClass();
    //查找订阅者所有的订阅方法
    List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
    synchronized (this) {
        //遍历订阅的方法列表，对每个订阅方法都进行注册
        for (SubscriberMethod subscriberMethod : subscriberMethods) {
            subscribe(subscriber, subscriberMethod);
        }
    }
}

来分析一下subscriberMethodFinder.findSubscriberMethods()。SubscriberMethodFinder类是一个专门查找订阅者方法的一个类。

• 反射查找订阅方法是一个很耗时的操作，所以EventBus也做了缓存METHOD_CACHE，搜索前先从缓存中找，找得到则马上使用。
• 接下来是2个分支，一个是apt编译器生成订阅信息索引的方法，一种是反射获取订阅者的订阅方法，ignoreGeneratedIndex标志位标识是否忽略apt生成的订阅信息索引，默认为false，所以会走else逻辑。
• findUsingInfo()方法，则是反射获取订阅者的订阅信息。
• 如果找不到订阅信息，证明订阅者没有声明订阅方法，抛出异常。找得到则将订阅信息缓存到METHOD_CACHE，然后再返回。

//订阅方法缓存
private static final Map, List> METHOD_CACHE = new ConcurrentHashMap<>();

/**
 * 查找订阅者的订阅方法，将订阅信息封装在SubscriberMethod类中，多个方法，所以返回值为一个List集合
 *
 * @param subscriberClass 订阅者Class
 */
List findSubscriberMethods(Class subscriberClass) {
    //先从缓存中查找，有则直接使用
    List subscriberMethods = METHOD_CACHE.get(subscriberClass);
    if (subscriberMethods != null) {
        return subscriberMethods;
    }
    //是否忽略apt生成的索引，ignoreGeneratedIndex默认为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 {
        //获取到所有订阅方法后，保存到缓存中，然后返回
        METHOD_CACHE.put(subscriberClass, subscriberMethods);
        return subscriberMethods;
    }
}

findSubscriberMethods()的主要逻辑都在findUsingInfo()上，继续追踪

• 第一步，调用prepareFindState()方法，获取当前线程的查找状态并初始化
• 第二步，判断findState.subscriberInfo字段是否为空，为空调用findUsingReflectionInSingleClass()，这个方法才是反射获取订阅者的订阅信息
• 第三步，配置父类Class信息，会自动忽略系统类来提高性能
• 最后，getMethodsAndRelease()，转移findState上保存的List，并对FindState中间对象回收

/**
 * 反射查找订阅者所有的订阅方法
 *
 * @param subscriberClass 订阅者Class
 */
private List findUsingInfo(Class subscriberClass) {
    //获取当前线程的查找状态
    FindState findState = prepareFindState();
    //初始化一些值
    findState.initForSubscriber(subscriberClass);
    while (findState.clazz != null) {
        //获取订阅信息
        findState.subscriberInfo = getSubscriberInfo(findState);
        //初始化时，findState.subscriberInfo为null
        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 {
            //反射获取订阅者的所有订阅方法
            findUsingReflectionInSingleClass(findState);
        }
        //配置父类Class信息，会自动忽略系统类来提高性能
        findState.moveToSuperclass();
    }
    //转移findState上保存的List，并对FindState中间对象回收
    return getMethodsAndRelease(findState);
}

分析prepareFindState()方法

• 很明显，FindState是复用对象的，作用就是避免频繁创建FindState类。
• 先从缓存池中查找FindState可用的对象，可用则返回。
• 不可用，则新建一个FindState类实例。

//对象池大小
private static final int POOL_SIZE = 4;
//FindState对象池
private static final FindState[] FIND_STATE_POOL = new FindState[POOL_SIZE];

/**
 * 获取一个查找状态
 */
private FindState prepareFindState() {
    synchronized (FIND_STATE_POOL) {
        //享元模式，从对象池中找，避免频繁创建FindState类
        for (int i = 0; i < POOL_SIZE; i++) {
            FindState state = FIND_STATE_POOL[i];
            if (state != null) {
                FIND_STATE_POOL[i] = null;
                return state;
            }
        }
    }
    //没有缓存对象可用，则创建一个
    return new FindState();
}

findState.initForSubscriber(subscriberClass)，则是初始化findState的初始化一些值

/**
 * 查找状态实体类
 */
static class FindState {
    Class subscriberClass;
    boolean skipSuperClasses;
    SubscriberInfo subscriberInfo;

    //初始化findState的初始化一些值
    void initForSubscriber(Class subscriberClass) {
        this.subscriberClass = clazz = subscriberClass;
        skipSuperClasses = false;
        subscriberInfo = null;
    }
}

findState经过initForSubscriber()后，subscriberInfo字段被置为null，所以只能走else逻辑，继续分析findUsingReflectionInSingleClass()

• findUsingReflectionInSingleClass()方法，主要是使用反射来获取订阅者的Subscribe注解的方法，然后将方法的Method对象（有这个对象就能调用invoked调用订阅者方法），事件Class，配置的threadMode，priorty优先级，是否粘性sticky，封装到SubscriberMethod对象中，最后所有的订阅方法都在SubscriberMethod对象都收集到了findState.subscriberMethods集合中。这样订阅者的订阅信息都收集到了。

/**
 * 反射获取订阅者的所有订阅方法
 *
 * @param findState 查找状态
 */
private void findUsingReflectionInSingleClass(FindState findState) {
    Method[] methods;
    try {
        //使用getDeclaredMethods，反射获取所有方法，不会获取到父类中的方法，避免查找耗时，尤其是Activity，一般我们都是在子类上使用
        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公开，并且不是static静态方法，
        if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {
            //获取方法参数
            Class[] parameterTypes = method.getParameterTypes();
            //限定订阅方法的方法参数为1个，就是event事件类
            if (parameterTypes.length == 1) {
                //判断方法是否加了@Subscribe注解，必须加了才处理
                Subscribe subscribeAnnotation = method.getAnnotation(Subscribe.class);
                if (subscribeAnnotation != null) {
                    //获取第一个参数，就是事件event
                    Class eventType = parameterTypes[0];
                    //检查是否已经添加过了，没有添加过才继续
                    if (findState.checkAdd(method, eventType)) {
                        //获取@Subscribe注解上的threadMode参数，就是事件回调的线程策略
                        ThreadMode threadMode = subscribeAnnotation.threadMode();
                        //创建SubscriberMethod对象，代表每个订阅方法的信息
                        //将@Subscribe注解上定义的事件类型、线程回调策略、回调优先级、是否粘性等字段保存到SubscriberMethod类中
                        //再将SubscriberMethod对象保存到findState.subscriberMethods订阅的方法列表中
                        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");
        }
    }
}

回到SubscriberMethodFinder的findUsingInfo()方法，调用完findUsingReflectionInSingleClass()收集订阅者订阅信息后，再调用了moveToSuperclass()方法，其实就是配置父类Class信息，会自动忽略系统类来提高性能。

/**
 * 配置父类Class信息，会自动忽略系统类来提高性能
 */
void moveToSuperclass() {
    if (skipSuperClasses) {
        clazz = null;
    } else {
        clazz = clazz.getSuperclass();
        String clazzName = clazz.getName();
        //跳过系统的类（肯定不会有EventBus的东西），来提高性能
        if (clazzName.startsWith("java.") || clazzName.startsWith("javax.") || clazzName.startsWith("android.")) {
            clazz = null;
        }
    }
}

调用getMethodsAndRelease()，将findState中的subscriberMethods订阅信息集合转到一个ArrayList中，调用findState的recycle()重置对象字段，再将实例放到FIND_STATE_POOL对象池中复用。

/**
 * 将FindState上保存的订阅方法保存到一个List集合，并将FindState回收，将FindState类放到对象池中复用
 *
 * @param findState 保存了订阅信息的中间类
 */
private List getMethodsAndRelease(FindState findState) {
    //将订阅的方法信息保存到一个List集合
    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;
            }
        }
    }
    //返回这个List集合
    return subscriberMethods;
}

/**
 * 查找状态实体类
 */
static class FindState {
    //...忽略其他字段和方法

    /**
     * 回收操作，重置字段
     */
    void recycle() {
        subscriberMethods.clear();
        anyMethodByEventType.clear();
        subscriberClassByMethodKey.clear();
        methodKeyBuilder.setLength(0);
        subscriberClass = null;
        clazz = null;
        skipSuperClasses = false;
        subscriberInfo = null;
    }
}

调用findSubscriberMethods()方法获取到订阅者的订阅信息列表后，我们回到register()方法，将订阅信息列表遍历，调用subscribe()方法，传入订阅对象和订阅信息。

• subscribe()方法的作用是：将订阅信息和订阅关系分拆到3个Map中，然后订阅者优先级排序，最后如果有粘性方法订阅，查找粘性事件的Map，回调订阅者方法。

先来了解下这3个Map是什么（很重要，后续事件回调都需要用到它们）：

• subscriptionsByEventType，事件类型和订阅它的订阅者的订阅信息（包含订阅者对象和订阅方法），一对多关系，一个事件类型，对应多个订阅者信息。

• typesBySubscriber，订阅者和它所订阅的事件类型映射，一对多关系，一个订阅者对应多个事件

• stickyEvents，粘性事件映射表，一对一关系，一个事件对应一个最近发送的事件对象

/**
 * 事件类型和订阅它的订阅者的订阅信息（包含订阅者对象和订阅方法），一对多关系，一个事件类型，对应多个订阅者信息
 */
private final Map, CopyOnWriteArrayList> subscriptionsByEventType;
/**
 * 订阅者和它所订阅的事件类型映射，一对多关系，一个订阅者对应多个事件
 */
private final Map>> typesBySubscriber;
/**
 * 粘性事件映射表，一对一关系，一个事件对应一个最近发送的事件对象
 */
private final Map, Object> stickyEvents;

/**
 * 将订阅者和订阅方法执行绑定
 *
 * @param subscriber       订阅者
 * @param subscriberMethod 订阅方法信息对象
 */
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
    //获取事件类型
    Class eventType = subscriberMethod.eventType;
    //新建Subscription订阅信息类
    Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
    //从subscriptionsByEventType中查找订阅信息列表
    CopyOnWriteArrayList subscriptions = subscriptionsByEventType.get(eventType);
    //没有，则创建一个，并放到subscriptionsByEventType中
    if (subscriptions == null) {
        subscriptions = new CopyOnWriteArrayList<>();
        subscriptionsByEventType.put(eventType, subscriptions);
    } else {
        //已经调用了register方法订阅过了，不能重复订阅
        if (subscriptions.contains(newSubscription)) {
            throw new EventBusException("Subscriber " + subscriber.getClass() + " already registered to event "
                    + eventType);
        }
    }

    //优先级排序，优先级越高，越在List列表中靠前
    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;
        }
    }
    //从typesBySubscriber中用订阅者获取它订阅的事件类型列表
    List> subscribedEvents = typesBySubscriber.get(subscriber);
    //还没有注册过，所以时间类型列表subscribedEvents为空，为空则创建一个
    if (subscribedEvents == null) {
        subscribedEvents = new ArrayList<>();
        //创建完毕，再保存到Map
        typesBySubscriber.put(subscriber, subscribedEvents);
    }
    //将事件类型添加到事件类型列表中
    subscribedEvents.add(eventType);

    //判断订阅方法是否是粘性的
    if (subscriberMethod.sticky) {
        //判断是否需要发送子类事件时也发送父类事件，默认为true，如果事件POJO不会继承，建议设置为false来提高性能
        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 {
            //粘性事件意思是订阅时，如果之前有发送过粘性事件则马上回调订阅方法
            //从粘性事件列表以事件类型中获取粘性事件POJO实例（所有粘性事件都会保存最近一份到内存）
            Object stickyEvent = stickyEvents.get(eventType);
            checkPostStickyEventToSubscription(newSubscription, stickyEvent);
        }
    }
}

判断到存在粘性订阅方法时，调用checkPostStickyEventToSubscription()方法，检查粘性事件是否存在，存在则调用postToSubscription发送事件，回调订阅者的订阅方法。postToSubscription()方法我们在下面post()事件时分析。

/**
 * 检查粘性事件对象，以及将粘性事件发送到订阅者
 *
 * @param newSubscription 订阅信息
 * @param stickyEvent     粘性事件
 */
private void checkPostStickyEventToSubscription(Subscription newSubscription, Object stickyEvent) {
    //没有发送过这个类型的粘性事件，那么就不做任何操作
    if (stickyEvent != null) {
        // If the subscriber is trying to abort the event, it will fail (event is not tracked in posting state)
        // --> Strange corner case, which we don't take care of here.
        //不为空，那么将这个粘性事件发送给订阅者
        postToSubscription(newSubscription, stickyEvent, isMainThread());
    }
}

register流程我们分析完了，工作原理主要是使用反射获取订阅者使用Subscribe注册标记的订阅方法，里面的耗时操作都加上了享元模式-对象池缓存或者是Map缓存，避免重复查找。

获取完订阅者的订阅信息列表后，将订阅信息和订阅关系分拆到很关键的3个Map中，最后判断是否有粘性事件订阅方法，再判断粘性事件是否存在，存在则发送事件，回调订阅者的订阅方法。

发送事件

发送事件使用post()方法，发送粘性事件使用，下面来一起分析一下吧。

/**
 * 发送事件
 */
public void post(Object event) {
    //获取当前线程的发送状态
    PostingThreadState postingState = currentPostingThreadState.get();
    //获取发送状态的队列
    List