Android 主流開源框架（八）EventBus 源碼解析（含面試相關文問題解答）

前言

最近有個想法——就是把 Android 主流開源框架進行深刻分析，而後寫成一系列文章，包括該框架的詳細使用與源碼解析。目的是經過鑑賞大神的源碼來了解框架底層的原理，也就是作到不只要知其然，還要知其因此然。html

這裏我說下本身閱讀源碼的經驗，我通常都是按照平時使用某個框架或者某個系統源碼的使用流程入手的，首先要知道怎麼使用，而後再去深究每一步底層作了什麼，用了哪些好的設計模式，爲何要這麼設計。java

系列文章：git

更多幹貨請關注 AndroidNotes程序員

1、使用示例

1.1 基本用法

（1）定義事件
這個事件就是須要傳遞的實體類。github

public class MessageEvent {

    public final String message;

    public MessageEvent(String message) {
        this.message = message;
    }
}
複製代碼

（2）準備訂閱者
聲明用來處理事件的訂閱方法。面試

@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {
    Toast.makeText(this, event.message, Toast.LENGTH_SHORT).show();
}
複製代碼

（3）註冊與解除註冊
註冊與解除註冊訂閱者，與第（2）步放在同一個類中。設計模式

@Override
public void onStart() {
    super.onStart();
    EventBus.getDefault().register(this);
}

@Override
public void onStop() {
    super.onStop();
    EventBus.getDefault().unregister(this);
}
複製代碼

（4）發送事件
能夠在任何地方發送事件。緩存

EventBus.getDefault().post(new MessageEvent("普通事件"));
複製代碼

1.2 粘性事件

普通事件是先註冊和準備訂閱者，而後再發送事件才能收到。而粘性事件在發送事件以後再註冊和準備訂閱者也能收到事件。安全

使用上與普通事件的區別是第（2）步須要增長「sticky = true」聲明爲粘性事件，第（4）步 post 方法改爲 postSticky 方法，以下：markdown

準備訂閱者：

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onMessageEvent(StickyMessageEvent event) {
    Toast.makeText(this, event.message, Toast.LENGTH_SHORT).show();
}
複製代碼

發送事件：

EventBus.getDefault().postSticky(new StickyMessageEvent("粘性事件"));
複製代碼

接下來咱們就根據這幾步進行源碼分析。

2、源碼分析

源碼版本：3.2.0

2.1 Subscribe 註解

/*Subscribe*/
public @interface Subscribe {
    //（1）
    ThreadMode threadMode() default ThreadMode.POSTING;
    //（2）
    boolean sticky() default false;
    //（3）
    int priority() default 0;
}
複製代碼

源碼中我標註了 3 個關注點，分別以下：

（1）：指定線程模式，即指定訂閱方法在哪一個線程執行，線程模式一共有 5 種：POSTING（默認模式）、MAIN、MAIN_ORDERED、BACKGROUND、ASYNC，關於它們的區別放到後面再分析。
（2）：是不是粘性事件
（3）：指定優先級，默認爲 0。在相同線程模式下，優先級越高的訂閱方法越先收到事件。

以上設置都是在「準備訂閱者」那裏配置的，以下：

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true, priority = 1)
public void onMessageEvent(StickyMessageEvent event) {
    Toast.makeText(this, event.message, Toast.LENGTH_SHORT).show();
}
複製代碼

2.2 註冊

在看註冊方法以前咱們先看下是怎麼獲取 EventBus 實例的，即 EventBus#getDefault() 中的 getDefault 方法：

/*EventBus*/
    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;
    }
複製代碼

能夠看到，這裏是經過雙重校驗鎖的單例模式來獲取 EventBus 的實例。

看一下它的構造方法：

/*EventBus*/
    private final Map<Class<?>, CopyOnWriteArrayList<Subscription>> subscriptionsByEventType;
    private final Map<Object, List<Class<?>>> typesBySubscriber;
    private final Map<Class<?>, Object> stickyEvents;

    public EventBus() {
        this(DEFAULT_BUILDER);
    }

    EventBus(EventBusBuilder builder) {
        logger = builder.getLogger();
        //（1）start
        subscriptionsByEventType = new HashMap<>();
        typesBySubscriber = new HashMap<>();
        stickyEvents = new ConcurrentHashMap<>();
        //（1）end

        mainThreadSupport = builder.getMainThreadSupport();
        //（2）
        mainThreadPoster = mainThreadSupport != null ? mainThreadSupport.createPoster(this) : null;
        //（3）
        backgroundPoster = new BackgroundPoster(this);
        //（4）
        asyncPoster = new AsyncPoster(this);
        indexCount = builder.subscriberInfoIndexes != null ? builder.subscriberInfoIndexes.size() : 0;
        //（5）
        subscriberMethodFinder = new SubscriberMethodFinder(builder.subscriberInfoIndexes,
                builder.strictMethodVerification, builder.ignoreGeneratedIndex);
        /*一些 boolean 類型的常量賦值*/
        logSubscriberExceptions = builder.logSubscriberExceptions;
        logNoSubscriberMessages = builder.logNoSubscriberMessages;
        sendSubscriberExceptionEvent = builder.sendSubscriberExceptionEvent;
        sendNoSubscriberEvent = builder.sendNoSubscriberEvent;
        throwSubscriberException = builder.throwSubscriberException;
        eventInheritance = builder.eventInheritance;

        //（6）
        executorService = builder.executorService;
    }
