EventBus 使用详解(一)——初步使用 EventBus
- 概述
- 导入 EventBus 的类库
- 基本使用
- 实战
- 在要接收消息的页面注册 EventBus
- 发送消息
- 接收消息
- 使用 Sticky Events
概述
EventBus是一款针对Android优化的发布/订阅事件总线。主要功能是替代Intent,Handler,BroadCast在Fragment，Activity，Service，线程之间传递消息.优点是开销小，代码更优雅。以及将发送者和接收者解耦。
导入 EventBus 的类库
源码：https://github.com/greenrobot/EventBus
基本使用
（1）自定义一个类，可以是空类，比如：
public class AnyEventType {
public AnyEventType(){}
}
（2）在要接收消息的页面注册：
eventBus.register(this);
（3）发送消息：
eventBus.post(new AnyEventType event);
（4）接收消息的页面实现(共有四个函数，各功能不同，这是其中之一，可以选择性的实现，这里先实现一个)：
public void onEvent(AnyEventType event) {}
（5）解除注册：
eventBus.unregister(this);
下面举个例子来说明下：
首先，在 EventBus 中，获取实例的方法一般是采用 EventBus.getDefault() 来获取默认的 EventBus 实例，当然你也可以 new 一个又一个，个人感觉还是用默认的比较好，以防出错。
实战
先给大家看个例子：
当击 btn_try 按钮的时候，跳到第二个 Activity，当点击第二个 activity 上面的 First Event 按钮的时候向第一个 Activity 发送消息，当第一个 Activity 收到消息后，一方面将消息Toast显示，一方面放入 TextView 中显示。
按照下面的步骤，下面来建这个工程：
1、基本框架搭建
想必大家从一个 Activity 跳转到第二个 Activity 的程序应该都会写，这里先稍稍把两个 Activity 跳转的代码建起来。后面再添加 EventBus 相关的玩意。
MainActivity布局（activity_main.xml）
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<Button
android:id="@+id/btn_try"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="btn_bty"/>
<TextView
android:id="@+id/tv"
android:layout_width="wrap_content"
android:layout_height="match_parent"/>
LinearLayout>
新建一个Activity，SecondActivity布局（activity_second.xml）
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
tools:context="com.harvic.try_eventbus_1.SecondActivity" >
<Button
android:id="@+id/btn_first_event"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="First Event"/>
LinearLayout>
MainActivity.java （点击btn跳转到第二个Activity）
public class MainActivity extends Activity {
Button btn;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
btn = (Button) findViewById(R.id.btn_try);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// TODO Auto-generated method stub
Intent intent = new Intent(getApplicationContext(),
SecondActivity.class);
startActivity(intent);
}
});
}
}
到这，基本框架就搭完了，下面开始按步骤使用 EventBus 了。
public class FirstEvent {
private String mMsg;
public FirstEvent(String msg) {
// TODO Auto-generated constructor stub
mMsg = msg;
}
public String getMsg(){
return mMsg;
}
}
这个类很简单，构造时传进去一个字符串，然后可以通过 getMsg() 获取出来。
在要接收消息的页面注册 EventBus
在上面的GIF图片的演示中，大家也可以看到，我们是要在 MainActivity 中接收发过来的消息的，所以我们在 MainActivity 中注册消息。
通过我们会在 OnCreate() 函数中注册 EventBus ，在 OnDestroy（）函数中反注册。所以整体的注册与注销的代码如下：
public class MainActivity extends Activity {
Button btn;
TextView tv;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
//注册EventBus
EventBus.getDefault().register(this);
btn = (Button) findViewById(R.id.btn_try);
tv = (TextView)findViewById(R.id.tv);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// TODO Auto-generated method stub
Intent intent = new Intent(getApplicationContext(),
SecondActivity.class);
startActivity(intent);
}
});
}
@Override
protected void onDestroy(){
super.onDestroy();
EventBus.getDefault().unregister(this);//反注册EventBus
}
}
发送消息
发送消息是使用 EventBus 中的 Post 方法来实现发送的，发送过去的是我们新建的类的实例！
EventBus.getDefault().post(new FirstEvent("FirstEvent btn clicked"));
完整的 SecondActivity.java 的代码如下：
public class SecondActivity extends Activity {
private Button btn_FirstEvent;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_second);
btn_FirstEvent = (Button) findViewById(R.id.btn_first_event);
btn_FirstEvent.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// TODO Auto-generated method stub
EventBus.getDefault().post(
new FirstEvent("FirstEvent btn clicked"));
finish();
}
});
}
}
接收消息
接收消息时，我们使用 EventBus 中最常用的 onEventMainThread() 函数来接收消息，具体为什么用这个，我们下篇再讲，这里先给大家一个初步认识，要先能把 EventBus 用起来先。
在 MainActivity 中重写 onEventMainThread(FirstEvent event)，参数就是我们自己定义的类：
在收到 Event 实例后，我们将其中携带的消息取出，一方面 Toast 出去，一方面传到 TextView 中；
public void onEventMainThread(FirstEvent event) {
String msg = "onEventMainThread收到了消息：" + event.getMsg();
Log.d("harvic", msg);
tv.setText(msg);
Toast.makeText(this, msg, Toast.LENGTH_LONG).show();
}
完整的MainActiviy代码如下：
public class MainActivity extends Activity {
Button btn;
TextView tv;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
EventBus.getDefault().register(this);
btn = (Button) findViewById(R.id.btn_try);
tv = (TextView)findViewById(R.id.tv);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// TODO Auto-generated method stub
Intent intent = new Intent(getApplicationContext(),
SecondActivity.class);
startActivity(intent);
}
});
}
public void onEventMainThread(FirstEvent event) {
String msg = "onEventMainThread收到了消息：" + event.getMsg();
Log.d("harvic", msg);
tv.setText(msg);
Toast.makeText(this, msg, Toast.LENGTH_LONG).show();
}
@Override
protected void onDestroy(){
super.onDestroy();
EventBus.getDefault().unregister(this);
}
}
使用 Sticky Events
某些时候，我们并不希望发布出来的 Event 立即被消费掉，而是等到时机成熟。比如说，在一个详情页点赞之后，产生一个 VoteEvent，VoteEvent 并不立即被消费，而是等用户退出详情页回到商品列表之后，接收到该事件，然后刷新 Adapter 等。其实这就是之前我们用 startActivityForResult 和 onActivityResult 做的事情。
sticky：指在 EventBus 内部被缓存的那些事件。EventBus 为每个类（class）类型保存了最近一次被发送的事件——sticky。后续被发送过来的相同类型的 sticky 事件会自动替换之前缓存的事件。当一个监听者向EventBus进行注册时，它可能会去请求这些缓存事件。这时，所有已缓存的事件就会立即自动发送给这个监听者，就象这些事件又重新刚被发送了一次一样。这就意味着，一个监听者可以收到在它注册之前就已经被发送到 EventBus中 的事件（甚至是在这个监听者的实例被创建出来前，这一点是不是很奇妙）。这一强大功能将有助于我们解决某些固有的问题，如 Android 上跨 Activity 和 Fragment 生命周期传递数据这种复杂问题，异步调用等等。
和普通的Event不同，当发布一个 Sticky Event，需要使用 postSticky 方法：
EventBus.getDefault().postSticky(new VoteEvent(obj));
上面的代码发布了一个点赞的 Sticky Event.
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Override
public void onStart() {
super.onStart();
EventBus.getDefault().registerSticky(this);
}
public void onEventMainThread(VoteEvent event) {
// TODO update adapter
}
@Override
public void onStop() {
EventBus.getDefault().unregister(this);
super.onStop();
}
上面的代码则是在对应的列表页面，onStart 方法调用了 EventBus 的 registerSticky 方法，该方法在每次执行的时候，都回去查询一次 Sticky Event，并调用响应的方法处理。本例中，当列表页面第一次显示的时候，是没有 Sticky Event 的，所以 registerSticky 不会触发任何事件；而当列表页面是由详情页退出后显示出来的话，registerSticky 会触发在详情页 postSticky 的 VoteEvent，而触发 onEventMainThread(VoteEvent) 方法，以达到 onActivityResult 方法的效果。
@Override
public void onResume() {
super.onResume();
VoteEvent voteEvent = EventBus.getDefault().getStickyEvent(VoteEvent.class);
// TODO update adapter if vote event is not null.
}
我们可以在每次的 onResume 方法里面检查 EventBus 里面是否有 VoteEvent 的 Sticky Event，从而进行处理。
sticky 事件在缓存中存在的时间并不确定。所以如果你想在某一时刻消除缓存中的事件好让它们不再被发送，可以通过 eventBus.removeStickyEvent(event)或 eventBus.removeStickyEvent(SomeEvent.class)，以及 eventBus.removeAllStickyEvents() 来实现。
好了，到这，基本上算初步把 EventBus 用起来了，下篇再讲讲 EventBus 的几个函数，及各个函数间是如何识别当前如何调用哪个函数的。