核心方法

EventBus一些重要方法解釋如下：

• post(Object)：Posts an event to all registered subscribers. This method will return successfully after the event has been posted to all subscribers, and regardless of any exceptions thrown by subscribers.

• register(Object): Registers all subscriber methods on object to receive events.Subscriber methods are selected and classified using this EventBus's SubscriberFindingStrategy; the default strategy is the AnnotatedSubscriberFinder.

• unregister(Object)：Unregisters all subscriber methods on a registered object.

原始碼分析

主要分析釋出事件以及訂閱的核心原始碼；

釋出原始碼分析

public void post(Object event) {
    // 得到所有該類已經它的所有父類（因為有些註冊監聽器是監聽其父類）
    Set<Class>> dispatchTypes = flattenHierarchy(event.getClass());
    boolean dispatched = false;
    // 遍歷類本身以及所有父類
    for (Class> eventType : dispatchTypes) {
        // 重入讀鎖先鎖住
        subscribersByTypeLock.readLock().lock();
        try {
            // 得到類的所有訂閱者，例如DMLExecutionEvent的訂閱者就是DMLExecutionEventListener（EventSubscriber有兩個屬性：重要的屬性target和method，target就是監聽器即DMLExecutionEventListener，method就是監聽器方法即listener；從而知道DMLExecutionEvent這個事件由哪個類的哪個方法監聽處理）
            Set<EventSubscriber> wrappers = subscribersByType.get(eventType);
            if (!wrappers.isEmpty()) {
                // 如果有時間訂閱者，那麼dispatched = true，表示該事件可以分發
                dispatched = true;
                // 遍歷所有的時間訂閱者，每個訂閱者的佇列都增加該事件
                for (EventSubscriber wrapper : wrappers) {
                    enqueueEvent(event, wrapper);
                }
            }
        } finally {
            subscribersByTypeLock.readLock().unlock();
        }
    }
    if (!dispatched && !(event instanceof DeadEvent)) {
        post(new DeadEvent(this, event));
    }
    // 分發進入佇列的事件
    dispatchQueuedEvents();
}
/** 
 * queues of events for the current thread to dispatch;
 * 核心資料結構為LinkedList，儲存的是EventBus.EventWithSubscriber型別資料
 */
private final ThreadLocal<Queue<EventBus.EventWithSubscriber>> eventsToDispatch =
        new ThreadLocal<Queue<EventBus.EventWithSubscriber>>() {
            @Override protected Queue<EventBus.EventWithSubscriber> initialValue() {
                return new LinkedList<EventBus.EventWithSubscriber>();
            }
        };
void enqueueEvent(Object event, EventSubscriber subscriber) {
    // 資料結構為new LinkedList()，EventWithSubscriber就是對event和subscriber的封裝，LinkedList資料結構保證進入佇列和消費佇列順序一致
    eventsToDispatch.get().offer(new EventBus.EventWithSubscriber(event, subscriber));
}
/**
 * Drain the queue of events to be dispatched. As the queue is being drained,
 * new events may be posted to the end of the queue. 
 * 排乾要被分發的事件佇列，正在排乾的過程中，可能有新的事件被追加到佇列尾部
 */
void dispatchQueuedEvents() {
    // don't dispatch if we're already dispatching, that would allow reentrancy
    // and out-of-order events. Instead, leave the events to be dispatched
    // after the in-progress dispatch is complete.
    // 如果正在排乾佇列，則不分發
    if (isDispatching.get()) {
        return;
    }
    // ThreadLocal設定正在分發即isDispatching為true
    isDispatching.set(true);
    try {
        Queue<EventBus.EventWithSubscriber> events = eventsToDispatch.get();
        EventBus.EventWithSubscriber eventWithSubscriber;
        while ((eventWithSubscriber = events.poll()) != null) {
            // 呼叫訂閱者處理事件（method.invoke(target, new Object[] { event });，method和target來自訂閱者）
            dispatch(eventWithSubscriber.event, eventWithSubscriber.subscriber);
        }
    } finally {
        // ThreadLocal可能記憶體洩漏，用完需要remove
        isDispatching.remove();
        // 佇列中的事件任務處理完，清空佇列，即所謂的排乾（Drain）
        eventsToDispatch.remove();
    }
}

訂閱原始碼分析

/**
 * Registers all subscriber methods on {@code object} to receive events.
 * 註冊object上所有訂閱方法，用來接收事件，上面的使用參考，DMLExecutionEventListener就是這裡的object
 */
public void register(Object object) {
    // Multimap是guava自定義資料結構，類似Map>，key就是事件型別，例如DMLExecutionEvent，value就是EventSubscriber即事件訂閱者集合（說明，這個的訂閱者集合是指object裡符合訂閱者的所有方法，例如DMLExecutionEventListener.listener()，DMLExecutionEventListener中可以有多個訂閱者，註解@Subscribe即可），
    Multimap<Class>, EventSubscriber> methodsInListener =
            finder.findAllSubscribers(object);
    // 重入寫鎖保證執行緒安全
    subscribersByTypeLock.writeLock().lock();
    try {
        // 把訂閱者資訊放到map中快取起來（釋出事件post()時就會用到）
        subscribersByType.putAll(methodsInListener);
    } finally {
        subscribersByTypeLock.writeLock().unlock();
    }
}

END

阿飛哥

贊賞

長按二維碼向我轉賬

受蘋果公司新規定影響，微信 iOS 版的贊賞功能被關閉，可透過二維碼轉賬支援公眾號。

閱讀原文


微信掃一掃
使用小程式
即將開啟""小程式
取消
開啟