EventBus基本用法

2019-10-30 本文已影响0人 Android流浪者

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

EventBus的三要素：

Event：事件。可以是任意类型的对象。
Subscriber：事件订阅者。在EventBus3.0之前消息处理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，它们分别代表4中线程模型。而在EventBus3.0之后，事件处理的方法可以随便取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTING）。4种线程模型下面会讲到。
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使用起来分为以下5个步骤
（1）自定义一个事件类型

class MessageEvent{}

（2）在需要订阅事件的地方注册事件

EventBus.getDefault().register(this);

（3）发送事件

EventBus.getDefault().post(messageEvent);

（4）处理事件

 @Subscribe(threadMode = ThreadMode.MAIN)
 fun EventMain(messageEvent: MessageEvent){
        ...
 }

前面说过，消息处理的方法可以随便取名，但是需要添加一个注解@Subscriber,并且要指定线程模型（默认为POSTING）。
（5）取消时间订阅

EventBus.getDefault().unregister(this)

EventBus应用
前面说到了EventBus的基本用法，但是这个过于简单，这里举个🍐来应用EventBus。
（1）添加依赖库

implementation 'org.greenrobot:eventbus:3.1.1'

（2）定义消息事件类

class MessageEvent(var message: String?)

（3）注册和取消订阅事件

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        btn_subscription.setOnClickListener {
            EventBus.getDefault().register(this)
            Toast.makeText(this, "注册事件", Toast.LENGTH_LONG).show()
        }
        but_message.setOnClickListener {
            startActivity(Intent(this, SecondActivity::class.java))
        }
    }

   @Subscribe(threadMode = ThreadMode.MAIN)
    fun EventMain(messageEvent: MessageEvent){

    }
    override fun onDestroy() {
        super.onDestroy()
        //取消注册事件
        EventBus.getDefault().unregister(this)
    }
}

在MainActivity中定义两个Button;一个用来注册事件，另一个用来调转到SecondActivity。
（4）事件订阅者处理事件
在MianActivity中自定义方法来处理事件，在这里ThreadMode设置为MAIN，事件会在UI线程中执行，用TextView来展示收到的时间消息：

@Subscribe(threadMode = ThreadMode.MAIN)
fun EventMain(messageEvent: MessageEvent){
   textView.text = messageEvent.message
}

（5）事件发布者发布事件
创建了SecondActivity来发布消息，代码所示：

class SecondActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_second)
        btn_send_message.setOnClickListener {
            //发送事件
            EventBus.getDefault().post(MessageEvent("欢迎来到张三儿的简书"))
            finish()
        }
    }
}

在SecondActivity中，我们定义“事件发送”按钮来发送事件并将SecondActivity finish掉。运行程序。如图所示。接下点击MainAcitivity中的“注册事件”，然后点击“跳转到SECONDACTIVITY”按钮，这时跳转到SecondActivity，如图所示，接下来点击“发送事件”按钮，这个时候SecondActivity被finish掉，因此界面展示的是MainActivity如图所示。可以看到MainActivity的TextView显示“欢迎关注张三儿的简书”，MainActivity成功的接收到了SecondActivity发送的事件。

程序初始样式

调转到SecondActivity

MainActivity接收到事件

（6）ProGuard
最后不要忘记在ProGuard中加入混淆规则:

-keepattributes *Annotation*
-keepclassmembers 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的黏性事件
c除了上面讲到的普通事件外，EventBus还支持发送黏性事件，就是在发送事件之后再订阅该事件也能收到该事件，这跟黏性广播类似，为了验证黏性事件，我们修改下以前的代码。
（1）订阅者处理黏性事件
在MainActivity中新写一个方法用来处理黏性事件：

@Subscribe(threadMode = ThreadMode.POSTING,sticky = true)
 fun ononMoonStickyEvent(messageEvent: MessageEvent){
        textView.text = messageEvent.message
 }

（2）发送黏性事件
在SecondActivity中定义一个Button来发送黏性事件：

btn_send_message.setOnClickListener {
            //发送事件
            EventBus.getDefault().postSticky(MessageEvent("粘性事件"))
            finish()
        }

现在运行代码再来看看效果，首先，在MianActivity中并没点击“注册事件”按钮，而是直接调转到SecondActivity中点击发送“黏性事件”按钮。这时界面回到MianActivity，看到TextView依旧显示着MainActivity的字段，这时因为现在还没有订阅事件。接下来点击“注册事件”按钮，TextView内容发生改变，显示“黏性事件”，说明黏性时间被成功接受到了。

EventBus基本用法

猜你喜欢

热点阅读