主要用于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都将退出,通过这种方式就完成了应用退出。