Androidイベントバス(二)EventBus 3.0ソース解析
28278 ワード
関連記事Androidイベントバス(一)EventBus 3.0用法全解析
前言
前回はEventBus 3についてお話ししました.0の使い方、この記事でEventBus 3についてお話しします.0のソースコードとそのメリットとデメリット.
1.コンストラクタ
イベントを登録したり送信したりするなど、EventBusの機能を呼び出すと、常にEventBusが呼び出されます.getDefault()を使用してEventBusインスタンスを取得します.
明らかにこれは単例モードで、二重検査モード(DCL)を採用しており、知らない学生は設計モード(二)単例モードの7つの書き方を見ることができます.次にnew EventBus()が何をしたかを見てみましょう.
ここDEFAULT_BUILDERはデフォルトのEventBusBuilderであり、EventBusを構築するために使用されます.
これはEventBusの別のコンストラクション関数を呼び出します.
2.購読者登録
EventBusを取得すると、購読者をEventBusに登録できます.registerメソッドを見てみましょう.
購読メソッドの検索
findSubscriberMethodsは、SubscriberMethodの集合、すなわち、転送された購読者のすべての購読方法を見つけ、次に購読者の購読方法を遍歴して購読者の購読操作を完了する.SubscriberMethodクラスでは、主にサブスクリプションメソッドを保存するMethodオブジェクト、スレッド・モード、イベント・タイプ、優先度、スティッキー・イベントかどうかなどのプロパティが使用されます.次にfindSubscriberMethodsメソッドを見てみましょう.
まずキャッシュから検索し、見つけたらすぐに戻ります.キャッシュにない場合は、ignoreGeneratedIndexに従って購読メソッドを検索する方法を選択します.ignoreGeneratedIndexプロパティは、注釈器によって生成されたMyEventBusIndexを無視するかどうかを示します.MyEventBusIndexを知らない学生は【Bugly干物分かち合い】ベテランドライバーが「暴れ」EventBus 3を教えてくれた文章を見ることができます.最後に、サブスクリプションメソッドが見つかったら、次回検索を続行しないようにキャッシュを入れます.ignoreGeneratedIndexのデフォルトはfalseであり、EventBusBuilderで値を設定できます.プロジェクトでは、findUsingInfoメソッドを呼び出すEventBus単一モードによってデフォルトのEventBusオブジェクト、すなわちignoreGeneratedIndexがfalseである場合によく使用されます.
getSubscriberInfoメソッドで購読者情報を取得します.サブスクリプションメソッドの検索を開始すると、注釈器が生成したインデックスMyEventBusIndexは無視されません.EventBusBuilderでMyEventBusIndexを構成すると、subscriberInfoが取得され、subscriberInfoのgetSubscriberMethodsメソッドを呼び出すことでサブスクリプションメソッドに関する情報が得られます.この場合、サブスクリプションによるサブスクリプションメソッドの取得は必要ありません.MyEventBusIndexが構成されていない場合、findUsingReflectionInSingleClassメソッドが実行され、購読メソッドがfindStateに保存されます.最後にgetMethodsAndReleaseメソッドによりfindStateを回収処理し,サブスクリプションメソッドのリストセットに戻す.MyEventBusIndexの構成はオプションですので、ここでは詳しく説明しません.findUsingReflectionInSingleClassの実行手順を見てみましょう.
ここでは主にJavaの反射と注釈の解析を用いた.まず,反射によりサブスクライバ内のすべての方法を取得する.メソッドのタイプ、パラメータ、注釈に基づいてサブスクリプションメソッドを見つけます.購読方法が見つかったら、購読方法に関する情報をFindStateに保存します.
購読者の登録プロセス
すべての購読メソッドを検索した後、すべての購読メソッドの登録を開始します.
サブスクリプションのコードは主に2つのことをしました.1つ目は、私たちのサブスクリプション方法とサブスクリプションをsubscriptionsByEventTypeとtypesBySubscriberにカプセル化することです.subscriptionsByEventTypeは私たちがサブスクリプションイベントを配達するとき、私たちのEventTypeに基づいて私たちのサブスクリプションイベントを見つけて、それによってイベントを配布し、イベントを処理します.typesBySubscriberは、unregister(this)を呼び出すと、購読者によってEventTypeが見つかり、EventTypeによって購読イベントが見つかり、購読者を解縛する.2つ目は、粘り強いイベントであれば、すぐに配達、実行します.
3.イベントの送信
EventBusオブジェクトを取得した後、postメソッドでイベントのコミットを行うことができます.
まず、PostingThreadStateオブジェクトからイベントキューを取り出し、現在のイベントをイベントキューに挿入します.最後に、キュー内のイベントをpostSingleEventメソッドで順次処理し、イベントを削除します.postSingleEventメソッドで何をしたか見てみましょう.
eventInheritanceは、イベントの親を上に検索するかどうかを示します.デフォルト値はtrueで、EventBusBuilderで構成できます.eventInheritanceがtrueの場合、lookupAllEventTypeによってすべての親イベントがリストに存在し、postSingleEventForEventTypeメソッドによってイベントが1つずつ処理されます.次にpostSingleEventForEventTypeメソッドを参照してください.
イベントに対応するSubscriptionのセットを同期して取り出し、イベントイベントイベントと対応するSubscriptionをpostingStateに渡し、postToSubscriptionメソッドを呼び出してイベントを処理します.次に、postToSubscriptionメソッドを参照してください.
サブスクリプションメソッドのスレッドモードを取り出し,その後スレッドモードに従ってそれぞれ処理する.たとえば、スレッドモードがMAINで、コミットイベントのスレッドがメインスレッドであれば反射して直接サブスクリプションを実行する方法であり、メインスレッドでなければmainThreadPosterがサブスクリプションイベントをキューに入れる必要があり、mainThreadPosterはHandlerPosterクラス型の継承がHandlerから、Handlerによってサブスクリプションメソッドをメインスレッド実行に切り替える必要がある.
4.購読者登録を取り消す
typesBySubscriber私たちは購読者登録の過程でこの属性について話したことがあります.彼は購読者によってEventTypeを見つけ、EventTypeと購読者によって購読イベントを得て購読者を解縛します.
5.コアアーキテクチャとメリットとデメリット
コアアーキテクチャ
EventBusの著者らが提供した図から,EventBusのコアアーキテクチャは,実際には観察者モードに基づいて実現され,観察者モードについては設計モード(5)観察者モードを見ることができるという文章を見ることができる.
メリットとデメリット
EventBusのメリットは明らかで、ビジネスとビューを分離し、コードの実現が容易です.さらに3.0後,aptプリコンパイルによりサブスクライバを見つけることができ,実行中の反射処理解析を回避し,効率を大幅に向上させた.もちろんEventBusもいくつかの隠れた危険性と弊害をもたらし、乱用すれば論理の分散を招き、維持の困難をもたらす.またEventBusコードを大量に採用しても可読性が悪くなります.
参考資料EventBus 3.0ソースEventBus 3.0ソース解析EventBusのメリットとデメリットとソース解析EventBus 3.0ソース解読【Bugly干物分かち合い】ベテランドライバーが教えてくれた「暴れ」EventBus 3
前言
前回はEventBus 3についてお話ししました.0の使い方、この記事でEventBus 3についてお話しします.0のソースコードとそのメリットとデメリット.
1.コンストラクタ
イベントを登録したり送信したりするなど、EventBusの機能を呼び出すと、常にEventBusが呼び出されます.getDefault()を使用してEventBusインスタンスを取得します.
public static EventBus getDefault() {
if (defaultInstance == null) {
synchronized (EventBus.class) {
if (defaultInstance == null) {
defaultInstance = new EventBus();
}
}
}
return defaultInstance;
}明らかにこれは単例モードで、二重検査モード(DCL)を採用しており、知らない学生は設計モード(二)単例モードの7つの書き方を見ることができます.次にnew EventBus()が何をしたかを見てみましょう.
public EventBus() {
this(DEFAULT_BUILDER);
}ここDEFAULT_BUILDERはデフォルトのEventBusBuilderであり、EventBusを構築するために使用されます.
private static final EventBusBuilder DEFAULT_BUILDER = new EventBusBuilder();これはEventBusの別のコンストラクション関数を呼び出します.
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 = 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;
}2.購読者登録
EventBusを取得すると、購読者をEventBusに登録できます.registerメソッドを見てみましょう.
public void register(Object subscriber) {
Class<?> subscriberClass = subscriber.getClass();
// subscriberMethodFinder ， subscriber 。
List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
synchronized (this) {
for (SubscriberMethod subscriberMethod : subscriberMethods) {
subscribe(subscriber, subscriberMethod);
}
}
}購読メソッドの検索
findSubscriberMethodsは、SubscriberMethodの集合、すなわち、転送された購読者のすべての購読方法を見つけ、次に購読者の購読方法を遍歴して購読者の購読操作を完了する.SubscriberMethodクラスでは、主にサブスクリプションメソッドを保存するMethodオブジェクト、スレッド・モード、イベント・タイプ、優先度、スティッキー・イベントかどうかなどのプロパティが使用されます.次にfindSubscriberMethodsメソッドを見てみましょう.
List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {
// SubscriberMethod
List<SubscriberMethod> subscriberMethods = METHOD_CACHE.get(subscriberClass);
if (subscriberMethods != null) {
return subscriberMethods;
}
//ignoreGeneratedIndex MyEventBusIndex
if (ignoreGeneratedIndex) {
// subscriberMethods
subscriberMethods = findUsingReflection(subscriberClass);
} else {
subscriberMethods = findUsingInfo(subscriberClass);
}
// subscriberMethods ， @Subscribe public ， 。
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;
}
}まずキャッシュから検索し、見つけたらすぐに戻ります.キャッシュにない場合は、ignoreGeneratedIndexに従って購読メソッドを検索する方法を選択します.ignoreGeneratedIndexプロパティは、注釈器によって生成されたMyEventBusIndexを無視するかどうかを示します.MyEventBusIndexを知らない学生は【Bugly干物分かち合い】ベテランドライバーが「暴れ」EventBus 3を教えてくれた文章を見ることができます.最後に、サブスクリプションメソッドが見つかったら、次回検索を続行しないようにキャッシュを入れます.ignoreGeneratedIndexのデフォルトはfalseであり、EventBusBuilderで値を設定できます.プロジェクトでは、findUsingInfoメソッドを呼び出すEventBus単一モードによってデフォルトのEventBusオブジェクト、すなわちignoreGeneratedIndexがfalseである場合によく使用されます.
private List<SubscriberMethod> findUsingInfo(Class<?> subscriberClass) {
FindState findState = prepareFindState();
findState.initForSubscriber(subscriberClass);
while (findState.clazz != null) {
// ， MyEventBusIndex 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 {
//
findUsingReflectionInSingleClass(findState);
}
findState.moveToSuperclass();
}
return getMethodsAndRelease(findState);
}getSubscriberInfoメソッドで購読者情報を取得します.サブスクリプションメソッドの検索を開始すると、注釈器が生成したインデックスMyEventBusIndexは無視されません.EventBusBuilderでMyEventBusIndexを構成すると、subscriberInfoが取得され、subscriberInfoのgetSubscriberMethodsメソッドを呼び出すことでサブスクリプションメソッドに関する情報が得られます.この場合、サブスクリプションによるサブスクリプションメソッドの取得は必要ありません.MyEventBusIndexが構成されていない場合、findUsingReflectionInSingleClassメソッドが実行され、購読メソッドがfindStateに保存されます.最後にgetMethodsAndReleaseメソッドによりfindStateを回収処理し,サブスクリプションメソッドのリストセットに戻す.MyEventBusIndexの構成はオプションですので、ここでは詳しく説明しません.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 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()));
}
}
} 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");
}
}
}ここでは主にJavaの反射と注釈の解析を用いた.まず,反射によりサブスクライバ内のすべての方法を取得する.メソッドのタイプ、パラメータ、注釈に基づいてサブスクリプションメソッドを見つけます.購読方法が見つかったら、購読方法に関する情報をFindStateに保存します.
購読者の登録プロセス
すべての購読メソッドを検索した後、すべての購読メソッドの登録を開始します.
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
Class<?> eventType = subscriberMethod.eventType;
//
Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
// Subscription List
CopyOnWriteArrayList<Subscription> subscriptions = subscriptionsByEventType.get(eventType);
// Subscription List ， subscriptionsByEventType
if (subscriptions == null) {
subscriptions = new CopyOnWriteArrayList<>();
subscriptionsByEventType.put(eventType, subscriptions);
} else {
// EventBusException
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;
}
}
//
List<Class<?>> subscribedEvents = typesBySubscriber.get(subscriber);
if (subscribedEvents == null) {
subscribedEvents = new ArrayList<>();
typesBySubscriber.put(subscriber, subscribedEvents);
}
// subscribedEvents
subscribedEvents.add(eventType);
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);
}
}
}サブスクリプションのコードは主に2つのことをしました.1つ目は、私たちのサブスクリプション方法とサブスクリプションをsubscriptionsByEventTypeとtypesBySubscriberにカプセル化することです.subscriptionsByEventTypeは私たちがサブスクリプションイベントを配達するとき、私たちのEventTypeに基づいて私たちのサブスクリプションイベントを見つけて、それによってイベントを配布し、イベントを処理します.typesBySubscriberは、unregister(this)を呼び出すと、購読者によってEventTypeが見つかり、EventTypeによって購読イベントが見つかり、購読者を解縛する.2つ目は、粘り強いイベントであれば、すぐに配達、実行します.
3.イベントの送信
EventBusオブジェクトを取得した後、postメソッドでイベントのコミットを行うことができます.
public void post(Object event) {
//PostingThreadState
PostingThreadState postingState = currentPostingThreadState.get();
// ，
List<Object> eventQueue = postingState.eventQueue;
eventQueue.add(event);
if (!postingState.isPosting) {
postingState.isMainThread = Looper.getMainLooper() == Looper.myLooper();
postingState.isPosting = true;
if (postingState.canceled) {
throw new EventBusException("Internal error. Abort state was not reset");
}
try {
//
while (!eventQueue.isEmpty()) {
postSingleEvent(eventQueue.remove(0), postingState);
}
} finally {
postingState.isPosting = false;
postingState.isMainThread = false;
}
}
}まず、PostingThreadStateオブジェクトからイベントキューを取り出し、現在のイベントをイベントキューに挿入します.最後に、キュー内のイベントをpostSingleEventメソッドで順次処理し、イベントを削除します.postSingleEventメソッドで何をしたか見てみましょう.
private void postSingleEvent(Object event, PostingThreadState postingState) throws Error {
Class<?> eventClass = event.getClass();
boolean subscriptionFound = false;
//eventInheritance , true
if (eventInheritance) {
List<Class<?>> eventTypes = lookupAllEventTypes(eventClass);
int countTypes = eventTypes.size();
for (int h = 0; h < countTypes; h++) {
Class<?> clazz = eventTypes.get(h);
subscriptionFound |= postSingleEventForEventType(event, postingState, clazz);
}
} else {
subscriptionFound = postSingleEventForEventType(event, postingState, eventClass);
}
//
if (!subscriptionFound) {
if (logNoSubscriberMessages) {
Log.d(TAG, "No subscribers registered for event " + eventClass);
}
if (sendNoSubscriberEvent && eventClass != NoSubscriberEvent.class &&
eventClass != SubscriberExceptionEvent.class) {
post(new NoSubscriberEvent(this, event));
}
}
}eventInheritanceは、イベントの親を上に検索するかどうかを示します.デフォルト値はtrueで、EventBusBuilderで構成できます.eventInheritanceがtrueの場合、lookupAllEventTypeによってすべての親イベントがリストに存在し、postSingleEventForEventTypeメソッドによってイベントが1つずつ処理されます.次にpostSingleEventForEventTypeメソッドを参照してください.
private boolean postSingleEventForEventType(Object event, PostingThreadState postingState, Class<?> eventClass) {
CopyOnWriteArrayList<Subscription> subscriptions;
// Subscription
synchronized (this) {
subscriptions = subscriptionsByEventType.get(eventClass);
}
if (subscriptions != null && !subscriptions.isEmpty()) {
// event Subscription （ ） postingState
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;
}イベントに対応するSubscriptionのセットを同期して取り出し、イベントイベントイベントと対応するSubscriptionをpostingStateに渡し、postToSubscriptionメソッドを呼び出してイベントを処理します.次に、postToSubscriptionメソッドを参照してください.
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 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);
}
}サブスクリプションメソッドのスレッドモードを取り出し,その後スレッドモードに従ってそれぞれ処理する.たとえば、スレッドモードがMAINで、コミットイベントのスレッドがメインスレッドであれば反射して直接サブスクリプションを実行する方法であり、メインスレッドでなければmainThreadPosterがサブスクリプションイベントをキューに入れる必要があり、mainThreadPosterはHandlerPosterクラス型の継承がHandlerから、Handlerによってサブスクリプションメソッドをメインスレッド実行に切り替える必要がある.
4.購読者登録を取り消す
public synchronized void unregister(Object subscriber) {
List<Class<?>> 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());
}
}typesBySubscriber私たちは購読者登録の過程でこの属性について話したことがあります.彼は購読者によってEventTypeを見つけ、EventTypeと購読者によって購読イベントを得て購読者を解縛します.
5.コアアーキテクチャとメリットとデメリット
コアアーキテクチャ
EventBusの著者らが提供した図から,EventBusのコアアーキテクチャは,実際には観察者モードに基づいて実現され,観察者モードについては設計モード(5)観察者モードを見ることができるという文章を見ることができる.
メリットとデメリット
EventBusのメリットは明らかで、ビジネスとビューを分離し、コードの実現が容易です.さらに3.0後,aptプリコンパイルによりサブスクライバを見つけることができ,実行中の反射処理解析を回避し,効率を大幅に向上させた.もちろんEventBusもいくつかの隠れた危険性と弊害をもたらし、乱用すれば論理の分散を招き、維持の困難をもたらす.またEventBusコードを大量に採用しても可読性が悪くなります.
参考資料EventBus 3.0ソースEventBus 3.0ソース解析EventBusのメリットとデメリットとソース解析EventBus 3.0ソース解読【Bugly干物分かち合い】ベテランドライバーが教えてくれた「暴れ」EventBus 3