前言
EventBus是一种用于Android的发布/订阅事件总线。它有很多优点:简化应用组件间的通信;解耦事件的发送者和接收者;避免复杂和容易出错的依赖和生命周期的问题;很快,专门为高性能优化过等等。
基础知识
EventBus使用了发布者/订阅者模式。
发布者通过EventBus发布事件,订阅者通过EventBus订阅事件。当发布者发布事件时,订阅该事件的订阅者的事件处理方法将被调用。
使用详解
本文将按照如下顺序来介绍EventBus的使用:准备工作
基本使用
线程模式
粘性事件
事件优先级
订阅者索引
文中所有的代码都放在了GitHub上:
准备工作
首先,在模块的 build.gradle 构建脚本中添加EventBus依赖:dependencies {
...
compile 'org.greenrobot:eventbus:3.1.1'
}
接着,添加EventBus混淆规则。ProGuard工具混淆了方法名,并可能移除那些未被调用的方法。订阅者的事件处理方法没有被直接调用,如果开启了ProGuard工具的压缩功能,那么你必须告诉ProGuard工具保留这些订阅者方法。在模块的 proguard-rules.pro 混淆规则文件中添加如下规则:# EventBus
-keepattributes *Annotation*
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe ;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }
基本使用
EventBus的使用非常简单,主要分为3个步骤:定义事件。
订阅事件。
发布事件。
第一步,定义事件。
事件可以是任意普通的Java对象,没有任何特殊的要求。例如: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;
}
}
第二步,订阅事件。
订阅者需要定义事件处理方法(也称为订阅者方法)。当发布对应类型的事件时,该方法将被调用。EventBus 3使用 @Subscribe 注解来定义订阅者方法。方法名可以是任意合法的方法名,参数类型为订阅事件的类型。例如:@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {
...
}
订阅者还需要在总线上注册,并在不需要时在总线上注销。只有订阅者注册了,它们才会收到事件。在Android中,可以根据Activity或者Fragment的生命周期来注册和注销。例如:@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initContentView();
// 注册订阅者
EventBus.getDefault().register(this);
}
@Override
protected void onDestroy() {
super.onDestroy();
// 注销订阅者
EventBus.getDefault().unregister(this);
}
第三步,发布事件。
在需要的地方发布事件,所有订阅了该类型事件并已注册的订阅者将收到该事件。例如:// 发布事件
EventBus.getDefault().post(new MessageEvent("Hello EventBus!"));
下面是一个例子。订阅事件的代码如下所示:public class MainActivity extends AppCompatActivity implements View.OnClickListener {
private static final String TAG = "MainActivity";
private TextView mTvMessage;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initContentView();
// 注册订阅者
EventBus.getDefault().register(this);
}
private void initContentView() {
Button btnStart = findViewById(R.id.btn_main_start_activity);
mTvMessage = findViewById(R.id.tv_main_message);
btnStart.setOnClickListener(this);
}
@Override
public void onClick(View v) {
if (v.getId() == R.id.btn_main_start_activity) {
SecondActivity.start(this);
}
}
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {
Log.i(TAG, "message is " + event.getMessage());
// 更新界面
mTvMessage.setText(event.getMessage());
}
@Override
protected void onDestroy() {
super.onDestroy();
// 注销订阅者
EventBus.getDefault().unregister(this);
}
}
MainActivity订阅了MessageEvent事件。当接收到MessageEvent事件时,订阅者方法将打印日志消息,并更新界面上的TextView。
发布事件的代码如下所示:public class SecondActivity extends AppCompatActivity implements View.OnClickListener {
public static void start(Context context) {
Intent intent = new Intent(context, SecondActivity.class);
context.startActivity(intent);
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_second);
initContentView();
}
private void initContentView() {
findViewById(R.id.btn_second_post_event).setOnClickListener(this);
}
@Override
public void onClick(View v) {
if (v.getId() == R.id.btn_second_post_event) {
// 发布事件
EventBus.getDefault().post(new MessageEvent("Hello EventBus!"));
}
}
}
当点击发布事件的按钮时,SecondActivity将发布一个MessageEvent事件。
运行应用。点击MainActivity界面上的启动活动按钮来启动SecondActivity,然后点击SecondActivity界面上的发布事件按钮来发布事件。最后,回退到MainActivity,可以看到界面上的TextView的内容已经更新为"Hello EventBus!",并且应用打印出如下信息:12-27 20:59:18.919 24705-24705/com.github.cyc.eventbus.basicusedemo I/MainActivity: message is Hello EventBus!
Ok, Eventbus的简单实用就到这里结束了,Eventbus的高级用法请阅读下篇博文: