前言
本來通知這週一復工的,結果好像事情並沒有簡單,又推遲到下週1了,還要在家辦公一段時間,昨天有粉絲問我怎麼沒有更文,昨天分批次去公司開了一下午的會議,索性大家人數分批開會都帶了口罩,所以一點都不慌,大家出門都記得戴口罩,勤洗手~(在家辦公還是蠻快樂的,可以邊唱歌邊辦公_)
前幾天更新了OKHTTP
和Retrofit
的解析,今天更最後一篇EventBus
的解析。
把最近的知識也整理彙總了一份,打算和之前的知識做個彙總的PDF,有興趣的可以借鑑學習一下
上圖知識彙總的PDF相關內容後續GitHub更新,想衝擊金三銀四的小夥伴可以找找看看,歡迎star
(順手留下GitHub鏈接,需要獲取相關面試等內容的可以自己去找)
https://github.com/xiangjiana/Android-MS
更多完整項目下載。未完待續。源碼。圖文知識後續上傳github。
可以點擊關於我聯繫我獲取
一、EventBus簡介
EventBus
是一個Android端優化的publish/subscribe
消息總線,簡化了應用程序內 各組件間、組件與後臺線程間的通信。
作爲一個消息總線主要有三個組成部分:
事件(Event): 可以是任意類型的對象。通過事件的發佈者將事件進行傳遞。
事件訂閱者(Subscriber): 接收特定的事件。
事件發佈者(Publisher): 用於通知 Subscriber 有事件發生。可以在任意線程任 意位置發送事件。
上圖解釋了整個EventBus
的大概工作流程:事件的發佈者(Publisher)將事件 (Event)通過post()
方法發送。EventBus
內部進行處理,找到訂閱了該事件 (Event)的事件訂閱者(Subscriber
)。然後該事件的訂閱者(Subscriber
)通過 onEvent()
方法接收事件進行相關處理(關於onEvent()
在EventBus 3.0
中有改動, 下面詳細說明)。
二、EventBus
的簡單使用
1、把EventBus
依賴到項目
build.gradle
添加引用
compile 'de.greenrobot:eventbus:3.0.0-beta1'
2、構造事件(Event)對象。也就是發送消息類 每一個消息類,對應一種事件。這 裏我們定義兩個消息發送類。後面講解具體作用。
public class NewsEvent {
private String message;
public NewsEvent(String message) {
this.message = message;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
public class ToastEvent {
private String content;
public ToastEvent(String content) {
this.content = content;
}
public String getContent() {
return content;
}
public void setContent(String content) {
this.content = content;
}
}
3、註冊/解除事件訂閱(Subscriber)
EventBus.getDefault().register(this);//註冊事件 其中this代表訂閱者
具體註冊了對什麼事件的訂閱,這個需要onEvent()
方法來說明。在EventBus 3.0
之 前,onEvent()
方法是用來接收指定事件(Event)類型對象,然後進行相關處理操 作。在EventBus 3.0
之後,onEvent()
方法可以自定義方法名,不過要加入註解 @Subscribe
。
@Subscribe
public void onToastEvent(ToastEvent event){
Toast.makeText(MainActivity.this,event.getContent(),Toas t.LENGTH_SHORT).show();
}
通過register(this)
來表示該訂閱者進行了訂閱,通過onToastEvent(ToastEvent event)
表示指定對事件ToastEvent
的訂閱。到這裏訂閱就完成了。
需要注意的是: 一般在onCreate()
方法中進行註冊訂閱。在onDestory()
方法中進行 解除訂閱。
@Override
protected void onDestroy() {
super.onDestroy();
EventBus.getDefault().unregister(this);
}
4 、發送消息 訂閱已經完成,那麼便可以發送訂閱了。
EventBus.getDefault().post(new ToastEvent("Toast,發個提示,祝大家身體健康,勤洗手戴口罩!"));
那麼onToastEvent(ToastEvent event)
會收到事件,並彈出提示。
EventBus
的基礎使用流程就是這樣的。 其實,EventBus
還有好多其他的功能。下面我們一個個介紹。
三、EventBus
的進階使用
1.線程模式ThreadMode
當你接收的的事件後,如果處於非UI線程,你要更新UI怎麼辦?如果處於UI線程, 你要進行耗時操作,怎麼辦?等等其他情況,通過ThreadMode
統統幫你解決。
用法展示:
@Subscribe(threadMode = ThreadMode.MainThread)
public void onNewsEvent(NewsEvent event){
String message = event.getMessage();
mTv_message.setText(message);
}
使用起來很簡單,通過 @Subscribe(threadMode = ThreadMode.MainThread)
即可指定。 下面具體介紹下ThreadMode
。
關於ThreadMode
,一共有四種模式PostThread
,PostThread
, BackgroundThread
以及Async
。
PostThread
: 事件的處理在和事件的發送在相同的進程,所以事件處理時間不應 太長,不然影響事件的發送線程。
MainThread
: 事件的處理會在UI
線程中執行。事件處理時間不能太長,這個不用說 的,長了會ANR
的。
BackgroundThread
: 如果事件是在UI
線程中發佈出來的,那麼事件處理就會在子 線程中運行,如果事件本來就是子線程中發佈出來的,那麼事件處理直接在該子線 程中執行。所有待處理事件會被加到一個隊列中,由對應線程依次處理這些事件, 如果某個事件處理時間太長,會阻塞後面的事件的派發或處理。
Async
: 事件處理會在單獨的線程中執行,主要用於在後臺線程中執行耗時操作, 每個事件會開啓一個線程。
2.priority
事件優先級
事件的優先級類似廣播的優先級,優先級越高優先獲得消息。 用法展示:
@Subscribe(priority = 100)
public void onToastEvent(ToastEvent event){
Toast.makeText(MainActivity.this,event.getContent(),Toas t.LENGTH_SHORT).show();
}
當多個訂閱者(Subscriber
)對同一種事件類型進行訂閱時,即對應的事件處理方 法中接收的事件類型一致,則優先級高(priority
設置的值越大),則會先接收事 件進行處理;優先級低(priority
設置的值越小),則會後接收事件進行處理。
除此之外,EventBus
也可以終止對事件繼續傳遞的功能。 用法展示:
@Subscribe(priority = 100)
public void onToastEvent(ToastEvent event){
Toast.makeText(MainActivity.this,event.getContent(),Toas t.LENGTH_SHORT).show();
EventBus.getDefault().cancelEventDelivery(event);
}
這樣其他優先級比100低,並且訂閱了該事件的訂閱者就會接收不到該事件。
3.EventBus
黏性事件
EventBus
除了普通事件也支持粘性事件。可以理解成:訂閱在發佈事件之後,但同 樣可以收到事件。訂閱/解除訂閱和普通事件一樣,但是處理訂閱的方法有所不同, 需要註解中添加sticky = true
。 用法展示:
@Subscribe(priority = 100,sticky = true)
public void onToastEvent(ToastEvent event){
Toast.makeText(MainActivity.this,event.getContent(),Toas t.LENGTH_SHORT).show();
EventBus.getDefault().cancelEventDelivery(event);
}
這樣,假設一個ToastEvent
的事件已經發布,此時還沒有註冊訂閱。當設置了 sticky = true
,在ToastEvent
的事件發佈後,進行註冊。依然能夠接收到之前發佈 的事件。
不過這個時候,發佈事件的方式就改變了。
EventBus.getDefault().postSticky(new ToastEvent("Toast,發個提示, 避免去人多的地方!"));
我們如果不再需要該粘性事件我們可以移除
EventBus.getDefault().removeStickyEvent(ToastEvent.class);
或者調用移除所有粘性事件
EventBus.getDefault().removeAllStickyEvents();
4.EventBus
配置
EventBus在2.3
版本中添加了EventBuilder
去配置EventBus
的各方各面。
比如: 如何去構建一個在發佈事件時沒有訂閱者時保持沉默的EventBus
。
EventBus eventBus = EventBus.builder()
.logNoSubscriberMessages(false)
.sendNoSubscriberEvent(false)
.build();
通過上述設置,當一個事件沒有訂閱者時,不會輸出log信息,也不會發布一條默認 信息。
配置默認的EventBus
實例,使用EventBus.getDefault()
是一個簡單的方法。獲取一 個單例的EventBus
實例。EventBusBuilder
也允許使用installDefaultEventBus
方法 去配置默認的EventBus
實例。
注意: 不同的EventBus
的對象的數據是不共享的。通過一個EventBus
對象去發 布事件,只有通過同一個EventBus
對象訂閱事件,才能接收該事件。所以以上使 用EventBus.getDefault()
獲得的都是同一個實例。
四、源碼解析
註冊訂閱
EventBus.getDefault().register(this);
事件處理
@Subscribe(threadMode = ThreadMode.MainThread)
public void onNewsEvent(NewsEvent event){
String message = event.getMessage();
mTv_message.setText(message);
}
發佈事件
EventBus.getDefault().post(new NewsEvent("我是來自SecondActivity 的消息,你好!"));
以上是EventBus
的基本使用。我們先從getDefault
說起。
getDefault()
static volatile EventBus defaultInstance;
public static EventBus getDefault() {
if (defaultInstance == null) {
synchronized (EventBus.class) {
if (defaultInstance == null) {
defaultInstance = new EventBus();
}
}
}
return defaultInstance;
}
通過上述代碼可以得知,getDefault()
中通過雙檢查鎖(DCL)機制實現了 EventBus
的單例機制,獲得了一個默認配置的EventBus
對象。 下面我們繼續看 register()
方法。
register()
在瞭解register()
之前,我們先要了解一下EventBus
中的幾個關鍵的成員變量。方便 對下面內容的理解。
/** Map<訂閱事件, 訂閱該事件的訂閱者集合>
*/
private final Map<Class<?>, CopyOnWriteArrayList<Subscription>> subscriptionsByEventType;
/** Map<訂閱者, 訂閱事件集合>
*/
private final Map<Object, List<Class<?>>> typesBySubscriber;
/** Map<訂閱事件類類型,訂閱事件實例對象>.
*/
private final Map<Class<?>, Object> stickyEvents;
下面看具體的register()
中執行的代碼。
public void register(Object subscriber) {
//訂閱者類型
Class<?> subscriberClass = subscriber.getClass();
//判斷該類是不是匿名類,如果是匿名累要使用反射
boolean forceReflection = subscriberClass.isAnonymousCla ss();
//獲取訂閱者全部的響應函數信息(即上面的onNewsEvent()之類的方法)
List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(sub scriberClass, forceReflection);
//循環每一個事件響應函數,執行 subscribe()方法,更新訂閱相關信息
for (SubscriberMethod subscriberMethod : subscriberMetho ds) { subscribe(subscriber, subscriberMethod);
}
}
由此可見,register()
第一步 獲取訂閱者的類類型.
第二步 通過 SubscriberMethodFinder
類來解析訂閱者類,獲取所有的響應函數集合.
第三步 遍歷 訂閱函數,執行 subscribe()
方法,更新訂閱相關信息。 關於 subscriberMethodFinder
這裏就不介紹了。先跟着線索,繼續看subscribe()
方法。subscribe
函數分三步。
第一步:
//獲取訂閱的事件類型
Class<?> eventType = subscriberMethod.eventType;
//獲取訂閱該事件的訂閱者集合
CopyOnWriteArrayList<Subscription> subscriptions = subsc riptionsByEventType.get(eventType);
//把通過register()訂閱的訂閱者包裝成Subscription 對象 Subscription newSubscription = new Subscription(subscrib er, subscriberMethod);
//訂閱者集合爲空,創建新的集合,並把newSubscription 加入
if (subscriptions == null) {
subscriptions = new CopyOnWriteArrayList<Subscriptio n>();
subscriptionsByEventType.put(eventType, subscription s);
} else {
//集合中已經有該訂閱者,拋出異常。不能重複訂閱
if (subscriptions.contains(newSubscription)) {
throw new EventBusException("Subscriber " + subs criber.getClass() + " already registered to event " + eventType);
}
}
//把新的訂閱者按照優先級加入到訂閱者集合中。
synchronized (subscriptions) {
int size = subscriptions.size();
for (int i = 0; i <= size; i++) {
if (i == size || subscriberMethod.priority > sub scriptions.get(i).subscriberMethod.priority) { subscriptions.add(i, newSubscription);
break;
}
}
}
第二步:
//根據訂閱者,獲得該訂閱者訂閱的事件類型集合
List<Class<?>> subscribedEvents = typesBySubscriber.get( subscriber);
//如果事件類型集合爲空,創建新的集合,並加入新訂閱的事件類型。
if (subscribedEvents == null) {
subscribedEvents = new ArrayList<Class<?>>();
typesBySubscriber.put(subscriber, subscribedEvents);
}
//如果事件類型集合不爲空,加入新訂閱的事件類型
subscribedEvents.add(eventType);
第三步:
//該事件是stick=true。
if (subscriberMethod.sticky) {
//響應訂閱事件的父類事件
if (eventInheritance) {
Set<Map.Entry<Class<?>, Object>> entries = stick yEvents.entrySet();
//循環獲得每個stickyEvent事件
for (Map.Entry<Class<?>, Object> entry : entries ) {
Class<?> candidateEventType = entry.getKey() ;
//是該類的父類
if (eventType.isAssignableFrom(candidateEven tType)) {
//該事件類型最新的事件發送給當前訂閱者。
Object stickyEvent = entry.getValue();
checkPostStickyEventToSubscription(newSu bscription, stickyEvent);
}
}
} else {
Object stickyEvent = stickyEvents.get(eventType) ;
checkPostStickyEventToSubscription(newSubscripti on, stickyEvent);
}
}
由此可見,
第一步: 通過subscriptionsByEventType
得到該事件類型所有訂閱者信 息隊列,根據優先級將當前訂閱者信息插入到訂閱者隊列 subscriptionsByEventType
中;
第二步: 在typesBySubscriber
中得到當前訂閱者訂閱的所有事件隊列,將此事件保 存到隊列typesBySubscriber
中,用於後續取消訂閱;
第三步: 檢查這個事件是否 是 Sticky
事件,如果是則從stickyEvents
事件保存隊列中取出該事件類型最後一個 事件發送給當前訂閱者。
到此,便完成了訂閱功能。下面是訂閱的具體流程圖:
unregister()
public synchronized void unregister(Object subscriber) {
// 獲取該訂閱者所有的訂閱事件類類型集合.
List<Class<?>> subscribedTypes = typesBySubscriber.get(subsc riber);
if (subscribedTypes != null) {
for (Class<?> eventType : subscribedTypes) {
unsubscribeByEventType(subscriber, eventType);
}
// 從typesBySubscriber刪除該<訂閱者對象,訂閱事件類類型集合>
typesBySubscriber.remove(subscriber);
} else {
Log.e("EventBus", "Subscriber to unregister was not regi stered before: "+ subscriber.getClass());
}
}
private void unsubscribeByEventType(Object subscriber, Class<?> eventType) {
// 獲取訂閱事件對應的訂閱者信息集合.
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;
subscriptions.remove(i);
i --;
size --;
}
}
}
}
unregister()
方法比較簡單,主要完成了subscriptionsByEventType
以及 typesBySubscriber
兩個集合的同步。
post()
public void post(Object event) {
// 獲取當前線程的Posting狀態.
PostingThreadState postingState = currentPostingThreadState. get();
// 獲取當前線程的事件隊列.
List<Object> eventQueue = postingState.eventQueue;
//將當前事件添加到其事件隊列
eventQueue.add(event);
//判斷新加入的事件是否在分發中
if (!postingState.isPosting) {
postingState.isMainThread = Looper.getMainLooper() == Lo oper.myLooper();
postingState.isPosting = true;
if (postingState.canceled) {
throw new EventBusException("Internal error. Abort s tate was not reset");
}try {
// 循環處理當前線程eventQueue中的每一個event對象.
while (!eventQueue.isEmpty()) {
postSingleEvent(eventQueue.remove(0), postingSta te);
}
} finally {
// 處理完知乎重置postingState一些標識信息.
postingState.isPosting = false;
postingState.isMainThread = false;
}
}
}
post 函數會首先得到當前線程的 post 信息PostingThreadState
,其中包含事件隊 列,將當前事件添加到其事件隊列中,然後循環調用 postSingleEvent
函數發佈隊 列中的每個事件。
private void postSingleEvent(Object event, PostingThreadState po stingState) {
//分發事件的類型
Class<?> eventClass = event.getClass();
boolean subscriptionFound = false;
//響應訂閱事件的父類事件
if (eventInheritance) {
//找出當前訂閱事件類類型eventClass的所有父類的類類型和其實現的接 口的類類型
List<Class<?>> eventTypes = lookupAllEventTypes(eventCla ss);
int countTypes = eventTypes.size();
for (int h = 0; h < countTypes; h ++) {
Class<?> clazz = eventTypes.get(h);
//發佈每個事件到每個訂閱者
subscriptionFound |= postSingleEventForEventType(eve nt, postingState, clazz);
}
} else {
subscriptionFound = postSingleEventForEventType(event, p ostingState, eventClass);
}
....................................
}
調用 postSingleEventForEventType
函數發佈每個事件到每個訂閱者
private boolean postSingleEventForEventType(Object event, Postin gThreadState postingState, Class<?> eventClass) {
CopyOnWriteArrayList<Subscription> subscriptions;
synchronized (this) {
// 獲取訂閱事件類類型對應的訂閱者信息集合.(register函數時構造的集 合)
subscriptions = subscriptionsByEventType.get(eventClass) ;
}
if (subscriptions != null && !subscriptions.isEmpty()) {
for (Subscription subscription : subscriptions) {
postingState.event = event;
postingState.subscription = subscription;
boolean aborted = false;
try {
// 發佈訂閱事件給訂閱函數
postToSubscription(subscription, event, postingS tate.isMainThread);
aborted = postingState.canceled;
} finally {
postingState.event = null;
postingState.subscription = null;
postingState.canceled = false;
}
if (aborted) {
break;
}
}
return true;
}
return false;
}
調用 postToSubscription
函數向每個訂閱者發佈事件。 postToSubscription
函數中 會判斷訂閱者的 ThreadMode
,從而決定在什麼 Mode 下執行事件響應函數。這裏 就不貼源碼了。後續還牽着到反射以及線程調度問題,這裏就不展開了。 以上就是 post的流程,下面是具體的post的流程圖。
上圖知識彙總的PDF相關內容後續GitHub更新,想衝擊金三銀四的小夥伴可以找找看看,歡迎star
(順手留下GitHub鏈接,需要獲取相關面試等內容的可以自己去找)
https://github.com/xiangjiana/Android-MS
更多完整項目下載。未完待續。源碼。圖文知識後續上傳github。
可以點擊關於我聯繫我獲取