複製代碼

首先是調用無參構造方法，而後傳入一個 DEFAULT_BUILDER 來調用有參構造，這個 DEFAULT_BUILDER 是 EventBusBuilder，它是一個 EventBus 的建造器，裏面封裝了一些 EventBus 所須要的參數等。源碼中我標記了 6 個關注點，分別以下：

（1）：能夠看到這裏建立的 3 個對象都是 map 集合，具體保存了什麼這裏看不出來，咱們後面再分析。
（2）：建立了一個 mainThreadPoster 對象，該對象主要用來將線程模型爲 MAIN 和 MAIN_ORDERED 的事件加入到隊列中，而後進行處理。點擊 createPoster 方法進去看看是怎麼建立的：

/*MainThreadSupport*/
public interface MainThreadSupport {

    ...

    Poster createPoster(EventBus eventBus);

    class AndroidHandlerMainThreadSupport implements MainThreadSupport {

        ...

        @Override
        public Poster createPoster(EventBus eventBus) {
            return new HandlerPoster(eventBus, looper, 10);
        }
    }

}

/*HandlerPoster*/
public class HandlerPoster extends Handler implements Poster {
    ...
}
複製代碼

能夠看到這裏建立了一個 HandlerPoster，因此這裏的 mainThreadPoster 其實是一個 HandlerPoster。

（3）建立了一個 BackgroundPoster 對象，該對象主要用來將線程模型爲 BACKGROUND 的事件加入到隊列中，而後進行處理。
（4）建立了一個 AsyncPoster 對象，該對象主要用來將線程模型爲 ASYNC 的事件加入到隊列中，而後進行處理。
（5）建立了一個 SubscriberMethodFinder 對象，該對象主要用來獲取註冊類上全部訂閱方法的集合。
（6）從 EventBusBuilder 中取出一個建立好的線程池（CachedThreadPool）賦值給 executorService。

接下來看下 register 方法：

/*EventBus*/
    public void register(Object subscriber) {
        Class<?> subscriberClass = subscriber.getClass();
        //（1）
        List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
        synchronized (this) {
            //（2）
            for (SubscriberMethod subscriberMethod : subscriberMethods) {
                subscribe(subscriber, subscriberMethod);
            }
        }
    }
複製代碼

源碼中我標記了 2 個關注點，分別以下：

EventBus#register() 中的關注點（1）——findSubscriberMethods()

主要是獲取註冊類上全部訂閱方法的集合，也就是使用示例中「準備訂閱者」那步加了 @Subscribe 註解的那些方法。點進去看看：

/*SubscriberMethodFinder*/
    private static final Map<Class<?>, List<SubscriberMethod>> METHOD_CACHE = new ConcurrentHashMap<>();
    private final boolean ignoreGeneratedIndex;

    List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {
        //（1）
        List<SubscriberMethod> subscriberMethods = METHOD_CACHE.get(subscriberClass);
        if (subscriberMethods != null) {
            return subscriberMethods;
        }

        //（2）
        if (ignoreGeneratedIndex) {
            subscriberMethods = findUsingReflection(subscriberClass);
        } else {
            //（3）
            subscriberMethods = findUsingInfo(subscriberClass);
        }
        // 訂閱方法爲空，說明註冊類中不存在 @Subscribe 註解的方法。
        if (subscriberMethods.isEmpty()) {
            throw new EventBusException("Subscriber " + subscriberClass
                    + " and its super classes have no public methods with the @Subscribe annotation");
        } else {
            //（4）
            METHOD_CACHE.put(subscriberClass, subscriberMethods);
            return subscriberMethods;
        }
    }
複製代碼

源碼中我標記了 4 個關注點，分別以下：

（1）：從 METHOD_CACHE 集合中查找是否已經緩存了該註冊類上的訂閱方法。
（2）：ignoreGeneratedIndex 是在 EventBus 的有參構造中經過 EventBusBuilder 配置的，咱們沒配置，默認是 false，因此直接走關注點（3）。
（3）：查找全部訂閱方法。
（4）：找到全部訂閱方法後緩存到 METHOD_CACHE 集合中。

下面具體看看關注點（3）中內部是怎麼實現的：

