1.EventBus框架
EventBus，即事件总线，是针对Android跨进程、线程通信的优化方案，在一定程度上可以代替Handle、Intent、Brodcast等实现通信；如下图所示即EventBus的运行框架。
2.EventBus使用了发布者/订阅者模式。
在EventBus中主要有以下三个成员：
①Event：事件，可以自定义为任意对象，类似Message类的作用；
②Publisher：事件发布者，可以在任意线程、任意位置发布Event，已发布的Evnet则由EventBus进行分发；
③Subscriber：事件订阅者，接收并处理事件，需要通过register(this)进行注册，而在类销毁时要使用unregister(this)方法解注册。每个Subscriber可以定义一个或多个事件处理方法，其方法名可以自定义，但需要添加@Subscribe的注解，并指明ThreadMode（不写默认为Posting）。
发布者通过EventBus发布事件，订阅者通过EventBus订阅事件。当发布者发布事件时，订阅该事件的订阅者的事件处理方法将被调用。
3.EventBus使用流程
要使用EventBus，首先需要在build.gradle 中添加EventBus的依赖：
dependencies {
…
compile ‘org.greenrobot:eventbus:3.1.1’
}
接下来开始使用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;
}
}
②订阅事件。订阅者需要定义事件处理方法（也称为订阅者方法）。当发布对应类型的事件时，该方法将被调用。
EventBus3使用 @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!”));
4.实例
下面是一个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) {
Intent intent = new Intent(this, SecondActivity.class);
context.startActivity(intent);
}
}
@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 {
@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!”，并且应用打印出如下信息：
message is Hello EventBus!
5.线程模式
EventBus支持订阅者方法在不同于发布事件所在线程的线程中被调用。你可以使用线程模式来指定调用订阅者方法的线程。
EventBus总共支持5种线程模式：
①ThreadMode.POSTING
订阅者方法将在发布事件所在的线程中被调用。这是 默认的线程模式。事件的传递是同步的，一旦发布事件，所有该模式的订阅者方法都将被调用。这种线程模式意味着最少的性能开销，因为它避免了线程的切换。因此，对于不要求是主线程并且耗时很短的简单任务推荐使用该模式。使用该模式的订阅者方法应该快速返回，以避免阻塞发布事件的线程，这可能是主线程。
②ThreadMode.MAIN
订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。如果发布事件的线程是主线程，那么该模式的订阅者方法将被直接调用。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。
③ThreadMode.MAIN_ORDERED
订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。事件将先进入队列然后才发送给订阅者，这使得事件的处理保持严格的串行顺序。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。
④ThreadMode.BACKGROUND
订阅者方法将在后台线程中被调用。如果发布事件的线程不是主线程，那么订阅者方法将直接在该线程中被调用。如果发布事件的线程是主线程，那么将使用一个单独的后台线程，该线程将按顺序发送所有的事件。使用该模式的订阅者方法应该快速返回，以避免阻塞后台线程。
⑤ThreadMode.ASYNC
订阅者方法将在一个单独的线程中被调用。因此，发布事件的调用将立即返回。如果订阅者方法的执行需要一些时间，例如网络访问，那么就应该使用该模式。避免触发大量的长时间运行的订阅者方法，以限制并发线程的数量。EventBus使用了一个线程池来有效地重用已经完成调用订阅者方法的线程。
下面是一个例子，来说明这五种线程模式的区别。
public class EventBusActivity extends AppCompatActivity {
private static final String TAG = “EventBusActivity”;
private TextView tv_Event;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_event_bus);
/注册事件/
EventBus.getDefault().register(this);
Thread thread1 = new Thread(new myThread1());
thread1.start();
}
/**事件处理方法**/
@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventMain(myEvent me){
Log.d(TAG,me.getmessage() + " onEventMain" + " thread:" + android.os.Process.myTid());
}
/事件处理方法/
@Subscribe(threadMode=ThreadMode.MAIN_ORDERED)
public void onEventMainOrdered(myEvent me){
Log.d(TAG,me.getmessage() + " onEventMainOrdered" + " thread:" + android.os.Process.myTid());
}
/事件处理方法/
@Subscribe(threadMode=ThreadMode.POSTING)
public void onEventPosting(myEvent te){
Log.d(TAG,te.getmessage() + " onEventPosting" + " thread:" + android.os.Process.myTid());
}
/事件处理方法/
@Subscribe(threadMode=ThreadMode.BACKGROUND)
public void onEventBackground(myEvent me){
Log.d(TAG,me.getmessage() + " onEventBackground" + " thread:" + android.os.Process.myTid());
}
/事件处理方法/
@Subscribe(threadMode=ThreadMode.ASYNC)
public void onEventAsync(myEvent me){
Log.d(TAG,me.getmessage() + " onEventAsync" + " thread:" + android.os.Process.myTid());
}
@Override
protected void onDestroy() {
super.onDestroy();
/解注册/
EventBus.getDefault().unregister(this);
}
public class myThread1 implements Runnable {
@Override
public void run() {
Log.d(TAG,"" + android.os.Process.myTid());
try {
Thread.sleep(1000);
/事件发布/
EventBus.getDefault().post(new myEvent(“this is first message !”));
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
执行结果如下：
05-24 17:17:47.335 24447 24478 D EventBusActivity: 24478
05-24 17:17:48.341 24447 24478 D EventBusActivity: this is first message ! onEventBackground thread:24478
05-24 17:17:48.341 24447 24498 D EventBusActivity: this is first message ! onEventAsync thread:24498
05-24 17:17:48.342 24447 24447 D EventBusActivity: this is first message ! onEventMain thread:24447
05-24 17:17:48.342 24447 24447 D EventBusActivity: this is first message ! onEventMainOrdered thread:24447
05-24 17:17:48.344 24447 24478 D EventBusActivity: this is first message ! onEventPosting thread:24478
??主线程Tid为24447，子线程Tid为24478，可以看到每种ThreadMode的运行方式。
??另外我们可以通过定义不同的事件类作为post的参数来执行不同的事件执行方法。
??
6.EventBus的粘性事件
??以上的Demo中，事件订阅者的注册必须在发布事件之前，否则发布之后，订阅者无法接受到事件，而粘性事件则避免了这一问题。
??如果先发布了事件，然后有订阅者订阅了该事件，那么除非再次发布该事件，否则订阅者将永远接收不到该事件。此时，可以使用粘性事件。发布一个粘性事件之后，EventBus将在内存中缓存该粘性事件。当有订阅者订阅了该粘性事件，订阅者将接收到该事件。
??粘性事件的发布使用postSticky()方法即可，并在注解中配置sticky参数。
??
// 订阅粘性事件
@Subscribe(sticky = true)
public void onMessageEvent(MessageEvent event) {
…
}
// 发布粘性事件
EventBus.getDefault().postSticky(new MessageEvent(“Hello EventBus!”));
发布一个粘性事件之后，EventBus将一直缓存该粘性事件。如果想要移除粘性事件，那么可以使用如下方法：
// 移除指定的粘性事件
removeStickyEvent(Object event);
// 移除指定类型的粘性事件
removeStickyEvent(Class eventType);
// 移除所有的粘性事件
removeAllStickyEvents();
下面是一个粘性事件的例子。
发布粘性事件的代码如下所示：
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initContentView();
}
private void initContentView() {
findViewById(R.id.btn_main_post_event).setOnClickListener(this);
findViewById(R.id.btn_main_start_activity).setOnClickListener(this);
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn_main_post_event:
// 发布粘性事件
EventBus.getDefault().postSticky(new MessageEvent(“Hello EventBus!”));
break;
case R.id.btn_main_start_activity:
Intent intent = new Intent(this, SecondActivity.class);
context.startActivity(intent);
break;
default:
break;
}
}
}
当点击发布粘性事件的按钮时，MainActivity将发布一个MessageEvent粘性事件。
订阅粘性事件的代码如下所示：
public class SecondActivity extends AppCompatActivity {
private static final String TAG = “SecondActivity”;
private TextView mTvMessage;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_second);
initContentView();
// 注册订阅者
EventBus.getDefault().register(this);
}
private void initContentView() {
mTvMessage = findViewById(R.id.tv_second_message);
}
@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onMessageEvent(MessageEvent event) {
Log.i(TAG, "message is " + event.getMessage());
// 更新界面
mTvMessage.setText(event.getMessage());
// 移除粘性事件 EventBus.getDefault().removeStickyEvent(event);
}
@Override
protected void onDestroy() {
super.onDestroy();
// 注销订阅者
EventBus.getDefault().unregister(this);
}
}
SecondActivity订阅了MessageEvent粘性事件。当接收到MessageEvent粘性事件时，订阅者方法将打印日志消息，并更新界面上的TextView，最后移除该粘性事件。
运行应用。先点击MainActivity界面上的发布粘性事件按钮来发布粘性事件，然后点击启动活动按钮来启动SecondActivity。可以看到SecondActivity界面上的TextView的内容更新为”Hello EventBus!”，并且应用打印出如下信息：
message is Hello EventBus!
7.事件优先级
EventBus支持在定义订阅者方法时指定事件传递的优先级。默认情况下，订阅者方法的事件传递优先级为0。数值越大，优先级越高。在相同的线程模式下，更高优先级的订阅者方法将优先接收到事件。
注意：优先级只有在相同的线程模式下才有效。
指定事件传递优先级的示例代码如下所示：
@Subscribe(priority = 1)
public void onMessageEvent(MessageEvent event) {
…
}
你可以在高优先级的订阅者方法接收到事件之后取消事件的传递。此时，低优先级的订阅者方法将不会接收到该事件。
注意： 订阅者方法只有在线程模式为ThreadMode.POSTING时，才可以取消一个事件的传递。
取消事件传递的示例代码如下所示：
@Subscribe(threadMode = ThreadMode.POSTING, priority = 1)
public void onMessageEvent(MessageEvent event) {
…
// 取消事件传递
EventBus.getDefault().cancelEventDelivery(event);
}
下面是一个例子。
订阅事件的代码:
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
private static final String TAG = “MainActivity”;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initContentView();
// 注册订阅者
EventBus.getDefault().register(this);
}
private void initContentView() {
findViewById(R.id.btn_main_start_activity).setOnClickListener(this);
}
@Override
public void onClick(View v) {
if (v.getId() == R.id.btn_main_start_activity) {
Intent intent = new Intent(this, SecondActivity.class);
context.startActivity(intent);
}
}
@Subscribe(threadMode = ThreadMode.POSTING, priority = 1)
public void onMessageEvent1(MessageEvent event) {
Log.i(TAG, "onMessageEvent1(), message is " + event.getMessage());
}
@Subscribe(threadMode = ThreadMode.POSTING, priority = 2)
public void onMessageEvent2(MessageEvent event) {
Log.i(TAG, "onMessageEvent2(), message is " + event.getMessage());
// 取消事件
EventBus.getDefault().cancelEventDelivery(event);
}
@Subscribe(threadMode = ThreadMode.POSTING, priority = 3)
public void onMessageEvent3(MessageEvent event) {
Log.i(TAG, "onMessageEvent3(), message is " + event.getMessage());
}
@Subscribe(threadMode = ThreadMode.POSTING, priority = 4)
public void onMessageEvent4(MessageEvent event) {
Log.i(TAG, "onMessageEvent4(), message is " + event.getMessage());
}
@Subscribe(threadMode = ThreadMode.POSTING, priority = 5)
public void onMessageEvent5(MessageEvent event) {
Log.i(TAG, "onMessageEvent5(), message is " + event.getMessage());
}
@Override
protected void onDestroy() {
super.onDestroy();
// 注销订阅者
EventBus.getDefault().unregister(this);
}
}
MainActivity订阅了MessageEvent事件，定义了5个不同优先级的订阅者方法。当接收到MessageEvent事件时，订阅者方法将打印日志消息。优先级为2的订阅者方法在接收到事件之后取消了事件的传递。
发布事件的代码如下所示：
public class SecondActivity extends AppCompatActivity implements View.OnClickListener {
@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界面上的发布事件按钮来发布事件。应用打印出如下信息：
onMessageEvent5(), message is Hello EventBus!
onMessageEvent4(), message is Hello EventBus!
onMessageEvent3(), message is Hello EventBus!
onMessageEvent2(), message is Hello EventBus!
可见，优先级为2的订阅者方法在接收到事件之后取消了事件的传递，因此优先级为1的订阅者方法接收不到事件了。