前言：EventBus出來已經(jīng)有一段時(shí)間了，github上面也有很多開源項(xiàng)目中使用了EventBus。所以抽空學(xué)習(xí)順便整理了一下。目前EventBus最新版本是3.0，所以本文是基于EventBus3.0的。

相關(guān)文章

EventBus使用詳解

EventBus源碼解析

概述

EventBus是針一款對(duì)Android的發(fā)布/訂閱事件總線。它可以讓我們很輕松的實(shí)現(xiàn)在Android各個(gè)組件之間傳遞消息，并且代碼的可讀性更好，耦合度更低。

如何使用

(1)首先需要定義一個(gè)消息類，該類可以不繼承任何基類也不需要實(shí)現(xiàn)任何接口。如：

publicclassMessageEvent {? ? ......}

(2)在需要訂閱事件的地方注冊(cè)事件

EventBus.getDefault().register(this);

(3)產(chǎn)生事件，即發(fā)送消息

EventBus.getDefault().post(messageEvent);

(4)處理消息

@Subscribe(threadMode = ThreadMode.PostThread)publicvoidXXX(MessageEvent messageEvent){? ? ...}

在3.0之前，EventBus還沒有使用注解方式。消息處理的方法也只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，分別代表四種線程模型。而在3.0之后，消息處理的方法可以隨便取名，但是需要添加一個(gè)注解@Subscribe，并且要指定線程模型（默認(rèn)為PostThread），四種線程模型，下面會(huì)講到。

注意，事件處理函數(shù)的訪問權(quán)限必須為public，否則會(huì)報(bào)異常。

(5)取消消息訂閱

EventBus.getDefault().unregister(this);

有何優(yōu)點(diǎn)

采用消息發(fā)布/訂閱的一個(gè)很大的優(yōu)點(diǎn)就是代碼的簡(jiǎn)潔性，并且能夠有效地降低消息發(fā)布者和訂閱者之間的耦合度。

舉個(gè)例子，比如有兩個(gè)界面，ActivityA和ActivityB，從ActivityA界面跳轉(zhuǎn)到ActivityB界面后，ActivityB要給ActivityA發(fā)送一個(gè)消息，ActivityA收到消息后在界面上顯示出來。我們最先想到的方法就是使用廣播，使用廣播實(shí)現(xiàn)此需求的代碼如下：

首先需要在ActivityA中定義一個(gè)廣播接收器：

publicclassMessageBroadcastReceiverextendsBroadcastReceiver{@Overridepublic void onReceive(Contextcontext,Intentintent) {? ? ? ? mMessageView.setText("Message from SecondActivity:"+ intent.getStringExtra("message"));? ? }}

還需要在onCreate()方法中注冊(cè)廣播接收器：

@OverrideprotectedvoidonCreate(Bundle savedInstanceState){super.onCreate(savedInstanceState);? ? setContentView(R.layout.activity_main);//注冊(cè)事件EventBus.getDefault().register(this);//注冊(cè)廣播IntentFilter intentFilter =newIntentFilter("message_broadcast");? ? mBroadcastReceiver =newMessageBroadcastReceiver();? ? registerReceiver(mBroadcastReceiver, intentFilter);? ? ......}

然后在onDestory()方法中取消注冊(cè)廣播接收器：

@OverrideprotectedvoidonDestroy(){super.onDestroy();? ? ......//取消廣播注冊(cè)u(píng)nregisterReceiver(mBroadcastReceiver);}

最后我們需要在ActivityB界面中發(fā)送廣播消息：

findViewById(R.id.send_broadcast).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){? ? ? ? String message = mMessageET.getText().toString();if(TextUtils.isEmpty(message)) {? ? ? ? ? ? message ="defaule message";? ? ? ? }? ? ? ? Intent intent =newIntent();? ? ? ? intent.setAction("message_broadcast");? ? ? ? intent.putExtra("message", message);? ? ? ? sendBroadcast(intent);? ? }});

看著上面的實(shí)現(xiàn)代碼，感覺也沒什么不妥，挺好的！下面對(duì)比看下使用EventBus如何實(shí)現(xiàn)。

根據(jù)文章最前面所講的EventBus使用步驟，首先我們需要定義一個(gè)消息事件類：

publicclassMessageEvent {privateStringmessage;publicMessageEvent(Stringmessage) {this.message = message;? ? }publicStringgetMessage() {returnmessage;? ? }publicvoidsetMessage(Stringmessage) {this.message = message;? ? }}

在ActivityA界面中我們首先需要注冊(cè)訂閱事件：