/*SubscriberMethodFinder*/
    private List<SubscriberMethod> findUsingInfo(Class<?> subscriberClass) {
        //（1）
        FindState findState = prepareFindState();
        //（2）
        findState.initForSubscriber(subscriberClass);
        while (findState.clazz != null) {
            //（3）
            findState.subscriberInfo = getSubscriberInfo(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 {
                //（4）
                findUsingReflectionInSingleClass(findState);
            }
            findState.moveToSuperclass();
        }
        //（5）
        return getMethodsAndRelease(findState);
    }
複製代碼

源碼中我標記了 5 個關注點，分別以下：

（1）：調用 prepareFindState 方法返回一個 FindState 對象，看一下 FindState：

/*SubscriberMethodFinder*/
class SubscriberMethodFinder {
    static class FindState {
        /*查找過程當中臨時用來記錄訂閱方法等的一些集合*/
        final List<SubscriberMethod> subscriberMethods = new ArrayList<>();
        final Map<Class, Object> anyMethodByEventType = new HashMap<>();
        final Map<String, Class> subscriberClassByMethodKey = new HashMap<>();

        final StringBuilder methodKeyBuilder = new StringBuilder(128);

        /*臨時用來記錄的一些變量*/
        Class<?> subscriberClass;
        Class<?> clazz;
        boolean skipSuperClasses;
        SubscriberInfo subscriberInfo;

        void initForSubscriber(Class<?> subscriberClass) {
            this.subscriberClass = clazz = subscriberClass;
            skipSuperClasses = false;
            subscriberInfo = null;
        }

        // 查找完成進行回收
        void recycle() {
            subscriberMethods.clear();
            anyMethodByEventType.clear();
            subscriberClassByMethodKey.clear();
            methodKeyBuilder.setLength(0);
            subscriberClass = null;
            clazz = null;
            skipSuperClasses = false;
            subscriberInfo = null;
        }

        ...

    }
}
複製代碼

能夠看到，FindState 是 SubscriberMethodFinder 中的靜態類，主要用來輔助查找訂閱方法。

繼續看下 prepareFindState 方法是怎麼返回 FindState 對象的：

/*SubscriberMethodFinder*/
    private FindState prepareFindState() {
        synchronized (FIND_STATE_POOL) {
            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();
    }
複製代碼

首先從 FIND_STATE_POOL 中取出可用的 FindState，若是沒有則從新建立一個 FindState。

（2）：初始化剛剛 FindState 類中的那些變量。
（3）：點擊 getSubscriberInfo 方法進去看看：

/*SubscriberMethodFinder*/
    private SubscriberInfo getSubscriberInfo(FindState findState) {
        if (findState.subscriberInfo != null && findState.subscriberInfo.getSuperSubscriberInfo() != null) {
            SubscriberInfo superclassInfo = findState.subscriberInfo.getSuperSubscriberInfo();
            if (findState.clazz == superclassInfo.getSubscriberClass()) {
                return superclassInfo;
            }
        }
        if (subscriberInfoIndexes != null) {
            for (SubscriberInfoIndex index : subscriberInfoIndexes) {
                SubscriberInfo info = index.getSubscriberInfo(findState.clazz);
                if (info != null) {
                    return info;
                }
            }
        }
        return null;
    }
複製代碼

其中 subscriberInfo 是剛剛關注點（2）中初始化的 null，subscriberInfoIndexes 是在 EventBus 的有參構造中經過 EventBusBuilder 配置的，咱們沒配置，也爲 null，因此這個方法默認只會返回 null。

（4）：點擊 findUsingReflectionInSingleClass 方法進去看看：

/*SubscriberMethodFinder*/
    private void findUsingReflectionInSingleClass(FindState findState) {
        Method[] methods;
        try {
            // 反射獲取註冊類中的全部方法
            methods = findState.clazz.getDeclaredMethods();
        } catch (Throwable th) {
            try {
                // 反射獲取註冊類中的全部方法
                methods = findState.clazz.getMethods();
            } catch (LinkageError error) {
                ...
            }
            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 subscribeAnnotation = method.getAnnotation(Subscribe.class);
                    if (subscribeAnnotation != null) {
                        // 獲取方法上的第一個參數，也就是事件類型（即便用示例中 MessageEvent 的類型）
                        Class<?> eventType = parameterTypes[0];
                        if (findState.checkAdd(method, eventType)) {
                            // 獲取線程模式
                            ThreadMode threadMode = subscribeAnnotation.threadMode();
                            // 將方法、事件類型、線程模式、優先級、是不是粘性事件封裝到 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");
            }
        }
    }
複製代碼

上面的註釋寫的很清楚了，主要是經過反射獲取註冊類中的全部方法，而後遍歷方法，判斷若是帶有 Subscribe 註解的方法，就將該方法、事件類型、線程模式、優先級、是不是粘性事件封裝到 SubscriberMethod 對象，而後添加到 FindState 類中的 subscriberMethods 集合中存起來。

（5）：點擊 getMethodsAndRelease 方法進去看看：

/*SubscriberMethodFinder*/
    private List<SubscriberMethod> getMethodsAndRelease(FindState findState) {
        List<SubscriberMethod> 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;
    }
複製代碼

能夠看到，這裏首先從 FindState 中取出保存的全部訂閱方法的信息，這時候 FindState 就沒用了，那麼須要調用 recycle 方法將裏面的一些集合、變量等進行回收。可是 FindState 常常要用到，因此會把它緩存到 FIND_STATE_POOL 中，這樣下次就不用從新建立 FindState 了，提升性能。最後將 subscriberMethods 返回。

這樣 findSubscriberMethods 方法就看完了，繼續看 EventBus#register() 中的關注點（2），即 subscribe 方法。

EventBus#register() 中的關注點（2）——subscribe()

主要是循環獲取每一個訂閱方法進行訂閱，實際內部只是給 subscriptionsByEventType、typesBySubscriber 集合添加數據。點進去看看：

/*EventBus*/
    private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
        // 獲取事件類型
        Class<?> eventType = subscriberMethod.eventType;
        //（1）
        Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
        //（2）start
        CopyOnWriteArrayList<Subscription> 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);
            }
        }
        //（2）end

        int size = subscriptions.size();
        //（3）
        for (int i = 0; i <= size; i++) {
            if (i == size || subscriberMethod.priority > subscriptions.get(i).subscriberMethod.priority) {
                subscriptions.add(i, newSubscription);
                break;
            }
        }

        //（4）start
        List<Class<?>> subscribedEvents = typesBySubscriber.get(subscriber);
        if (subscribedEvents == null) {
            subscribedEvents = new ArrayList<>();
            typesBySubscriber.put(subscriber, subscribedEvents);
        }
        subscribedEvents.add(eventType);
        //（4）end

        //（5）
        if (subscriberMethod.sticky) {
            ...
        }
    }
