Android 事件传递——EventBus框架的使用

前言

EventBus是一个用于简化Andorid、Fragment、Threads、Service之间信息传递的一个发布/订阅事件集。
使用EventBus的建议：

    并不建议将应用中所有的事件都通过EventBus进行发送，尤其对于一对一的组件之间通信，建议不要使用EventBus。EventBus的使用场景更像是一种广播，当我们向EventBus发送一个事件，则该事件将会传递给多个该事件的订阅者，比如Service向Activities发送事件。跟LoacalBroadCast有点近似。

Github地址

 

EventBus的使用

AS中添加gradle依赖：

dependencies {
    implementation 'org.greenrobot:eventbus:3.1.1'
}

如果需要混淆，则需要在proguard-rules.pro中添加对应的混淆规则：

-keepattributes *Annotation*
-keepclassmembers class ** {
    @org.greenrobot.eventbus.Subscribe ;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }

EventBus的使用基本上分为简单的3个步骤：定义事件、订阅和取消订阅、注册事件订阅者、发布事件。

1.自定义一个事件：

public class BaseEvent {
    private int code;
    private T data;

    public BaseEvent(int code) {
        this.code = code;
    }

    public BaseEvent(int code, T data) {
        this.code = code;
        this.data = data;
    }


    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }


    @Override
    public String toString() {
        return "BaseEvent{" +
                "code=" + code +
                ", data=" + data +
                '}';
    }
}

2.订阅与解除订阅

EventBus的订阅和解除订阅需要成对出现，一般在onCreate和onDestroy方法，或者在onStart和onStop方法中。

public class MainActivity 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);
    }
}

3.注册事件订阅者

@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(BaseEvent event) {
    //消息处理
}

这里方法名可以任意取，但必须添加@Subscribe注解（这里指定线程模型为主线程），方法参数即前面自定义的事件类。

EventBus线程模式

EventBus支持订阅者和发布者在不同的线程中调用。你可以使用线程模式来指定调用订阅者方法的线程。EventBus总共支持5种线程模式：

• ThreadMode.POSTING 订阅者方法将在发布事件所在的线程中被调用。这是 默认的线程模式。事件的传递是同步的，一旦发布事件，所有该模式的订阅者方法都将被调用。这种线程模式意味着最少的性能开销，因为它避免了线程的切换。因此，对于不要求是主线程并且耗时很短的简单任务推荐使用该模式。使用该模式的订阅者方法应该快速返回，以避免阻塞发布事件的线程，这可能是主线程。
• ThreadMode.MAIN 订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。如果发布事件的线程是主线程，那么该模式的订阅者方法将被直接调用。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。
• ThreadMode.MAIN_ORDERED 订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。事件将先进入队列然后才发送给订阅者，所以发布事件的调用将立即返回。这使得事件的处理保持严格的串行顺序。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。
• ThreadMode.BACKGROUND 订阅者方法将在后台线程中被调用。如果发布事件的线程不是主线程，那么订阅者方法将直接在该线程中被调用。如果发布事件的线程是主线程，那么将使用一个单独的后台线程，该线程将按顺序发送所有的事件。使用该模式的订阅者方法应该快速返回，以避免阻塞后台线程。
• ThreadMode.ASYNC 订阅者方法将在一个单独的线程中被调用。因此，发布事件的调用将立即返回。如果订阅者方法的执行需要一些时间，例如网络访问，那么就应该使用该模式。避免触发大量的长时间运行的订阅者方法，以限制并发线程的数量。EventBus使用了一个线程池来有效地重用已经完成调用订阅者方法的线程

4.发布事件

EventBus.getDefault().post(new BaseEvent(1,"Hello EventBus!"));

 

5.订阅事件的优先级

 事件的优先级类似广播的优先级，优先级越高优先获得消息

  @Subscribe(threadMode = ThreadMode.MAIN,priority = 100) //在ui线程执行 优先级100
    public void onDataSynEvent(BaseEvent event) {
        Log.e(TAG, "event---->" + event.toString());
    }

 

6.终止事件往下传递

 发送有序广播可以终止广播的继续往下传递，EventBus也实现了此功能

 EventBus.getDefault().cancelEventDelivery(event) ;//优先级高的订阅者可以终止事件往下传递

 

EventBus粘性事件

EventBus粘性事件所处理的问题是：发布者先发送了事件，但是此时订阅者还未产生，一段时间后订阅者才订阅了该事件，也就是使得在发送事件之后订阅者再订阅该事件也能收到该事件。

比如需求是在第一个Activity中发送事件，然后启动第二个Activity接收事件进行处理 ，但此时在打开第二个Activity时是接收不到消息的，主要是因为第二个Activity在第一个Activity发送事件时还未完成EventBus的注册，此时就需要使用粘性事件处理。

接收粘性事件的订阅者方法注解必须添加sticky = true属性：

@Subscribe(threadMode = ThreadMode.MAIN,sticky = true) //在ui线程执行
    public void onDataSynEvent(BaseEvent event) {
        Log.e(TAG, "event---->" + event.toString());
    }

发布粘性事件使用postSticky():

EventBus.getDefault().postSticky(new BaseEvent(1,"Hello EventBus!"));

发布一个粘性事件之后，EventBus将一直缓存该粘性事件。如果想要移除粘性事件，那么可以使用如下方法：

// 移除指定的粘性事件
removeStickyEvent(Object event);
// 移除指定类型的粘性事件
removeStickyEvent(Class eventType);
// 移除所有的粘性事件
removeAllStickyEvents();

例子：
点击MainActivity的按钮时，先发送一个粘性事件，再启动SecondActivity

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.btn_go:
                EventBus.getDefault().postSticky(new BaseEvent(1,"Hello EventBus!"));
                Intent intent = new Intent(this, SecondActivity.class);
                startActivity(intent);
                break;
            default:
                break;
        }
    }

在打开的SecondActivity中订阅该事件：

public class SecondActivity extends Activity {
    private final static String TAG = "SecondActivity";
    private Button mSendBtn;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        initView();
        EventBus.getDefault().register(this);
    }

    private void initView() {
        mSendBtn = (Button) findViewById(R.id.btn_send);
    }

    @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
    public void onMessageEvent(BaseEvent event) {
        Log.i(TAG, "onMessageEvent: " + event.toString());

        // 移除粘性事件
        EventBus.getDefault().removeStickyEvent(event);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }
}