在這篇文章中，我會(huì)注重分析Android中的EventBus的實(shí)現(xiàn)原理，如果你之前還沒有使用過(guò)該框架，那么可以參考我的另一篇文章來(lái)了解如何使用EventBus：Android EventBus 的使用。
此外，我還分析過(guò)Google的Guava中的EventBus的實(shí)現(xiàn)原理，如果想了解這方面的內(nèi)容可以參考：Guava源碼分析—EventBus。
1、源碼分析
在分析EventBus源碼的時(shí)候，我們先從獲取一個(gè)EventBus實(shí)例的方法入手，然后再分別看一下它的注冊(cè)、取消注冊(cè)、發(fā)布事件以及觸發(fā)觀察方法的代碼是如何實(shí)現(xiàn)的。在下面的文章中我們將會(huì)回答以下幾個(gè)問(wèn)題：
- 在EventBus中，使用
@Subscribe注解的時(shí)候指定的ThreadMode是如何實(shí)現(xiàn)在不同線程間傳遞數(shù)據(jù)的？ - 使用注解和反射的時(shí)候的效率問(wèn)題，是否會(huì)像Guava的EventBus一樣有緩存優(yōu)化？
- 黏性事件是否是通過(guò)內(nèi)部維護(hù)了之前發(fā)布的數(shù)據(jù)來(lái)實(shí)現(xiàn)的，是否使用了緩存？
1.1 獲取實(shí)例
在創(chuàng)建EventBus實(shí)例的時(shí)候，一種方式是按照我們上面的形式，通過(guò)EventBus的靜態(tài)方法getDefault來(lái)獲取一個(gè)實(shí)例。getDefault本身會(huì)調(diào)用其內(nèi)部的構(gòu)造方法，通過(guò)傳入一個(gè)默認(rèn)的EventBusBuilder來(lái)創(chuàng)建EventBus。此外，我們還可以直接通過(guò)EventBus的builder()方法獲取一個(gè)EventBusBuilder的實(shí)例，然后通過(guò)該構(gòu)建者模式來(lái)個(gè)性化地定制自己的EventBus。即：
// 靜態(tài)的單例實(shí)例
static volatile EventBus defaultInstance;
// 默認(rèn)的構(gòu)建者
private static final EventBusBuilder DEFAULT_BUILDER = new EventBusBuilder();
// 實(shí)際上使用了DCL雙檢鎖機(jī)制，這里簡(jiǎn)化了一下
public static EventBus getDefault() {
if (defaultInstance == null) defaultInstance = new EventBus();
return defaultInstance;
}
public EventBus() {
this(DEFAULT_BUILDER);
}
// 調(diào)用getDefault的時(shí)候，最終會(huì)調(diào)用該方法，使用DEFAULT_BUILDER創(chuàng)建一個(gè)實(shí)例
EventBus(EventBusBuilder builder) {
// ...
}
// 也可以使用下面的方法獲取一個(gè)構(gòu)建者，然后使用它來(lái)個(gè)性化定制EventBus
public static EventBusBuilder builder() {
return new EventBusBuilder();
}
1.2 注冊(cè)
當(dāng)調(diào)用EventBus實(shí)例的register方法的時(shí)候，會(huì)執(zhí)行下面的邏輯：
public void register(Object subscriber) {
// 首席會(huì)獲取注冊(cè)的對(duì)象的類型
Class<?> subscriberClass = subscriber.getClass();
// 然后獲取注冊(cè)的對(duì)象的訂閱方法
List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
// 對(duì)當(dāng)前實(shí)例加鎖，并不斷執(zhí)行監(jiān)聽的邏輯
synchronized (this) {
for (SubscriberMethod subscriberMethod : subscriberMethods) {
// 對(duì)訂閱方法進(jìn)行注冊(cè)
subscribe(subscriber, subscriberMethod);
}
}
}
這里的SubscriberMethod封裝了訂閱方法（使用@Subscribe注解的方法）類型的信息，它的定義如下所示。從下面可以的代碼中我們可以看出，實(shí)際上該類就是通過(guò)幾個(gè)字段來(lái)存儲(chǔ)@Subscribe注解中指定的類型信息，以及一個(gè)方法的類型變量。
public class SubscriberMethod {
final Method method;
final ThreadMode threadMode;
final Class<?> eventType;
final int priority;
final boolean sticky;
// ...
}
register方法通過(guò)subscriberMethodFinder實(shí)例的findSubscriberMethods方法來(lái)獲取該觀察者類型中的所有訂閱方法，然后將所有的訂閱方法分別進(jìn)行訂閱。下面我們先看下查找訂閱者的方法。
查找訂閱者的訂閱方法
下面是SubscriberMethodFinder中的findSubscriberMethods方法：
List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {
// 這里首先從緩存當(dāng)中嘗試去取該訂閱者的訂閱方法
List<SubscriberMethod> subscriberMethods = METHOD_CACHE.get(subscriberClass);
if (subscriberMethods != null) {
return subscriberMethods;
}
// 當(dāng)緩存中沒有找到該觀察者的訂閱方法的時(shí)候使用下面的兩種方法獲取方法信息
if (ignoreGeneratedIndex) {
subscriberMethods = findUsingReflection(subscriberClass);
} else {
subscriberMethods = findUsingInfo(subscriberClass);
}
if (subscriberMethods.isEmpty()) {
throw new EventBusException(...);
} else {
// 將獲取到的訂閱方法放置到緩存當(dāng)中
METHOD_CACHE.put(subscriberClass, subscriberMethods);
return subscriberMethods;
}
}
這里我們先從緩存當(dāng)中嘗試獲取某個(gè)觀察者中的所有訂閱方法，如果沒有可用緩存的話就從該類中查找訂閱方法，并在返回結(jié)果之前將這些方法信息放置到緩存當(dāng)中。這里的ignoreGeneratedIndex參數(shù)表示是否忽略注解器生成的MyEventBusIndex，該值默認(rèn)為false。然后，我們會(huì)進(jìn)入到下面的方法中獲取訂閱方法信息：
private List<SubscriberMethod> findUsingInfo(Class<?> subscriberClass) {
// 這里通過(guò)FindState對(duì)象來(lái)存儲(chǔ)找到的方法信息
FindState findState = prepareFindState();
findState.initForSubscriber(subscriberClass);
// 這里是一個(gè)循環(huán)操作，會(huì)從當(dāng)前類開始遍歷該類的所有父類
while (findState.clazz != null) {
// 獲取訂閱者信息
findState.subscriberInfo = getSubscriberInfo(findState); // 1
if (findState.subscriberInfo != null) {
// 如果使用了MyEventBusIndex，將會(huì)進(jìn)入到這里并獲取訂閱方法信息
SubscriberMethod[] array = findState.subscriberInfo.getSubscriberMethods();
for (SubscriberMethod subscriberMethod : array) {
if (findState.checkAdd(subscriberMethod.method, subscriberMethod.eventType)) {
findState.subscriberMethods.add(subscriberMethod);
}
}
} else {
// 未使用MyEventBusIndex將會(huì)進(jìn)入這里使用反射獲取方法信息
findUsingReflectionInSingleClass(findState); // 2
}
// 將findState.clazz設(shè)置為當(dāng)前的findState.clazz的父類
findState.moveToSuperclass();
}
return getMethodsAndRelease(findState);
}
在上面的代碼中，會(huì)從當(dāng)前訂閱者類開始直到它最頂層的父類進(jìn)行遍歷來(lái)獲取訂閱方法信息。這里在循環(huán)的內(nèi)部會(huì)根據(jù)我們是否使用了MyEventBusIndex走兩條路線，對(duì)于我們沒有使用它的，會(huì)直接使用反射來(lái)獲取訂閱方法信息，即進(jìn)入2處。
下面是使用反射從訂閱者中得到訂閱方法的代碼：
private void findUsingReflectionInSingleClass(FindState findState) {
Method[] methods;
try {
// 獲取該類中聲明的所有方法
methods = findState.clazz.getDeclaredMethods();
} catch (Throwable th) {
methods = findState.clazz.getMethods();
findState.skipSuperClasses = true;
}
// 對(duì)方法進(jìn)行遍歷判斷
for (Method method : methods) {
int modifiers = method.getModifiers();
// 這里會(huì)對(duì)方法的修飾符進(jìn)行校驗(yàn)
if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {
// 這里對(duì)方法的輸入?yún)?shù)進(jìn)行校驗(yàn)
Class<?>[] parameterTypes = method.getParameterTypes();
if (parameterTypes.length == 1) {
// 獲取方法的注解，用來(lái)從注解中獲取注解的聲明信息
Subscribe subscribeAnnotation = method.getAnnotation(Subscribe.class);
if (subscribeAnnotation != null) {
// 獲取該方法的第一個(gè)參數(shù)
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(...);
}
} else if (strictMethodVerification && method.isAnnotationPresent(Subscribe.class)) {
String methodName = method.getDeclaringClass().getName() + "." + method.getName();
throw new EventBusException(...);
}
}
}
這里會(huì)對(duì)當(dāng)前類中聲明的所有方法進(jìn)行校驗(yàn)，并將符合要求的方法的信息封裝成一個(gè)SubscriberMethod對(duì)象塞到列表中。
注冊(cè)訂閱方法
直到了如何拿到所有的訂閱方法之后，我們回到之前的代碼，看下訂閱過(guò)程中的邏輯：
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
Class<?> eventType = subscriberMethod.eventType;
// 將所有的觀察者和訂閱方法封裝成一個(gè)Subscription對(duì)象
Subscription newSubscription = new Subscription(subscriber, subscriberMethod); // 1
// 嘗試從緩存中根據(jù)事件類型來(lái)獲取所有的Subscription對(duì)象
CopyOnWriteArrayList<Subscription> subscriptions = subscriptionsByEventType.get(eventType); // 2
if (subscriptions == null) {
// 指定的事件類型沒有對(duì)應(yīng)的觀察對(duì)象的時(shí)候
subscriptions = new CopyOnWriteArrayList<>();
subscriptionsByEventType.put(eventType, subscriptions);
} else {
if (subscriptions.contains(newSubscription)) {
throw new EventBusException(...);
}
}
// 這里會(huì)根據(jù)新加入的方法的優(yōu)先級(jí)決定插入到隊(duì)列中的位置
int size = subscriptions.size(); // 2
for (int i = 0; i <= size; i++) {
if (i == size || subscriberMethod.priority > subscriptions.get(i).subscriberMethod.priority) {
subscriptions.add(i, newSubscription);
break;
}
}
// 這里又會(huì)從“訂閱者-事件類型”列表中嘗試獲取該訂閱者對(duì)應(yīng)的所有事件類型
List<Class<?>> subscribedEvents = typesBySubscriber.get(subscriber); // 3
if (subscribedEvents == null) {
subscribedEvents = new ArrayList<>();
typesBySubscriber.put(subscriber, subscribedEvents);
}
subscribedEvents.add(eventType);
// 如果是黏性事件還要進(jìn)行如下的處理
if (subscriberMethod.sticky) { // 4
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();
// 這里會(huì)向該觀察者通知所有的黏性事件
checkPostStickyEventToSubscription(newSubscription, stickyEvent);
}
}
} else {
Object stickyEvent = stickyEvents.get(eventType);
checkPostStickyEventToSubscription(newSubscription, stickyEvent);
}
}
}
這里涉及到了幾個(gè)集合，它們是用來(lái)做緩存的，還有就是來(lái)維護(hù)觀察者、事件類型和訂閱方法之間的關(guān)系的。注冊(cè)觀察的方法比較長(zhǎng)，我們可以一點(diǎn)一點(diǎn)來(lái)看。首先，會(huì)在代碼1處將觀察者和訂閱方法封裝成一個(gè)Subscription對(duì)象。然后，在2處用到了CopyOnWriteArrayList這個(gè)集合，它是一種適用于多讀寫少場(chǎng)景的數(shù)據(jù)結(jié)構(gòu)，是一種線程安全的數(shù)組型的數(shù)據(jù)結(jié)構(gòu)，主要用來(lái)存儲(chǔ)一個(gè)事件類型所對(duì)應(yīng)的全部的Subscription對(duì)象。EventBus在這里通過(guò)一個(gè)Map<Class<?>, CopyOnWriteArrayList<Subscription>>類型的哈希表來(lái)維護(hù)這個(gè)映射關(guān)系。然后，我們的程序執(zhí)行到2處，在這里會(huì)對(duì)Subscription對(duì)象的列表進(jìn)行遍歷，并根據(jù)訂閱方法的優(yōu)先級(jí)，為當(dāng)前的Subscription對(duì)象尋找一個(gè)合適的位置。3的地方主要的邏輯是獲取指定的觀察者對(duì)應(yīng)的全部的觀察事件類型，這里也是通過(guò)一個(gè)哈希表來(lái)維護(hù)這種映射關(guān)系的。然后，在代碼4處，程序會(huì)根據(jù)當(dāng)前的訂閱方法是否是黏性的，來(lái)決定是否將當(dāng)前緩存中的信息發(fā)送給新訂閱的方法。這里會(huì)通過(guò)checkPostStickyEventToSubscription方法來(lái)發(fā)送信息，它內(nèi)部的實(shí)現(xiàn)的邏輯和post方法類似，我們不再進(jìn)行說(shuō)明。
取消注冊(cè)的邏輯比較比較簡(jiǎn)單，基本上就是注冊(cè)操作反過(guò)來(lái)——將當(dāng)前訂閱方法的信息從緩存中踢出來(lái)，我們不再進(jìn)行分分析。下面我們分析另一個(gè)比較重要的地方，即發(fā)送事件相關(guān)的邏輯。
1.3 通知
通知的邏輯相對(duì)來(lái)說(shuō)會(huì)比較復(fù)雜一些，因?yàn)檫@里面涉及一些線程之間的操作。我們看下下面的代碼吧：
public void post(Object event) {
// 這里從線程局部變量中取出當(dāng)前線程的狀態(tài)信息
PostingThreadState postingState = currentPostingThreadState.get();
// 這里是以上線程局部變量?jī)?nèi)部維護(hù)的一個(gè)事件隊(duì)列
List<Object> eventQueue = postingState.eventQueue;
// 將當(dāng)前要發(fā)送的事件加入到隊(duì)列中
eventQueue.add(event);
if (!postingState.isPosting) {
postingState.isMainThread = isMainThread();
postingState.isPosting = true;
if (postingState.canceled) {
throw new EventBusException("Internal error. Abort state was not reset");
}
try {
// 不斷循環(huán)來(lái)發(fā)送事件
while (!eventQueue.isEmpty()) {
postSingleEvent(eventQueue.remove(0), postingState); // 1
}
} finally {
// 恢復(fù)當(dāng)前線程的信息
postingState.isPosting = false;
postingState.isMainThread = false;
}
}
}
這里的currentPostingThreadState是一個(gè)ThreadLocal類型的變量，其中存儲(chǔ)了對(duì)應(yīng)于當(dāng)前線程的PostingThreadState對(duì)象，該對(duì)象中存儲(chǔ)了當(dāng)前線程對(duì)應(yīng)的事件列表和線程的狀態(tài)信息等。從上面的代碼中可以看出，post方法會(huì)在1處不斷從當(dāng)前線程對(duì)應(yīng)的隊(duì)列中取出事件并進(jìn)行發(fā)布。下面我們看以下這里的postSingleEvent方法。
private void postSingleEvent(Object event, PostingThreadState postingState) throws Error {
Class<?> eventClass = event.getClass();
boolean subscriptionFound = false;
if (eventInheritance) {
// 這里向上查找該事件的所有父類
List<Class<?>> eventTypes = lookupAllEventTypes(eventClass);
int countTypes = eventTypes.size();
for (int h = 0; h < countTypes; h++) {
Class<?> clazz = eventTypes.get(h);
// 對(duì)上面的事件進(jìn)行處理
subscriptionFound |= postSingleEventForEventType(event, postingState, clazz);
}
} else {
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) {
post(new NoSubscriberEvent(this, event));
}
}
}
在上面的代碼中，我們會(huì)根據(jù)eventInheritance的值決定是否要同時(shí)遍歷當(dāng)前事件的所有父類的事件信息并進(jìn)行分發(fā)。如果設(shè)置為true就將執(zhí)行這一操作，并最終使用postSingleEventForEventType對(duì)每個(gè)事件類型進(jìn)行處理。
private boolean postSingleEventForEventType(Object event, PostingThreadState postingState, Class<?> eventClass) {
// 獲取指定的事件對(duì)應(yīng)的所有的觀察對(duì)象
CopyOnWriteArrayList<Subscription> subscriptions;
synchronized (this) {
subscriptions = subscriptionsByEventType.get(eventClass);
}
if (subscriptions != null && !subscriptions.isEmpty()) {
// 遍歷觀察對(duì)象，并最終執(zhí)行事件的分發(fā)操作
for (Subscription subscription : subscriptions) {
postingState.event = event;
postingState.subscription = subscription;
boolean aborted = false;
try {
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;
}
在上面的代碼中，我們會(huì)通過(guò)傳入的事件類型到緩存中取尋找它對(duì)應(yīng)的全部的Subscription，然后對(duì)得到的Subscription列表進(jìn)行遍歷，并依次調(diào)用postToSubscription方法執(zhí)行事件的發(fā)布操作。下面是postToSubscription方法的代碼，這里我們會(huì)根據(jù)訂閱方法指定的threadMode信息來(lái)執(zhí)行不同的發(fā)布策略。
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 {
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(...);
}
}
在上面的方法中，會(huì)根據(jù)當(dāng)前的線程狀態(tài)和訂閱方法指定的threadMode信息來(lái)決定合適觸發(fā)方法。這里的invokeSubscriber會(huì)在當(dāng)前線程中立即調(diào)用反射來(lái)觸發(fā)指定的觀察者的訂閱方法。否則會(huì)根據(jù)具體的情況將事件加入到不同的隊(duì)列中進(jìn)行處理。這里的mainThreadPoster最終繼承自Handler，當(dāng)調(diào)用它的enqueue方法的時(shí)候，它會(huì)發(fā)送一個(gè)事件并在它自身的handleMessage方法中從隊(duì)列中取值并進(jìn)行處理，從而達(dá)到在主線程中分發(fā)事件的目的。這里的backgroundPoster實(shí)現(xiàn)了Runnable接口，它會(huì)在調(diào)用enqueue方法的時(shí)候，拿到EventBus的ExecutorService實(shí)例，并使用它來(lái)執(zhí)行自己。在它的run方法中會(huì)從隊(duì)列中不斷取值來(lái)進(jìn)行執(zhí)行。
總結(jié)
以上就是Android中的EventBus的源碼分析，這里我們回答之前提出的幾個(gè)問(wèn)題來(lái)作結(jié)：
- 在EventBus中，使用
@Subscribe注解的時(shí)候指定的ThreadMode是如何實(shí)現(xiàn)在不同線程間傳遞數(shù)據(jù)的？
要求主線程中的事件通過(guò)Handler來(lái)實(shí)現(xiàn)在主線程中執(zhí)行，非主線程的方法會(huì)使用EventBus內(nèi)部的ExecutorService來(lái)執(zhí)行。實(shí)際在觸發(fā)方法的時(shí)候會(huì)根據(jù)當(dāng)前線程的狀態(tài)和訂閱方法的ThreadMode指定的線程狀態(tài)來(lái)決定何時(shí)觸發(fā)方法。非主線程的邏輯會(huì)在post的時(shí)候加入到一個(gè)隊(duì)列中被隨后執(zhí)行。
- 使用注解和反射的時(shí)候的效率問(wèn)題，是否會(huì)像Guava的EventBus一樣有緩存優(yōu)化？
內(nèi)部使用了緩存，確切來(lái)說(shuō)就是維護(hù)了一些映射的關(guān)系。但是它的緩存沒有像Guava一樣使用軟引用之類方式進(jìn)行優(yōu)化，即一直是強(qiáng)引用類型的。
- 黏性事件是否是通過(guò)內(nèi)部維護(hù)了之前發(fā)布的數(shù)據(jù)來(lái)實(shí)現(xiàn)的，是否使用了緩存？
黏性事件會(huì)通過(guò)EventBus內(nèi)部維護(hù)的一個(gè)事件類型-黏性事件的哈希表存儲(chǔ)，當(dāng)注冊(cè)一個(gè)觀察者的時(shí)候，如果發(fā)現(xiàn)了它內(nèi)部有黏性事件監(jiān)聽，會(huì)執(zhí)行post類似的邏輯將事件立即發(fā)送給該觀察者。
獲取更多技術(shù)文章可以直接關(guān)注我的公眾號(hào)「Hello 開發(fā)者」，另外感興趣的可以加入技術(shù) QQ 交流群：1018235573.
以上，感謝閱讀～