複製代碼

源碼中我標註了 5 個關注點，分別以下：

（1）：將註冊類與訂閱方法封裝到 Subscription。
（2）：subscriptionsByEventType 就是一開始在 EventBus 有參構造方法中建立的 HashMap，終於用到了！這裏首先經過 eventType 去 subscriptionsByEventType 中查找是否已經有 Subscription 集合，沒有則建立一個，而後添加到 subscriptionsByEventType 中。因此 subscriptionsByEventType 是一個存儲 key 爲事件類型，value 爲 Subscription 集合的 HashMap。
（3）：根據設置的優先級將 newSubscription 添加到 subscriptions 集合中，也就是將優先級越高的排在集合中越前的位置。
（4）：typesBySubscriber 也是一開始在 EventBus 有參構造方法中建立的 HashMap，這裏首先經過 subscriber 去 typesBySubscriber 中查找是否已經有 eventType 集合，沒有則建立一個，而後添加到 typesBySubscriber 中，最後一句是添加事件到事件集合中。因此 typesBySubscriber 是一個存儲 key 爲註冊類（對應使用示例中的 EventBusFirstActivity），value 爲事件類型集合的 HashMap。typesBySubscriber 的做用是判斷某個對象是否註冊過，防止重複註冊。也就是下面這個方法：

/*EventBus*/
    public synchronized boolean isRegistered(Object subscriber) {
        return typesBySubscriber.containsKey(subscriber);
    }
複製代碼

（5）：粘性事件相關邏輯，放到最後再分析。

這樣，註冊方法也就分析完了。

小結
經過反射獲取註冊類上全部的訂閱方法，而後將這些訂閱方法進行包裝保存到 subscriptionsByEventType 集合。這裏還用 typesBySubscriber 集合保存了事件類型集合，用來判斷某個對象是否註冊過。

2.3 解除註冊

看一下解除註冊的 unregister 方法：

/*EventBus*/
    public synchronized void unregister(Object subscriber) {
        // 根據註冊類獲取 typesBySubscriber 集合中保存的事件類型集合
        List<Class<?>> subscribedTypes = typesBySubscriber.get(subscriber);
        if (subscribedTypes != null) {
            for (Class<?> eventType : subscribedTypes) {
                // 看下面
                unsubscribeByEventType(subscriber, eventType);
            }
            // 移除 typesBySubscriber 中保存的事件類型集合
            typesBySubscriber.remove(subscriber);
        } else {
            logger.log(Level.WARNING, "Subscriber to unregister was not registered before: " + subscriber.getClass());
        }
    }

    /*EventBus*/
    private void unsubscribeByEventType(Object subscriber, Class<?> eventType) {
        // 根據事件類型獲取 subscriptionsByEventType 集合中保存的 Subscription 集合
        List<Subscription> 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 集合中移除 Subscription
                    subscriptions.remove(i);
                    i--;
                    size--;
                }
            }
        }
    }
複製代碼

能夠看到，unregister 方法很是簡單，上面都有註釋了，咱們直接來個小結。

