前言
EventBus是一款針對Android優化的發布/訂閱事件總線。簡化了應用程序內各組件間、組件與后臺線程間的通信。優點是開銷小,代碼更優雅,以及將發送者和接收者解耦。如果Activity和Activity進行交互還好說,如果Fragment和Fragment進行交互著實令人頭疼,我們會使用廣播來處理,但是使用廣播稍顯麻煩并且效率也不高,如果傳遞的數據是實體類需要序列化,那么很顯然成本會有點高。今天我們就來學習下EventBus3.0的使用方法。
1.EventBus概述
EventBus的三要素
EventBus有三個主要的元素需要我們先了解一下:
- Event:事件,可以是任意類型的對象。
- Subscriber:事件訂閱者,在EventBus3.0之前消息處理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync,他們分別代表四種線程模型。而在EventBus3.0之后,事件處理的方法可以隨便取名,但是需要添加一個注解@Subscribe,并且要指定線程模型(默認為POSTING),四種線程模型下面會講到。
- Publisher:事件發布者,可以在任意線程任意位置發送事件,直接調用EventBus的post(Object)方法??梢宰约簩嵗疎ventBus對象,但一般使用EventBus.getDefault()就好了,根據post函數參數的類型,會自動調用訂閱相應類型事件的函數。
EventBus的四種ThreadMode(線程模型)
EventBus3.0有以下四種ThreadMode:
- POSTING(默認):如果使用事件處理函數指定了線程模型為POSTING,那么該事件在哪個線程發布出來的,事件處理函數就會在這個線程中運行,也就是說發布事件和接收事件在同一個線程。在線程模型為POSTING的事件處理函數中盡量避免執行耗時操作,因為它會阻塞事件的傳遞,甚至有可能會引起ANR。
- MAIN:
事件的處理會在UI線程中執行。事件處理時間不能太長,長了會ANR的。 - BACKGROUND:如果事件是在UI線程中發布出來的,那么該事件處理函數就會在新的線程中運行,如果事件本來就是子線程中發布出來的,那么該事件處理函數直接在發布事件的線程中執行。在此事件處理函數中禁止進行UI更新操作。
- ASYNC:無論事件在哪個線程發布,該事件處理函數都會在新建的子線程中執行,同樣,此事件處理函數中禁止進行UI更新操作。
2.EventBus基本用法
EventBus使用起來很簡單,分為五個步驟:
1.自定義一個事件類
public class MessageEvent {
...
}
2.在需要訂閱事件的地方注冊事件
EventBus.getDefault().register(this);
3.發送事件
EventBus.getDefault().post(messageEvent);
4.處理事件
@Subscribe(threadMode = ThreadMode.MAIN)
public void XXX(MessageEvent messageEvent) {
...
}
前面我們說過,消息處理的方法可以隨便取名,但是需要添加一個注解@Subscribe,并且要指定線程模型(默認為POSTING)。
5.取消事件訂閱
EventBus.getDefault().unregister(this);
3.EventBus3.0應用
上面講到了基本用法,有的同學可能還是有點暈,這里舉一個例子來應用EventBus3.0。
添加依賴庫
Android Studio 配置gradle:
compile 'org.greenrobot:eventbus:3.0.0'
定義消息事件類
public class MessageEvent {
private String message;
public MessageEvent(String message) {
this.message = message;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
注冊和取消訂閱事件
MainActivity中注冊和取消訂閱事件(MainActivity.java):
import android.content.Intent;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.greenrobot.eventbus.ThreadMode;
public class MainActivity extends AppCompatActivity {
private TextView tv_message;
private Button bt_message;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
tv_message=(TextView)this.findViewById(R.id.tv_message);
tv_message.setText("MainActivity");
bt_message=(Button)this.findViewById(R.id.bt_message);
bt_message.setText("跳轉到SecondActivity");
bt_message.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
startActivity(new Intent(MainActivity.this,SecondActivity.class));
}
});
//注冊事件
EventBus.getDefault().register(this);
}
@Override
protected void onDestroy() {
super.onDestroy();
//取消注冊事件
EventBus.getDefault().unregister(this);
}
}
事件訂閱者處理事件
這里我們的ThreadMode設置為MAIN,事件的處理會在UI線程中執行,用TextView來展示收到的事件消息:
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMoonEvent(MessageEvent messageEvent){
tv_message.setText(messageEvent.getMessage());
}
事件發布者發布事件
這里創建了SecondActivity來發布消息:
public class SecondActivity extends AppCompatActivity {
private Button bt_message;
private TextView tv_message;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
tv_message=(TextView)this.findViewById(R.id.tv_message);
tv_message.setText("SecondActivity");
bt_message=(Button)this.findViewById(R.id.bt_message);
bt_message.setText("發送事件");
bt_message.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
EventBus.getDefault().post(new MessageEvent("歡迎關注劉望舒的博客"));
finish();
}
});
}
}
好了運行程序,我們看到MainActivity的TextView顯示MainActivity字樣:
接下來我們點擊按鈕進入SecondActivity并點擊該界面中的發送事件按鈕,這時SecondActivity被finish掉,MainActivity的TextView顯示"歡迎關注劉望舒的博客":
4.EventBus3.0粘性事件
除了上面講的普通事件外,EventBus還支持發送黏性事件,就是在發送事件之后再訂閱該事件也能收到該事件,跟黏性廣播類似。為了驗證粘性事件我們修改以前的代碼:
訂閱粘性事件
在MainActivity中我們將注冊事件添加到button的點擊事件中:
bt_subscription.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
//注冊事件
EventBus.getDefault().register(MainActivity.this);
}
});
訂閱者處理粘性事件
在MainActivity中新寫一個方法用來處理粘性事件:
@Subscribe(sticky = true)
public void ononMoonStickyEvent(MessageEvent messageEvent){
tv_message.setText(messageEvent.getMessage());
}
發送黏性事件
在SecondActivity中我們定義一個Button來發送粘性事件:
bt_subscription.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
EventBus.getDefault().postSticky(new MessageEvent("粘性事件"));
finish();
}
});
好了運行代碼再來看看效果,首先我們在MainActivity中并沒有訂閱事件,而是直接跳到SecondActivity中點擊發送粘性事件按鈕,這時界面回到MainActivity,我們看到TextView仍舊顯示著MainActivity的字段,這是因為我們現在還沒有訂閱事件。
接下來我們點擊訂閱事件,TextView發生改變顯示“粘性事件”,大功告成。
EventBus3.0的使用就暫時分析到這,不明白的同學可以下載源碼來研究下,下一講將講解EventBus3.0的源碼。
參考資料
EventBus使用詳解
EventBus 3.0的用法詳解
快速Android開發系列通信篇之EventBus