@OverrideprotectedvoidonCreate(Bundle savedInstanceState){super.onCreate(savedInstanceState);? ? setContentView(R.layout.activity_main);//注冊(cè)事件EventBus.getDefault().register(this);? ? ......}

然后在onDestory()方法中取消訂閱：

@OverrideprotectedvoidonDestroy(){super.onDestroy();//取消事件注冊(cè)EventBus.getDefault().unregister(this);}

當(dāng)然還要定義一個(gè)消息處理的方法：

@Subscribe(threadMode= ThreadMode.MainThread)public void onShowMessageEvent(MessageEvent messageEvent) {mMessageView.setText("MessagefromSecondActivity:"+messageEvent.getMessage());}

至此，消息訂閱者我們已經(jīng)定義好了，我們還需要在ActivityB中發(fā)布消息：

findViewById(R.id.send).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){? ? ? ? String message = mMessageET.getText().toString();if(TextUtils.isEmpty(message)) {? ? ? ? ? ? message ="defaule message";? ? ? ? }? ? ? ? EventBus.getDefault().post(newMessageEvent(message));? ? }});

對(duì)比代碼一看，有人會(huì)說了，這尼瑪有什么區(qū)別嘛！說好的簡(jiǎn)潔呢？哥們，別著急嘛！我這里只是舉了個(gè)簡(jiǎn)單的例子，僅僅從該例子來看，EventBus的優(yōu)勢(shì)沒有體現(xiàn)出來?，F(xiàn)在我將需求稍微改一下，ActivityA收到消息后，需要從網(wǎng)絡(luò)服務(wù)器獲取數(shù)據(jù)并將數(shù)據(jù)展示出來。如果使用廣播，ActivityA中廣播接收器代碼應(yīng)該這么寫：

publicclassMessageBroadcastReceiverextendsBroadcastReceiver{@OverridepublicvoidonReceive(Context context, Intent intent){newThread(newRunnable() {@Overridepublicvoidrun(){//從服務(wù)器上獲取數(shù)據(jù)......? ? ? ? ? ? ? ? runOnUiThread(newRunnable() {@Overridepublicvoidrun(){//將獲取的數(shù)據(jù)展示在界面上......? ? ? ? ? ? ? ? ? ? }? ? ? ? ? ? ? ? });? ? ? ? ? ? }? ? ? ? }).start();? ? }}

看到這段代碼，不知道你何感想，反正我是看著很不爽，嵌套層次太多，完全違反了Clean Code的原則。那使用EventBus來實(shí)現(xiàn)又是什么樣呢？我們看一下。

@Subscribe(threadMode = ThreadMode.BackgroundThread)public void onGetDataEvent(MessageEvent messageEvent) {//從服務(wù)器上獲取數(shù)據(jù)......EventBus.getDefault().post(new ShowMessageEvent());}@Subscribe(threadMode = ThreadMode.MainThread)public void onShowDataEvent(ShowMessageEvent showMessageEvent) {//將獲取的數(shù)據(jù)展示在界面上......}

對(duì)比一下以上兩段代碼就能很明顯的感覺到EventBus的優(yōu)勢(shì)，代碼簡(jiǎn)潔、層次清晰，大大提高了代碼的可讀性和可維護(hù)性。我這只是簡(jiǎn)單的加了一個(gè)小需求而已，隨著業(yè)務(wù)越來越復(fù)雜，使用EventBus的優(yōu)勢(shì)愈加明顯。

常用API介紹

線程模型

在EventBus的事件處理函數(shù)中需要指定線程模型，即指定事件處理函數(shù)運(yùn)行所在的想線程。在上面我們已經(jīng)接觸到了EventBus的四種線程模型。那他們有什么區(qū)別呢？

在EventBus中的觀察者通常有四種線程模型，分別是PostThread（默認(rèn)）、MainThread、BackgroundThread與Async。

PostThread：如果使用事件處理函數(shù)指定了線程模型為PostThread，那么該事件在哪個(gè)線程發(fā)布出來的，事件處理函數(shù)就會(huì)在這個(gè)線程中運(yùn)行，也就是說發(fā)布事件和接收事件在同一個(gè)線程。在線程模型為PostThread的事件處理函數(shù)中盡量避免執(zhí)行耗時(shí)操作，因?yàn)樗鼤?huì)阻塞事件的傳遞，甚至有可能會(huì)引起ANR。

MainThread：如果使用事件處理函數(shù)指定了線程模型為MainThread，那么不論事件是在哪個(gè)線程中發(fā)布出來的，該事件處理函數(shù)都會(huì)在UI線程中執(zhí)行。該方法可以用來更新UI，但是不能處理耗時(shí)操作。

BackgroundThread：如果使用事件處理函數(shù)指定了線程模型為BackgroundThread，那么如果事件是在UI線程中發(fā)布出來的，那么該事件處理函數(shù)就會(huì)在新的線程中運(yùn)行，如果事件本來就是子線程中發(fā)布出來的，那么該事件處理函數(shù)直接在發(fā)布事件的線程中執(zhí)行。在此事件處理函數(shù)中禁止進(jìn)行UI更新操作。

Async：如果使用事件處理函數(shù)指定了線程模型為Async，那么無論事件在哪個(gè)線程發(fā)布，該事件處理函數(shù)都會(huì)在新建的子線程中執(zhí)行。同樣，此事件處理函數(shù)中禁止進(jìn)行UI更新操作。

為了驗(yàn)證以上四個(gè)方法，我寫了個(gè)小例子。

@Subscribe(threadMode= ThreadMode.PostThread)public void onMessageEventPostThread(MessageEvent messageEvent) {Log.e("PostThread",Thread.currentThread().getName());}@Subscribe(threadMode= ThreadMode.MainThread)public void onMessageEventMainThread(MessageEvent messageEvent) {Log.e("MainThread",Thread.currentThread().getName());}@Subscribe(threadMode= ThreadMode.BackgroundThread)public void onMessageEventBackgroundThread(MessageEvent messageEvent) {Log.e("BackgroundThread",Thread.currentThread().getName());}@Subscribe(threadMode= ThreadMode.Async)public void onMessageEventAsync(MessageEvent messageEvent) {Log.e("Async",Thread.currentThread().getName());}

分別使用上面四個(gè)方法訂閱同一事件，打印他們運(yùn)行所在的線程。首先我們?cè)赨I線程中發(fā)布一條MessageEvent的消息，看下日志打印結(jié)果是什么。

findViewById(R.id.send).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){? ? ? ? ? ? Log.e("postEvent", Thread.currentThread().getName());? ? ? ? ? ? EventBus.getDefault().post(newMessageEvent());? ? ? ? }? ? });