小結
註冊的時候使用 subscriptionsByEventType 集合保存了全部訂閱方法信息，使用 typesBySubscriber 集合保存了全部事件類型。那麼解註冊的時候就是爲了移除這兩個集合中保存的內容。

2.4 發送普通事件

看一下發送事件的 post 方法：

/*EventBus*/
    private final ThreadLocal<PostingThreadState> currentPostingThreadState = new ThreadLocal<PostingThreadState>() {
        @Override
        protected PostingThreadState initialValue() {
            return new PostingThreadState();
        }
    };

    public void post(Object event) {
        //（1）start
        PostingThreadState postingState = currentPostingThreadState.get();
        List<Object> eventQueue = postingState.eventQueue;
        eventQueue.add(event);
        //（1）end

        if (!postingState.isPosting) {
            postingState.isMainThread = isMainThread();
            postingState.isPosting = true;
            if (postingState.canceled) {
                throw new EventBusException("Internal error. Abort state was not reset");
            }
            try {
                while (!eventQueue.isEmpty()) {
                    //（2）
                    postSingleEvent(eventQueue.remove(0), postingState);
                }
            } finally {
                postingState.isPosting = false;
                postingState.isMainThread = false;
            }
        }
    }
複製代碼

源碼中我標記了 2 個關注點，分別以下：

EventBus#post() 中的關注點（1）

這裏的 currentPostingThreadState 是一個 ThreadLocal 對象，裏面保存了 PostingThreadState。使用 ThreadLocal 的好處是保證 PostingThreadState 是線程私有的，其餘線程沒法訪問，避免出現線程安全問題。

繼續看下 PostingThreadState 裏面是什麼：

/*EventBus*/
public class EventBus {
    final static class PostingThreadState {
        final List<Object> eventQueue = new ArrayList<>();
        boolean isPosting;
        boolean isMainThread;
        Subscription subscription;
        Object event;
        boolean canceled;
    }
}
複製代碼

能夠看到，裏面有事件隊列、Subscription、事件，以及是否正在發送、是否主線程、是否已取消的標記位。

因此關注點（1）就是從 currentPostingThreadState 中獲取 PostingThreadState，而後拿到事件隊列，最後將傳進來的事件保存到該事件隊列中。

EventBus#post() 中的關注點（2）——postSingleEvent()

主要是從事件隊列中取出一個事件進行發送，看下里面作了什麼：

/*EventBus*/
    private void postSingleEvent(Object event, PostingThreadState postingState) throws Error {
        Class<?> eventClass = event.getClass();
        // 是否找到訂閱者
        boolean subscriptionFound = false;
        //（1）
        if (eventInheritance) {
            //（2）
            List<Class<?>> eventTypes = lookupAllEventTypes(eventClass);
            int countTypes = eventTypes.size();
            for (int h = 0; h < countTypes; h++) {
                Class<?> clazz = eventTypes.get(h);
                //（3）
                subscriptionFound |= postSingleEventForEventType(event, postingState, clazz);
            }
        } else {
            // （4）
            subscriptionFound = postSingleEventForEventType(event, postingState, eventClass);
        }
        if (!subscriptionFound) {
            if (logNoSubscriberMessages) {
                logger.log(Level.FINE, "No subscribers registered for event " + eventClass);
            }
            if (sendNoSubscriberEvent && eventClass != NoSubscriberEvent.class &&
                    eventClass != SubscriberExceptionEvent.class) {
                //（5）
                post(new NoSubscriberEvent(this, event));
            }
        }
    }
複製代碼

源碼中我標記了 5 個關注點，分別以下：

（1）：eventInheritance 表示是否須要發送父類與接口中的事件，默認爲 true，可在 EventBusBuilder 中配置。
（2）：點擊 lookupAllEventTypes 方法進去看看：

/*EventBus*/
private static final Map<Class<?>, List<Class<?>>> eventTypesCache = new HashMap<>();

    private static List<Class<?>> lookupAllEventTypes(Class<?> eventClass) {
        synchronized (eventTypesCache) {
            List<Class<?>> eventTypes = eventTypesCache.get(eventClass);
            if (eventTypes == null) {
                eventTypes = new ArrayList<>();
                Class<?> clazz = eventClass;
                while (clazz != null) {
                    eventTypes.add(clazz);
                    addInterfaces(eventTypes, clazz.getInterfaces());
                    clazz = clazz.getSuperclass();
                }
                eventTypesCache.put(eventClass, eventTypes);
            }
            return eventTypes;
        }
    }

    static void addInterfaces(List<Class<?>> eventTypes, Class<?>[] interfaces) {
        for (Class<?> interfaceClass : interfaces) {
            if (!eventTypes.contains(interfaceClass)) {
                eventTypes.add(interfaceClass);
                addInterfaces(eventTypes, interfaceClass.getInterfaces());
            }
        }
    }
複製代碼

主要是查找全部事件類型，包括當前事件、父類和接口中的事件。這裏用了一個 eventTypesCache 集合類保存查找到的事件類型，避免每次都查找，提升性能。

