主要用于Android 中 Activity
,Fragment
,Service
之間的通信。
傳統的用于這三者之間的通信方法有
- 使用廣播,發送者發出廣播,接收者接收廣播后進行處理;
- 使用Handler和Message,如下載線程完成下載任務后,給UI發送Message,UI收到Message后更新界面
但傳統的這些方法應用起來比較繁瑣,雖然也能達到更新UI的效果,但是代碼量較大,EventBus
這個框架能夠優雅的解決這種類似的需求,降低組件之間的耦合度。
下面簡單介紹如何使用
1. 集成框架(github最新版本)
dependencies {
compile 'org.simple:androideventbus:1.0.5.1'
}
2.注冊EventBus
在需要監聽事件變化的Activity的onCreate
方法中加入
EventBus.getDefault().register(this);
并且在其onDestory
方法中不要忘記注銷監聽
EventBus.getDefault().unregister(this);
3.發布事件
- 框架中定義的發布事件有兩種,一種是只帶一個Object對象,默認tag是DEFAULT_TAG,另一種是設置Object對象和tag標識。
/**
* post a event
*
* @param event
*/
public void post(Object event) {
post(event, EventType.DEFAULT_TAG);
}
/**
* 發布事件
*
* @param event 要發布的事件
* @param tag 事件的tag, 類似于BroadcastReceiver的action
*/
public void post(Object event, String tag) {
mLocalEvents.get().offer(new EventType(event.getClass(), tag));
mDispatcher.dispatchEvents(event);
}
-
tag
,相當于廣播里面的action,只有接收者里面注冊了這個tag
的方法才會被觸發,沒有注冊這個tag
的方法就不會被觸發。
在Activity中調用
EventBus.getDefault().post(user,"update_tag");
4.接收消息
@Subscriber
private void updateUser(User user){
Log.d("Tomato","[updateUsername]:"+user.getName()+",psw:"+user.getPsw()+",phone:"+user
.getPhone());
}
@Subscriber(tag = "update_tag")
private void updateWithTag(User user){
Log.d("Tomato","[updateWithTag]name:"+user.getName()+",psw:"+user.getPsw()+",phone:"+user
.getPhone());
}
/**
* ThreadMode.MAIN,事件接收函數執行在UI線程
* ThreadMode.POST,事件在哪個線程發布,接收函數就執行在哪個線程
* ThreadMode.ASYNC,事件執行在一個獨立的異步線程中。
* @param user
*/
@Subscriber(tag = "update_tag" , mode = ThreadMode.POST)
private void updateWithMode(User user){
Log.d("Tomato","[updateWithMode]name:"+user.getName()+",psw:"+user.getPsw()+",phone:"+user
.getPhone());
}
- 其中@Subcriber(tag = "update_tag")注解表明該方法是一個消息接收方法,tag = "update_tag"表明該方法注冊了"update_tag"這個消息,接收到該消息該方法就會被觸發。
下面是demo源碼
傳遞的對象
public class User {
private String name;
private String psw;
private String phone;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPsw() {
return psw;
}
public void setPsw(String psw) {
this.psw = psw;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
}
接收消息的Activity
import android.content.Intent;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import org.simple.eventbus.EventBus;
import org.simple.eventbus.Subscriber;
import org.simple.eventbus.ThreadMode;
public class MainActivity extends AppCompatActivity {
private Button button;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
EventBus.getDefault().register(this);
button = (Button)findViewById(R.id.button);
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Intent intent = new Intent(MainActivity.this,Main2Activity.class);
startActivity(intent);
}
});
}
@Subscriber
private void updateUser(User user){
Log.d("Tomato","[updateUsername]:"+user.getName()+",psw:"+user.getPsw()+",phone:"+user
.getPhone());
}
@Subscriber(tag = "update_tag")
private void updateWithTag(User user){
Log.d("Tomato","[updateWithTag]name:"+user.getName()+",psw:"+user.getPsw()+",phone:"+user
.getPhone());
}
/**
* ThreadMode.MAIN,事件接收函數執行在UI線程
* ThreadMode.POST,事件在哪個線程發布,接收函數就執行在哪個線程
* ThreadMode.ASYNC,事件執行在一個獨立的異步線程中。
* @param user
*/
@Subscriber(tag = "update_tag" , mode = ThreadMode.POST)
private void updateWithMode(User user){
Log.d("Tomato","[updateWithMode]name:"+user.getName()+",psw:"+user.getPsw()+",phone:"+user
.getPhone());
}
@Override
protected void onDestroy() {
EventBus.getDefault().unregister(this);
super.onDestroy();
}
}
發送消息的Activity
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import org.simple.eventbus.EventBus;
public class Main2Activity extends AppCompatActivity {
private Button button;
private int i = 0;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main2);
button = (Button)findViewById(R.id.button);
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
User user = new User();
user.setName("張三"+i);
user.setPhone("Phone:"+i);
user.setPsw("psw:"+i);
i ++;
EventBus.getDefault().post(user,"update_tag");
}
});
}
@Override
protected void onDestroy() {
super.onDestroy();
}
}
測試結果
每次點擊按鈕,發送一次消息,打印出來的日志如下
利用EventBus優雅得退出應用程序
在Android應用開發中,有些情況下我們需要可以直接退出程序。但問題是,回退棧中含有其他的Activity存在,直接使用返回鍵并不能退出應用。此時我們常見的做法是再自定義一個Application子類,在子類中維護一個Activity的列表,然后在進入Activity時,將Activity添加到列表中,在Activity銷毀之前將自己從Application子類的列表中移除。在需要退出應用時遍歷Application子類的Activity列表,然后調用每個Activity的finish函數。那我們看看AndroidEventBus怎么實現這個功能
public class BasicAct extends Activity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
EventBus.getDefault().register(this);
}
@Override
protected void onDestroy() {
super.onDestroy();
EventBus.getDefault().unregister(this);
}
@Subcriber(tag = "exit")
private void exitSystem(String msg) {
finish();
}
}
我們定義一個BasicAct在onCreate中注冊該Activity對象,在onDestroy中注銷,還添加了一個exitSystem的訂閱函數。所有的Activity類可以繼承自BasicAct。當需要退出應用時,直接發布一個類型為String、tag為exit的事件即可。這樣所有的Activity就會觸發exitSystem,而該函數中又調用了finish方法,因此所有的Activity都將退出,通過這種方式就完成了應用退出。