LiveData的一次性事件封装

前言

LiveData是Google提供的一个数据封装类,值改变的时候会自动通知观察者。

LiveData 是一种可观察的数据存储器类。与常规的可观察类不同,LiveData 具有生命周期感知能力,意指它遵循其他应用组件(如 Activity、Fragment 或 Service)的生命周期。这种感知能力可确保 LiveData 仅更新处于活跃生命周期状态的应用组件观察者。

为了解决的问题

在MVVM模式中,LiveData+ViewModel是使用非常频繁的组合,有时候我们需要在LiveData值改变的时候通知界面做一些事情,比如页面跳转,弹窗,Toast之类,但是LiveData+Observer的特性是值每次绑定的时候就会触发一次,如果没处理好,就会有莫名其妙的Toast或者页面跳转出问题。

我们可以通过消费掉LiveData值之后置空LiveData,但这完全不优雅,不利于v和vm的分离,界面上不应该操作LiveData的值。

Google建议我们封装一个一次性的LiveData数据。
本文提供一个思路:
对MutableLiveData值进行封装,进一步创建一个MutableLiveData子类OneOffLiveData的方式解决这个问题。

首先,需要只能消耗一次的值

如下,一个封装类OneTimeEvent,通过标志位来判断是否调用过

/**
 * 一次性的事件
 */
class OneTimeEvent<T>(private val event: T) {
    private var flag = true

    /**
     * [func]只会生效一次,
     * [call]和[get]只会成功调用一次
     */
    fun call(func: (T) -> Unit) {
        if (flag) {
            flag = false
            func(event)
        }
    }

    /**
     * 只会得到一次值,
     * [call]和[get]只会成功调用一次
     */
    fun get(): T? = if (flag) {
        flag = false
        event
    } else {
        null
    }
}

两个扩展函数,方便使用该扩展类

/**
 * 返回一个一次性事件的封装对象
 */
fun <T> T.oneOff() = OneTimeEvent(this)

/**
 * 发射一次一次性事件
 */
fun <T> MutableLiveData<OneTimeEvent<T>>.postOneOff(someOneOff: T) {
    this.postValue(OneTimeEvent(someOneOff))
}

使用

object TipDialog {
    val tipDialogLiveData = MutableLiveData<OneTimeEvent<MessageType>>()
}

观察:

TipDialog.tipDialogLiveData.observe(this, Observer { oneTime ->
    oneTime?.call { messageType ->
        ....
    }
}

进一步,把一次性事件封装到LiveData子类

class OneOffLiveData<T> : MutableLiveData<OneTimeEvent<T>>() {
    /**
     * 替代掉LiveData的observe方法
     */
    fun observeOneOff(owner: LifecycleOwner, func: (T?) -> Unit) {
        observe(owner, Observer {
            it?.call(func)
        })
    }
}

使用和原本常用的MutableLiveData基本一致

object TipDialog {
    val tipDialogLiveData = OneOffLiveData<Message>()
}

观察:

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

推荐阅读更多精彩内容