（3）：根據事件類型發送事件，包括父類、接口。
（4）：根據事件類型只發送當前註冊類的事件，忽略父類以及接口。
（5）：沒有找到訂閱者，發送一個 NoSubscriberEvent 事件。

下面詳細分析下關注點（3）的 postSingleEventForEventType 方法：

/*EventBus*/
    private boolean postSingleEventForEventType(Object event, PostingThreadState postingState, Class<?> eventClass) {
        CopyOnWriteArrayList<Subscription> subscriptions;
        synchronized (this) {
            //（1）
            subscriptions = subscriptionsByEventType.get(eventClass);
        }
        if (subscriptions != null && !subscriptions.isEmpty()) {
            for (Subscription subscription : subscriptions) {
                postingState.event = event;
                postingState.subscription = subscription;
                boolean aborted;
                try {
                    //（2）
                    postToSubscription(subscription, event, postingState.isMainThread);
                    aborted = postingState.canceled;
                } finally {
                    postingState.event = null;
                    postingState.subscription = null;
                    postingState.canceled = false;
                }
                if (aborted) {
                    break;
                }
            }
            return true;
        }
        return false;
    }
複製代碼

關注點（1）首先從 subscriptionsByEventType 集合中取出以前註冊的時候保存的 Subscription 集合，而後遍歷集合拿到 Subscription，而後調用關注點（2）中的 postToSubscription 方法。

看下 postToSubscription 方法：

/*EventBus*/
    private void postToSubscription(Subscription subscription, Object event, boolean isMainThread) {
        switch (subscription.subscriberMethod.threadMode) {
            case POSTING:
                invokeSubscriber(subscription, event);
                break;
            case MAIN:
                if (isMainThread) {
                    invokeSubscriber(subscription, event);
                } else {
                    mainThreadPoster.enqueue(subscription, event);
                }
                break;
            case MAIN_ORDERED:
                if (mainThreadPoster != null) {
                    mainThreadPoster.enqueue(subscription, event);
                } else {
                    // temporary: technically not correct as poster not decoupled from subscriber
                    invokeSubscriber(subscription, event);
                }
                break;
            case BACKGROUND:
                if (isMainThread) {
                    backgroundPoster.enqueue(subscription, event);
                } else {
                    invokeSubscriber(subscription, event);
                }
                break;
            case ASYNC:
                asyncPoster.enqueue(subscription, event);
                break;
            default:
                throw new IllegalStateException("Unknown thread mode: " + subscription.subscriberMethod.threadMode);
        }
    }
複製代碼

能夠看到，這裏是經過咱們在註解中設置的線程模式來決定在哪一個線程執行訂閱方法。下面詳細分析下這 5 種線程模式。

POSTING
看一下 invokeSubscriber 方法：

/*EventBus*/
    void invokeSubscriber(Subscription subscription, Object event) {
        try {
            subscription.subscriberMethod.method.invoke(subscription.subscriber, event);
        } catch (InvocationTargetException e) {
            handleSubscriberException(subscription, event, e.getCause());
        } catch (IllegalAccessException e) {
            throw new IllegalStateException("Unexpected exception", e);
        }
    }
複製代碼

直接經過反射調用。發送事件的 post 方法咱們剛剛一路跟下來發現是沒有發生任何線程切換的，所以這裏仍是發送事件所在的線程。因此，若是線程模式是 POSTING，那麼在哪一個線程發送事件，就在哪一個線程執行訂閱方法。

MAIN
這裏首先判斷是否在主線程，在主線程則直接反射調用；不然調用 mainThreadPoster 的 enqueue 方法。咱們在「2.2 註冊」那裏已經分析過 mainThreadPoster 其實是一個 HandlerPoster，因此直接看下 HandlerPoster#enqueue()：

/*HandlerPoster*/
public class HandlerPoster extends Handler implements Poster {

 private final PendingPostQueue queue;

    public void enqueue(Subscription subscription, Object event) {
        //（1）
        PendingPost pendingPost = PendingPost.obtainPendingPost(subscription, event);
        synchronized (this) {
            //（2）
            queue.enqueue(pendingPost);
            if (!handlerActive) {
                handlerActive = true;
                //（3）
                if (!sendMessage(obtainMessage())) {
                    throw new EventBusException("Could not send handler message");
                }
            }
        }
    }
}
複製代碼

源碼中我標記了 3 個關注點，分別以下：

（1）：將 subscription 和 event 封裝成一個 PendingPost 對象。
（2）：將 PendingPost 對象加入到隊列中。
（3）：發送一個消息。由於是繼承的 Handler，因此這裏調用的是 Handler#sendMessage()，這樣 handleMessage 方法天然就能被調用。

咱們看下 handleMessage 方法：

/*HandlerPoster*/
public class HandlerPoster extends Handler implements Poster {