打印結(jié)果如下：

2689-2689/com.lling.eventbusdemoE/postEvent﹕ main2689-2689/com.lling.eventbusdemoE/PostThread﹕ main2689-3064/com.lling.eventbusdemoE/Async﹕ pool-1-thread-12689-2689/com.lling.eventbusdemoE/MainThread﹕ main2689-3065/com.lling.eventbusdemoE/BackgroundThread﹕ pool-1-thread-2

從日志打印結(jié)果可以看出，如果在UI線程中發(fā)布事件，則線程模型為PostThread的事件處理函數(shù)也執(zhí)行在UI線程，與發(fā)布事件的線程一致。線程模型為Async的事件處理函數(shù)執(zhí)行在名字叫做pool-1-thread-1的新的線程中。而MainThread的事件處理函數(shù)執(zhí)行在UI線程，BackgroundThread的時(shí)間處理函數(shù)執(zhí)行在名字叫做pool-1-thread-2的新的線程中。

我們?cè)倏纯丛谧泳€程中發(fā)布一條MessageEvent的消息時(shí)，會(huì)有什么樣的結(jié)果。

findViewById(R.id.send).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){newThread(newRunnable() {@Overridepublicvoidrun(){? ? ? ? ? ? ? ? ? ? Log.e("postEvent", Thread.currentThread().getName());? ? ? ? ? ? ? ? ? ? EventBus.getDefault().post(newMessageEvent());? ? ? ? ? ? ? ? }? ? ? ? ? ? }).start();? ? ? ? }? ? });

打印結(jié)果如下：

3468-3945/com.lling.eventbusdemo E/postEvent﹕ Thread-1253468-3945/com.lling.eventbusdemo E/PostThread﹕ Thread-1253468-3945/com.lling.eventbusdemo E/BackgroundThread﹕ Thread-1253468-3946/com.lling.eventbusdemo E/Async﹕ pool-1-thread-13468-3468/com.lling.eventbusdemo E/MainThread﹕ main

從日志打印結(jié)果可以看出，如果在子線程中發(fā)布事件，則線程模型為PostThread的事件處理函數(shù)也執(zhí)行在子線程，與發(fā)布事件的線程一致（都是Thread-125）。BackgroundThread事件模型也與發(fā)布事件在同一線程執(zhí)行。Async則在一個(gè)名叫pool-1-thread-1的新線程中執(zhí)行。MainThread還是在UI線程中執(zhí)行。

