EventBus事件总线

一、解析EventBus

EventBus是一款针对Android优化的发布-订阅事件总线。它简化了应用程序内各组件间、组件与后台线程间的通信、其优点是开销小，代码更优雅，以及将发送者和接受者解耦。如果Activity和Activity进行交互还好说，但如果Fragment和Fragment进行交互则着实令人头疼。这时我们会使用广播来处理，但是使用广播略显麻烦并且效率也不高。如果传递的数据是实体类，需要序列化，那么传递的成本会有点高。

在讲到EventBus的基本用法之前，我们需要了解EventBus的三要素以及它的4种ThreadMode。

EventBus的三要素如下：

Event	事件。可以是任意类型的对象。
Subscriber	事件订阅者。在EventBus 3.0之前消息处理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，它们分别代表4种线程模式。而在EventBus 3.0之后，事件处理的方法可以随意取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTIND）。
Publisher	事件发布者。可以在任意线程任意位置发送事件，直接调用EventBus的post(Object)方法。可以自己实例化EventBus对象，但一般使用EventBus.getDefault()就可以。根据post函数参数的类型，会自动调用订阅相应类型事件的函数。

EventBus的4种ThreadMode（线程模型）如下。

POSTING（默认）	如果使用事件处理函数指定了线程模型为POSTING，那么该事件是在哪个线程发布出来的，事件处理函数就会在哪个线程中运行，也就是说发布事件和接收事件在同一个线程中。在线程模式为POSTING的事件处理函数中尽量避免执行耗时操作，因为它会阻塞事件的传递，甚至有可能会引起ANR。
MAIN	事件的处理会在UI线程中执行。事件处理的时间不能太长，长了会导致ANR
BACKGROUND	如果事件是在UI线程中发布出来的，那么该事件处理函数就会在新的线程中运行；如果事件本来就是在子线程中发布出来的，那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。
ASYNC	无论事件在哪个线程中发布，该事件处理函数都会在新建的子线程中执行；同样，此事件处理函数中禁止进行UI更新操作。

二、使用EventBus

下面通过一个例子来应用EventBus：

(1) 添加依赖库

在Module:app的build.gradle中添加依赖：

implementation 'org.greenrobot:eventbus:3.1.1'

(2) 定义消息事件类

public class MessageEvent {

    private String message;

    public MessageEvent(String messgae) {
        this.message = messgae;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

(3)注册和取消订阅事件

在MainActivity中注册和取消订阅事件，如下所示：

public class MainActivity extends AppCompatActivity {

    private TextView tv_message;
    private Button btn_message;
    private Button btn_subscription;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        tv_message = findViewById(R.id.tv_message);
        tv_message.setText("MainActivity");
        btn_subscription = findViewById(R.id.btn_subscription);
        btn_subscription.setText("注册事件");
        btn_message = findViewById(R.id.btn_message);
        btn_message.setText("跳转到SecondActivity");
        btn_message.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startActivity(new Intent(MainActivity.this, SecondActivity.class));
            }
        });

        btn_subscription.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //注册事件
                EventBus.getDefault().register(MainActivity.this);
            }
        });
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //取消注册事件
        EventBus.getDefault().unregister(this);
    }

}

在MainActivity中定义了两个button；一个用来注册事件，另一个用来跳转到SecondActivity。

(4) 事件订阅者处理事件

在MainActivity中自定义方法来处理事件，在这里ThreadMode设置为MAIN，事件会在UI线程中执行，用TextView来展示收到的事件消息：

@Subscribe(threadMode = ThreadMode.MAIN)
public void onMoonEvent(MessageEvent messageEvent) {
    tv_message.setText(messageEvent.getMessage());
}

(5) 事件发布者发布事件

创建SeconActivity来发布消息，代码如下所示：

public class SecondActivity extends AppCompatActivity {

    private Button btn_message;
    private TextView tv_message;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);

        tv_message = findViewById(R.id.tv_message);
        tv_message.setText("SecondActivity");
        btn_message = findViewById(R.id.btn_message);
        btn_message.setText("发送事件");
        btn_message.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getDefault().post(new MessageEvent("这是一条发送出来的消息"));
                finish();
            }
        });
    }
}

在SecondActivity中，我们定义“发送事件”按钮来发送事件并将SeconActivity finish掉。运行程序，先点击“注册事件”按钮来注册事件，然后点击"跳转到SecondActivity"按钮跳转，然后点击“发送事件”按钮，MainActivity的TextView中显示出接到的消息内容。

(6)混淆规则

最后在proguard-rules.pro中加入如下混淆规则：

-keepattributes *Annotation*
-keepclasseswithmembers class ** {
    @org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *;}
#Only required if you use AsyncExecutor
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
    <init>(java.lang.Throwable);
}

三、EventBus的粘性事件

除了上面讲的普通事件外，EventBus还支持发送粘性事件，就是在发送事件之后再订阅该事件也能收到该事件，这跟粘性广播类似。为了验证粘性事件，我们修改以前的代码，如下所示：

(1) 订阅者处理粘性事件

在MainActivity中新写一个方法用来处理粘性事件

@Subscribe(threadMode = ThreadMode.POSTING, sticky = true)
public void onMoonStickyEvent(MessageEvent messageEvent) {
    tv_message.setText(messageEvent.getMessage());
}

(2) 发送粘性事件

在SeconActivity中定义一个Button来发送粘性事件

btn_message.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        EventBus.getDefault().postSticky(new MessageEvent("粘性事件"));
        finish();
    }
});

效果图如下：