    @Override
    public void handleMessage(Message msg) {
        boolean rescheduled = false;
        try {
            long started = SystemClock.uptimeMillis();
            while (true) {
                //（1）
                PendingPost pendingPost = queue.poll();
    ...
                //（2）
                eventBus.invokeSubscriber(pendingPost);
    ...
            }
        } finally {
            handlerActive = rescheduled;
        }
    }
}
複製代碼

能夠看到，這裏會不斷的從隊列中取出 PendingPost，而後調用 EventBus 的 invokeSubscriber 方法進行處理。

看一下這個方法：

/*EventBus*/
    void invokeSubscriber(PendingPost pendingPost) {
        Object event = pendingPost.event;
        Subscription subscription = pendingPost.subscription;
        PendingPost.releasePendingPost(pendingPost);
        if (subscription.active) {
            invokeSubscriber(subscription, event);
        }
    }

    /*EventBus*/
    void invokeSubscriber(Subscription subscription, Object event) {
        try {
            subscription.subscriberMethod.method.invoke(subscription.subscriber, event);
        } catch (InvocationTargetException e) {
            handleSubscriberException(subscription, event, e.getCause());
        } catch (IllegalAccessException e) {
            throw new IllegalStateException("Unexpected exception", e);
        }
    }
複製代碼

一樣是經過反射調用訂閱方法。因此，若是線程模式是 MAIN，那麼在主線程發送事件，則在主線程執行訂閱方法；不然先將事件加入到隊列中，而後經過 Handler 切換到主線程再執行。

MAIN_ORDERED
mainThreadPoster 不會爲空，因此與 MAIN 同樣是調用了 enqueue 方法，只不過這裏少了線程的判斷。因此，若是線程模式是 MAIN_ORDERED，那麼不管在哪一個線程發送事件，都會先將事件加入到隊列中，而後經過 Handler 切換到主線程再執行。

BACKGROUND
這裏首先判斷是否在主線程，在主線程則調用 backgroundPoster 的 enqueue 方法；不然直接反射調用。咱們直接看下 BackgroundPoster：

/*BackgroundPoster*/
final class BackgroundPoster implements Runnable, Poster {

    ...

    public void enqueue(Subscription subscription, Object event) {
        PendingPost pendingPost = PendingPost.obtainPendingPost(subscription, event);
        synchronized (this) {
            queue.enqueue(pendingPost);
            if (!executorRunning) {
                executorRunning = true;
                //（1）
                eventBus.getExecutorService().execute(this);
            }
        }
    }

    @Override
    public void run() {
        try {
            try {
                while (true) {
                    PendingPost pendingPost = queue.poll(1000);
                    ...
                    eventBus.invokeSubscriber(pendingPost);
                }
            } catch (InterruptedException e) {
                ...
            }
        } finally {
            executorRunning = false;
        }
    }

}
複製代碼

能夠看到，與 MAIN 相似，都是先將 subscription 和 event 封裝成一個 PendingPost 對象，而後加入到隊列中。不一樣的是這裏不是使用 Handler 發送消息，而是經過線程池去執行。因此，若是線程模式是 BACKGROUND，那麼在子線程發送事件，則在子線程執行訂閱方法，不然先將事件加入到隊列中，而後經過線程池去執行。

ASYNC
沒有任何線程判斷，直接看 AsyncPoster：

/*AsyncPoster*/
class AsyncPoster implements Runnable, Poster {

    private final PendingPostQueue queue;
    private final EventBus eventBus;

    AsyncPoster(EventBus eventBus) {
        this.eventBus = eventBus;
        queue = new PendingPostQueue();
    }

    public void enqueue(Subscription subscription, Object event) {
        PendingPost pendingPost = PendingPost.obtainPendingPost(subscription, event);
        queue.enqueue(pendingPost);
        eventBus.getExecutorService().execute(this);
    }

    @Override
    public void run() {
        PendingPost pendingPost = queue.poll();
        if(pendingPost == null) {
            throw new IllegalStateException("No pending post available");
        }
        eventBus.invokeSubscriber(pendingPost);
    }

}
複製代碼

與 BackgroundPoster 同樣。因此，若是線程模式是 ASYNC，那麼不管在哪一個線程發送事件，都會先將事件加入到隊列中，而後經過線程池去執行。

小結
從 subscriptionsByEventType 集合中取出全部訂閱方法，而後根據線程模式判斷是否須要切換線程，不須要則直接經過反射調用訂閱方法；須要則經過 Handler 或線程池切換到指定線程再執行。

2.5 發送粘性事件

看一下發送粘性事件的 postSticky 方法：

/*EventBus*/
    public void postSticky(Object event) {
        synchronized (stickyEvents) {
            stickyEvents.put(event.getClass(), event);
        }
        post(event);
    }
複製代碼

首先將事件保存到 stickyEvents 集合中，而後調用 post 方法發送事件，這個方法與剛剛講的發送事件的方法是如出一轍的，只是這裏最終不會把事件發送出去，具體看下面：
post()——>postSingleEvent()——>postSingleEventForEventType()