上面一個(gè)例子充分驗(yàn)證了指定不同線程模型的事件處理方法執(zhí)行所在的線程。

黏性事件

除了上面講的普通事件外，EventBus還支持發(fā)送黏性事件。何為黏性事件呢？簡(jiǎn)單講，就是在發(fā)送事件之后再訂閱該事件也能收到該事件，跟黏性廣播類似。具體用法如下：

訂閱黏性事件：

EventBus.getDefault().register(StickyModeActivity.this);

黏性事件處理函數(shù)：

@Subscribe(sticky =true)publicvoidXXX(MessageEvent messageEvent){? ? ......}

發(fā)送黏性事件：

EventBus.getDefault().postSticky(newMessageEvent("test"));

處理消息事件以及取消訂閱和上面方式相同。

看個(gè)簡(jiǎn)單的黏性事件的例子，為了簡(jiǎn)單起見我這里就在一個(gè)Activity里演示了。

Activity代碼：

publicclassStickyModeActivityextendsAppCompatActivity{intindex =0;@OverrideprotectedvoidonCreate(Bundle savedInstanceState){super.onCreate(savedInstanceState);? ? ? ? setContentView(R.layout.activity_sticky_mode);? ? ? ? findViewById(R.id.post).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){? ? ? ? ? ? ? ? EventBus.getDefault().postSticky(newMessageEvent("test"+ index++));? ? ? ? ? ? }? ? ? ? });? ? ? ? findViewById(R.id.regist).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){? ? ? ? ? ? ? ? EventBus.getDefault().registerSticky(StickyModeActivity.this);? ? ? ? ? ? }? ? ? ? });? ? ? ? findViewById(R.id.unregist).setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View v){? ? ? ? ? ? ? ? EventBus.getDefault().unregister(StickyModeActivity.this);? ? ? ? ? ? }? ? ? ? });? ? }@Subscribe(threadMode = ThreadMode.PostThread, sticky =true)publicvoidonMessageEventPostThread(MessageEvent messageEvent){? ? ? ? Log.e("PostThread", messageEvent.getMessage());? ? }@Subscribe(threadMode = ThreadMode.MainThread, sticky =true)publicvoidonMessageEventMainThread(MessageEvent messageEvent){? ? ? ? Log.e("MainThread", messageEvent.getMessage());? ? }@Subscribe(threadMode = ThreadMode.BackgroundThread, sticky =true)publicvoidonMessageEventBackgroundThread(MessageEvent messageEvent){? ? ? ? Log.e("BackgroundThread", messageEvent.getMessage());? ? }@Subscribe(threadMode = ThreadMode.Async, sticky =true)publicvoidonMessageEventAsync(MessageEvent messageEvent){? ? ? ? Log.e("Async", messageEvent.getMessage());? ? }}

布局代碼activity_sticky_mode.xml：

代碼很簡(jiǎn)單，界面上三個(gè)按鈕，一個(gè)用來發(fā)送黏性事件，一個(gè)用來訂閱事件，還有一個(gè)用來取消訂閱的。首先在未訂閱的情況下點(diǎn)擊發(fā)送按鈕發(fā)送一個(gè)黏性事件，然后點(diǎn)擊訂閱，會(huì)看到日志打印結(jié)果如下：

15246-15246/com.lling.eventbusdemoE/PostThread﹕ test015246-15391/com.lling.eventbusdemoE/Async﹕ test015246-15246/com.lling.eventbusdemoE/MainThread﹕ test015246-15393/com.lling.eventbusdemoE/BackgroundThread﹕ test0

這就是粘性事件，能夠收到訂閱之前發(fā)送的消息。但是它只能收到最新的一次消息，比如說在未訂閱之前已經(jīng)發(fā)送了多條黏性消息了，然后再訂閱只能收到最近的一條消息。這個(gè)我們可以驗(yàn)證一下，我們連續(xù)點(diǎn)擊5次POST按鈕發(fā)送5條黏性事件，然后再點(diǎn)擊REGIST按鈕訂閱，打印結(jié)果如下：

6980-6980/com.lling.eventbusdemoE/PostThread﹕ test46980-6980/com.lling.eventbusdemoE/MainThread﹕ test46980-7049/com.lling.eventbusdemoE/Async﹕ test46980-7048/com.lling.eventbusdemoE/BackgroundThread﹕ test4

由打印結(jié)果可以看出，確實(shí)是只收到最近的一條黏性事件。