EventBus是一款針對Android優化的釋出/訂閱事件匯流排。可以替代廣播、startActivityForResult
、Handler
、非同步回撥等來實現各元件間、元件與後臺執行緒間的通訊。它的優點是開銷小,程式碼更優雅,以及將傳送者和接收者解耦。
通常我們在使用EventBus
的時候都是直接需要接收通訊的Activity/Fragment
中通過EventBus.getDefault().register(this)
訂閱事件,在需要發起通訊的邏輯直接呼叫EventBus.getDefault().post(Object event)
來發布事件。但是要是一個專案中有很多地方都使用EventBus
來通訊,比如重新登入後更新各個頁面的登入狀態,或者是接收到通知更新訊息提示等,都這樣直接使用的話程式碼重複率很高,並且呢,如果以後升級或者更換EventBus
時,各個地方都要修改,這就比較麻煩了。因此我一般是將EventBus
的釋出和訂閱封裝到BaseActivity/BaseFragment
中。
在Gradle中新增EventBus
依賴:
compile 'org.greenrobot:eventbus:3.0.0'複製程式碼
封裝一下EventBus
的訂閱、取消訂閱、釋出等方法:
public class EventBusUtil {
public static void register(Object subscriber) {
EventBus.getDefault().register(subscriber);
}
public static void unregister(Object subscriber) {
EventBus.getDefault().unregister(subscriber);
}
public static void sendEvent(Event event) {
EventBus.getDefault().post(event);
}
public static void sendStickyEvent(Event event) {
EventBus.getDefault().postSticky(event);
}
// 其他
}複製程式碼
在BaseActivity/BaseFragment
中的onCreate
和onDestroy
方法中訂閱和取消訂閱,這裡新增了一個isRegisterEventBus()
方法,預設返回false
,即不訂閱EventBus
,子類Activity/Fragment
如果需要訂閱的話複寫這個方法並返回true
即可。
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
if (isRegisterEventBus()) {
EventBusUtil.register(this);
}
}
/**
* 是否註冊事件分發
*
* @return true繫結EventBus事件分發,預設不繫結,子類需要繫結的話複寫此方法返回true.
*/
protected boolean isRegisterEventBus() {
return false;
}
@Override
public void onDestroy() {
super.onDestroy();
if (isRegisterEventBus()) {
EventBusUtil.unregister(this);
}
}複製程式碼
定義事件Event
:
public class Event<T> {
private int code;
private T data;
public Event(int code) {
this.code = code;
}
public Event(int code, T data) {
this.code = code;
this.data = data;
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
}複製程式碼
通過泛型<T>
指定事件通訊過程中的資料型別,code
為事件碼,使用的時候給不同的事件型別指定不同的code
。
在BaseActivity\BaseFragment
中新增接收到EventBus
的方法:
/**
* 是否註冊事件分發
*
* @return true繫結EventBus事件分發,預設不繫結,子類需要繫結的話複寫此方法返回true.
*/
protected boolean isRegisterEventBus() {
return false;
}
@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventBusCome(Event event) {
if (event != null) {
receiveEvent(event);
}
}
@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onStickyEventBusCome(Event event) {
if (event != null) {
receiveStickyEvent(event);
}
}
/**
* 接收到分發到事件
*
* @param event 事件
*/
protected void receiveEvent(Event event) {
}
/**
* 接受到分發的粘性事件
*
* @param event 粘性事件
*/
protected void receiveStickyEvent(Event event) {
}複製程式碼
根據自己專案的需求,在訂閱了EventBus
的Activity/Fragment
中複寫receiveEvent(Event event)
或receiveStickyEvent(Event event)
來處理接收到事件後的邏輯。
這裡也可以不用在BaseActivty/BaseFragment
中新增接受事件的方法(因為新增了過後不能確定的子類的Event
泛型)。那麼就直接在訂閱的Activity/Fragment
中給接收事件的方法新增EventBus
對應的事件接受註解,並指定引數Event的泛型。
@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventReceived(Event<User> event) {
if (event != null && event.getCode() == C.EventCode.C) {
User user = event.getData();
}
}複製程式碼
在給定Event
的code
的時候最好在常量池中定義一個類專門用來定義不同型別的EventBus
的code
,這樣在接收到EventBus
的地方可以根據這些code
值來判斷Event
的來源。
public final class C {
// EventBus Code
public static final class EventCode {
public static final int A = 0x111111;
public static final int B = 0x222222;
public static final int C = 0x333333;
public static final int D = 0x444444;
// other more
}
}複製程式碼
使用示例:
在MainActivity
中複寫isRegisterEventBus()
並返回true
註冊EventBus
,複寫receiveEvent(Event event)
接收發布的事件。
@Override
protected boolean isRegisterEventBus() {
return true;
}
@Override
protected void receiveEvent(Event event) {
// 接受到Event後的相關邏輯
switch (event.getCode()) {
case C.EventCode.A:
Log.d("EventBus", "接收到A型別的Event");
break;
case C.EventCode.B:
Log.d("EventBus", "接收到B型別的Event");
break;
case C.EventCode.C:
Log.d("EventBus", "接收到B型別的Event,攜帶User");
User user = (User) event.getData();
break;
case C.EventCode.D:
Log.d("EventBus", "接收到D型別的Event,攜帶News");
News news = (News) event.getData();
break;
}
}複製程式碼
在receiveEvent(Event event)
根據對應的事件的code
,判斷通訊的資料來源和傳遞的資料型別,以完成對應的邏輯。
在InfoActivity
中傳送事件,InfoActivity
只傳送不需要接收Event
的話就不註冊,也不用複寫isRegisterEventBus()
和receiveEvent(Event event)
方法了。
public void sendEventA(View view) {
EventBusUtil.sendEvent(new Event(C.EventCode.A));
}
public void sendEventB(View view) {
EventBusUtil.sendEvent(new Event(C.EventCode.B));
}
public void sendEventC(View view) {
Event<User> event = new Event<>(C.EventCode.C, new User());
EventBusUtil.sendEvent(event);
}
public void sendEventD(View view) {
Event<News> event = new Event<>(C.EventCode.D, new News());
EventBusUtil.sendEvent(event);
}複製程式碼
通過上面的方式,將EventBus
封裝到BaseActivity/BaseFragment
中,使得EventBus和專案解耦更加徹底,同時在需要使用的子Activity/Fragment中只需要複寫isRegisterEventBus()
和receiveEvent(Event event)
即可,不用每個地方都去訂閱和取消訂閱。並且給Event
給定code
和泛型能夠很好的區分不同的事件來源和資料型別。