/*EventBus*/
    private boolean postSingleEventForEventType(Object event, PostingThreadState postingState, Class<?> eventClass) {
        CopyOnWriteArrayList<Subscription> subscriptions;
        synchronized (this) {
            subscriptions = subscriptionsByEventType.get(eventClass);
        }
        if (subscriptions != null && !subscriptions.isEmpty()) {
             ...
             postToSubscription(subscription, event, postingState.isMainThread);
             ...
        }
        return false;
    }
複製代碼

這裏的 subscriptions 取出來是空的，因此並不會執行 postToSubscription 方法。

那麼怎麼將事件發送出去呢？
咱們一開始就說了「普通事件是先註冊和準備訂閱者，而後再發送事件才能收到。而粘性事件在發送事件以後再註冊和準備訂閱者也能收到事件。」，因此是在註冊的那裏將事件發送出去的，咱們分析註冊的時候省略了粘性事件相關邏輯，如今回去再看看：

/*EventBus*/
    private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
        ...
        if (subscriberMethod.sticky) {
            if (eventInheritance) {
                Set<Map.Entry<Class<?>, Object>> entries = stickyEvents.entrySet();
                for (Map.Entry<Class<?>, 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);
            }
        }
    }
複製代碼

這裏判斷若是是粘性事件，則從 stickyEvents 集合中取出事件，而後調用 checkPostStickyEventToSubscription 方法：

/*EventBus*/
    private void checkPostStickyEventToSubscription(Subscription newSubscription, Object stickyEvent) {
        if (stickyEvent != null) {
            postToSubscription(newSubscription, stickyEvent, isMainThread());
        }
    }
複製代碼

這裏調用的 postToSubscription 方法就是咱們上一節分析過的，也就是根據線程模型決定是否要切換線程執行訂閱方法。

小結
發送粘性事件的的時候，首先會將事件保存到 stickyEvents 集合，等到註冊的時候判斷若是是粘性事件，則從集合中取出事件進行發送。

3、總結

EventBus 源碼相對於 Glide 仍是比較簡單的，可是裏面用到的 ThreadLocal、反射、設計模式等都是值得學習的。最後總結一下面試相關問題，這樣也算是看完這篇博客的收穫了。

（1）介紹一下 EventBus 以及它的優勢
EventBus 是一個 Android 事件發佈/訂閱框架，主要用來簡化 Activity、Fragment、Service、線程等之間的通信。優勢是開銷小、使用簡單、以及解耦事件發送者和接收者。

（2）爲何要使用 EventBus 來替代廣播呢？

廣播：廣播是重量級的，消耗資源較多的方式。若是不作處理也是不安全的。
EventBus：開銷小、使用簡單、以及解耦事件發送者和接收者。

（3）說下 5 種線程模式的區別

POSTING：默認模式，在哪一個線程發送事件，就在哪一個線程執行訂閱方法。
MAIN：若是在主線程發送事件，則在主線程執行訂閱方法；不然先將事件加入到隊列中，而後經過 Handler 切換到主線程再執行。
MAIN_ORDERED：不管在哪一個線程發送事件，都會先將事件加入到隊列中，而後經過 Handler 切換到主線程再執行。
BACKGROUND：若是在子線程發送事件，則在子線程執行訂閱方法，不然先將事件加入到隊列中，而後經過線程池去執行。
ASYNC：不管在哪一個線程發送事件，都會先將事件加入到隊列中，而後經過線程池去執行。

（4）EventBus 是如何作到發送粘性消息的？
發送粘性事件的的時候，首先會將事件保存到 stickyEvents 集合，等到註冊的時候判斷若是是粘性事件，則從集合中取出事件進行發送。

（5）說下 EventBus 的原理

註冊

經過反射獲取註冊類上全部的訂閱方法，而後將這些訂閱方法進行包裝保存到 subscriptionsByEventType 集合。這裏還用 typesBySubscriber 集合保存了事件類型集合，用來判斷某個對象是否註冊過。

解註冊

註冊的時候使用 subscriptionsByEventType 集合保存了全部訂閱方法信息，使用 typesBySubscriber 集合保存了全部事件類型。那麼解註冊的時候就是爲了移除這兩個集合中保存的內容。

發送普通事件

從 subscriptionsByEventType 集合中取出全部訂閱方法，而後根據線程模式判斷是否須要切換線程，不須要則直接經過反射調用訂閱方法；須要則經過 Handler 或線程池切換到指定線程再執行。

發送粘性事件

發送粘性事件的的時候，首先會將事件保存到 stickyEvents 集合，等到註冊的時候判斷若是是粘性事件，則從集合中取出事件進行發送。

關於我

我是 wildma，CSDN 認證博客專家，簡書程序員優秀做者，擅長屏幕適配。若是文章對你有幫助，點個贊就是對我最大的承認！