EventBus基本用法

来点闲白
 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内容发生改变,显示“黏性事件”,说明黏性时间被成功接受到了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容

  • 概述 EventBus是一个Android事件发布/订阅框架,通过解耦发布者和订阅者简化Android事件传递,这...
    々志尚阅读 420评论 0 0
  • EventBus用法及源码解析目录介绍1.EventBus简介1.1 EventBus的三要素1.2 EventB...
    杨充211阅读 1,884评论 0 4
  • EventBus是在Android中使用到的发布-订阅事件总线框架,基于观察者模式,将事件的发送者和接收者解耦,简...
    BrotherTree阅读 192评论 0 0
  • 前言:EventBus出来已经有一段时间了,github上面也有很多开源项目中使用了EventBus。所以抽空学习...
    Kerry202阅读 1,282评论 1 2
  • EventBus 是一款在 Android 开发中使用的发布/订阅事件总线框架,基于观察者模式,将事件的接收者和发...
    MonkeyLqj阅读 10,357评论 3 31