EventBus使用详解 - android
前言：EventBus出来已经有一段时间了，github上面也有很多开源项目中使用了EventBus。所以抽空学习顺便整理了一下。
概述
EventBus是针一款对Android的发布/订阅事件总线。它可以让我们很轻松的实现在Android各个组件之间传递消息，并且代码的可读性更好，耦合度更低。
如何使用
(1)首先需要定义一个消息类，该类可以不继承任何基类也不需要实现任何接口。如：
public class MessageEvent { ......}(2)在需要订阅事件的地方注册事件
EventBus.getDefault().register(this);(3)产生事件，即发送消息
EventBus.getDefault().post(messageEvent);(4)处理消息
public void onEvent(MessageEvent messageEvent) { ...}(5)取消消息订阅
EventBus.getDefault().unregister(this);有何优点
采用消息发布/订阅的一个很大的优点就是代码的简洁性，并且能够有效地降低消息发布者和订阅者之间的耦合度。
举个例子，比如有两个界面，ActivityA和ActivityB，从ActivityA界面跳转到ActivityB界面后，ActivityB要给ActivityA发送一个消息，ActivityA收到消息后在界面上显示出来。我们最先想到的方法就是使用广播，使用广播实现此需求的代码如下：
首先需要在ActivityA中定义一个广播接收器：
public class MessageBroadcastReceiver extends BroadcastReceiver { @Override public void onReceive(Context context, Intent intent) { mMessageView.setText("Message from SecondActivity:" + intent.getStringExtra("message")); }}还需要在onCreate()方法中注册广播接收器：
@Overrideprotected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //注册事件 EventBus.getDefault().register(this); //注册广播 IntentFilter intentFilter = new IntentFilter("message_broadcast"); mBroadcastReceiver = new MessageBroadcastReceiver(); registerReceiver(mBroadcastReceiver, intentFilter); ......}然后在onDestory()方法中取消注册广播接收器：
@Overrideprotected void onDestroy() { super.onDestroy(); ...... //取消广播注册 unregisterReceiver(mBroadcastReceiver);}最后我们需要在ActivityB界面中发送广播消息：
findViewById(R.id.send_broadcast).setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { String message = mMessageET.getText().toString(); if(TextUtils.isEmpty(message)) {message = "defaule message"; } Intent intent = new Intent(); intent.setAction("message_broadcast"); intent.putExtra("message", message); sendBroadcast(intent); }});看着上面的实现代码，感觉也没什么不妥，挺好的！下面对比看下使用EventBus如何实现。
根据文章最前面所讲的EventBus使用步骤，首先我们需要定义一个消息事件类：
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; }}在ActivityA界面中我们首先需要注册订阅事件：
@Overrideprotected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //注册事件 EventBus.getDefault().register(this); ......}然后在onDestory()方法中取消订阅：
@Overrideprotected void onDestroy() { super.onDestroy(); //取消事件注册 EventBus.getDefault().unregister(this);}当然还要定义一个消息处理的方法：
public void onEvent(MessageEvent messageEvent) { mMessageView.setText("Message from SecondActivity:" + messageEvent.getMessage());}至此，消息订阅者我们已经定义好了，我们还需要在ActivityB中发布消息：
findViewById(R.id.send).setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { String message = mMessageET.getText().toString(); if(TextUtils.isEmpty(message)) {message = "defaule message"; } EventBus.getDefault().post(new MessageEvent(message)); }});对比代码一看，有人会说了，这尼玛有什么区别嘛！说好的简洁呢？哥们，别着急嘛！我这里只是举了个简单的例子，仅仅从该例子来看，EventBus的优势没有体现出来。现在我将需求稍微改一下，ActivityA收到消息后，需要从网络服务器获取数据并将数据展示出来。如果食用广播，ActivityA中广播接收器代码应该这么写：
public class MessageBroadcastReceiver extends BroadcastReceiver { @Override public void onReceive(Context context, Intent intent) { new Thread(new Runnable() {@Overridepublic void run() { //从服务器上获取数据 ...... runOnUiThread(new Runnable() { @Override public void run() {//将获取的数据展示在界面上...... } });} }).start(); }}看到这段代码，不知道你何感想，反正我是看着很不爽，缩进层次太多，完全违反了Clean Code的原则。那使用EventBus来实现又是什么样呢？我们看一下。
public void onEventBackgroundThread(MessageEvent messageEvent) { //从服务器上获取数据 ...... EventBus.getDefault().post(new ShowMessageEvent());}public void onEventMainThread(ShowMessageEvent showMessageEvent) { //将获取的数据展示在界面上 ......}对比一下以上两段代码就能很明显的感觉到EventBus的优势，代码简洁、层次清晰，大大提高了代码的可读性和可维护性。我这只是简单的加了一个小需求而已，随着业务越来越复杂，使用EventBus的优势愈加明显。
常用API介绍
onEventXXX系列事件
在上面我们已经接触到了EventBus的几个onEventXXX系列方法了。那他们有什么区别呢？
在EventBus中的观察者通常有四种事件处理函数，分别是onEvent、onEventMainThread、onEventBackground与onEventAsync。
onEvent：如果使用onEvent作为事件处理函数，那么该事件在哪个线程发布出来的，onEvent就会在这个线程中运行，也就是说发布事件和接收事件在同一个线程。在onEvent方法中尽量避免执行耗时操作，因为有可能会引起ANR。
onEventMainThread：如果使用onEventMainThread作为事件处理函数，那么不论事件是在哪个线程中发布出来的，该事件处理函数都会在UI线程中执行。该方法可以用来更新UI，但是不能处理耗时操作。
onEvnetBackground：如果使用onEventBackgrond作为事件处理函数，那么如果事件是在UI线程中发布出来的，那么该事件处理函数就会在新的线程中运行，如果事件本来就是子线程中发布出来的，那么该事件处理函数直接在发布事件的线程中执行。
onEventAsync：使用这个函数作为事件处理函数，那么无论事件在哪个线程发布，该事件处理函数都会在新建的子线程中执行。
为了验证以上四个方法，我写了个小例子。
public void onEvent(MessageEvent messageEvent) { Log.e("onEvent", Thread.currentThread().getName());}public void onEventMainThread(MessageEvent messageEvent) { Log.e("onEventMainThread", Thread.currentThread().getName());}public void onEventBackgroundThread(MessageEvent messageEvent) { Log.e("onEventBackgroundThread", Thread.currentThread().getName());}public void onEventAsync(MessageEvent messageEvent) { Log.e("onEventAsync", Thread.currentThread().getName());}分别使用上面四个方法订阅同一事件，打印他们运行所在的线程。首先我们在UI线程中发布一条MessageEvent的消息，看下日志打印结果是什么。
findViewById(R.id.send).setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) {Log.e("postEvent", Thread.currentThread().getName());EventBus.getDefault().post(new MessageEvent()); } });打印结果如下：
2689-2689/com.lling.eventbusdemo E/postEvent﹕ main2689-2689/com.lling.eventbusdemo E/onEvent﹕ main2689-3064/com.lling.eventbusdemo E/onEventAsync﹕ pool-1-thread-12689-2689/com.lling.eventbusdemo E/onEventMainThread﹕ main2689-3065/com.lling.eventbusdemo E/onEventBackgroundThread﹕ pool-1-thread-2从日志打印结果可以看出，如果在UI线程中发布事件，则onEvent也执行在UI线程，与发布事件的线程一致。onEventAsync执行在名字叫做pool-1-thread-1的新的线程中。onEventMainThread执行在UI线程。onEventBackgroundThread执行在名字叫做pool-1-thread-2的新的线程中。
我们再看看在子线程中发布一条MessageEvent的消息时，会有什么样的结果。
findViewById(R.id.send).setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) {new Thread(new Runnable() { @Override public void run() { Log.e("postEvent", Thread.currentThread().getName()); EventBus.getDefault().post(new MessageEvent()); }}).start(); } });打印结果如下：
3468-3945/com.lling.eventbusdemo E/postEvent﹕ Thread-1253468-3945/com.lling.eventbusdemo E/onEvent﹕ Thread-1253468-3945/com.lling.eventbusdemo E/onEventBackgroundThread﹕ Thread-1253468-3946/com.lling.eventbusdemo E/onEventAsync﹕ pool-1-thread-13468-3468/com.lling.eventbusdemo E/onEventMainThread﹕ main从日志打印结果可以看出，如果在子线程中发布事件，则onEvent也执行在子线程，与发布事件的线程一致（都是Thread-125）。onEventBackgroundThread也与发布事件在同一线程执行。onEventAsync则在一个名叫pool-1-thread-1的新线程中执行。onEventMainThread还是在UI线程中执行。
上面一个例子充分验证，onEventXXX系列方法执行所在的线程。
黏性事件
除了上面讲的普通事件外，EventBus还支持发送黏性事件。何为黏性事件呢？简单讲，就是在发送事件之后再订阅该事件也能收到该事件，跟黏性广播类似。具体用法如下：
订阅黏性事件：
EventBus.getDefault().registerSticky(StickyModeActivity.this);发送黏性事件：
EventBus.getDefault().postSticky(new MessageEvent("test"));处理消息事件以及取消订阅和上面方式相同。
看个简单的黏性事件的例子，为了简单起见我这里就在一个Activity里演示了。
Activity代码：
public class StickyModeActivity extends AppCompatActivity { int index = 0; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_sticky_mode); findViewById(R.id.post).setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) { EventBus.getDefault().postSticky(new MessageEvent("test" + index++));} }); findViewById(R.id.regist).setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) { EventBus.getDefault().registerSticky(StickyModeActivity.this);} }); findViewById(R.id.unregist).setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) { EventBus.getDefault().unregister(StickyModeActivity.this);} }); } public void onEvent(MessageEvent messageEvent) { Log.e("onEvent", messageEvent.getMessage()); } public void onEventMainThread(MessageEvent messageEvent) { Log.e("onEventMainThread", messageEvent.getMessage()); } public void onEventBackgroundThread(MessageEvent messageEvent) { Log.e("onEventBackgroundThread", messageEvent.getMessage()); } public void onEventAsync(MessageEvent messageEvent) { Log.e("onEventAsync", messageEvent.getMessage()); }}布局代码activity_sticky_mode.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:paddingLeft="@dimen/activity_horizontal_margin" android:paddingRight="@dimen/activity_horizontal_margin" android:paddingTop="@dimen/activity_vertical_margin" android:paddingBottom="@dimen/activity_vertical_margin" android:orientation="vertical" tools:context="com.lling.eventbusdemo.StickyModeActivity"> <Button android:id="@+id/post" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="Post"/> <Button android:id="@+id/regist" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="Regist"/> <Button android:id="@+id/unregist" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="UnRegist"/></LinearLayout>代码很简单，界面上三个按钮，一个用来发送黏性事件，一个用来订阅事件，还有一个用来取消订阅的。首先在未订阅的情况下点击发送按钮发送一个黏性事件，然后点击订阅，会看到日志打印结果如下：
15246-15246/com.lling.eventbusdemo E/onEvent﹕ test015246-15391/com.lling.eventbusdemo E/onEventAsync﹕ test015246-15246/com.lling.eventbusdemo E/onEventMainThread﹕ test015246-15393/com.lling.eventbusdemo E/onEventBackgroundThread﹕ test0这就是粘性事件，能够收到订阅之前发送的消息。但是它只能收到最新的一次消息，比如说在未订阅之前已经发送了多条黏性消息了，然后再订阅只能收到最近的一条消息。这个我们可以验证一下，我们连续点击5次POST按钮发送5条黏性事件，然后再点击REGIST按钮订阅，打印结果如下：
6980-6980/com.lling.eventbusdemo E/onEvent﹕ test46980-6980/com.lling.eventbusdemo E/onEventMainThread﹕ test46980-7049/com.lling.eventbusdemo E/onEventAsync﹕ test46980-7048/com.lling.eventbusdemo E/onEventBackgroundThread﹕ test4由打印结果可以看出，确实是只收到最近的一条黏性事件。
好了，EventBus的使用暂时分析到这里，例子代码从这里获取。下一讲将讲解EventBus的源码。
本文首发：http://liuling123.com/2016/01/EventBus-explain.html