Kotlin Flow封装类SharedFlow StateFlow LiveData使用对比

目录
  • Kotlin中SharedFlow的使用 VS StateFlow
    • SharedFlow的特点
    • 一、SharedFlow的使用
    • 二、SharedFlow、StateFlow、LiveData的对比
    • 三、SharedFlow 的粘性设置与事件总线
  • 总结

Kotlin中SharedFlow的使用 VS StateFlow

SharedFlow 是继承于 Flow ,同时它是 StateFlow 的父类,它们都是是热流,先说一下冷流与热流的概念。

  • 冷流 :只有订阅者订阅时,才开始执行发射数据流的代码。并且冷流和订阅者只能是一对一的关系,当有多个不同的订阅者时,消息是重新完整发送的。也就是说对冷流而言,有多个订阅者的时候,他们各自的事件是独立的。
  • 热流:无论有没有订阅者订阅,事件始终都会发生。当 热流有多个订阅者时,热流与订阅者们的关系是一对多的关系,可以与多个订阅者共享信息。

SharedFlow的特点

  • SharedFlow没有默认值
  • SharedFlow可以保存旧的数据,根据配置可以将旧的数据回播给新的订阅者
  • SharedFlow使用emit/tryEmit发射数据,StateFlow内部其实都是调用的setValue。
  • SharedFlow会挂起直到所有的订阅者处理完成。

为什么我先讲的 StateFlow ,而不是SharedFlow,是因为 StateFlow 是 继承 SharedFlow 实现,是在其基础的场景化实现,我们可以把 StateFlow 理解为是 SharedFlow 的 “青春版”。并不是它更轻量,而是它使用更简单。

我们举例看看怎么使用 SharedFlow,看看它与 StateFlow的区别。

既然 StateFlow 是 继承 SharedFlow 实现,那么StateFlow

一、SharedFlow的使用

方式一,我们自己 new 出来

public fun <T> MutableSharedFlow(
    // 重放数据个数
    replay: Int = 0,
    // 额外缓存容量
    extraBufferCapacity: Int = 0,
    // 缓存溢出策略
    onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND
): MutableSharedFlow<T> {
    val bufferCapacity0 = replay + extraBufferCapacity
    val bufferCapacity = if (bufferCapacity0 < 0) Int.MAX_VALUE else bufferCapacity0 // coerce to MAX_VALUE on overflow
    return SharedFlowImpl(replay, bufferCapacity, onBufferOverflow)
}
public enum class BufferOverflow {
    // 挂起
    SUSPEND,
    // 丢弃最早的一个
    DROP_OLDEST,
    // 丢弃最近的一个
    DROP_LATEST
}

举例说明

@HiltViewModel
class Demo4ViewModel @Inject constructor(
    val savedState: SavedStateHandle
) : BaseViewModel() {
    private val _sharedFlow = MutableSharedFlow<String>(replay = 1, onBufferOverflow = BufferOverflow.SUSPEND)
    val sharedFlow: SharedFlow<String> = _sharedFlow
    fun changeSearch(keyword: String) {
        _sharedFlow.tryEmit(keyword)
    }
}

在Activity中我们就可以像类似 LiveData 一样的使用 SharedFlow

    private fun testflow() {
       mViewModel.changeSearch("key")
    }
    override fun startObserve() {
        mViewModel.sharedFlow.collect {
            YYLogUtils.w("value $it")
        }
    }

方式二,通过一个 冷流 Flow 转换为 sharedFlow

class NewsRemoteDataSource(...,
    private val externalScope: CoroutineScope,
) {
    val latestNews: Flow<List<ArticleHeadline>> = flow {
        ...
    }.shareIn(
        externalScope,
        replay = 1,
        started = SharingStarted.WhileSubscribed() // 启动政策
    )
}

几个重要参数的说明如下

  • scope 共享开始时所在的协程作用域范围
  • started 控制共享的开始和结束的策略
  • replay 为0 代表不重放,也就是没有粘性,为1 代表重放最新的一个数据

scope 和 replay 不需要过多解释,主要介绍下 started: SharingStarted 启动策略,分为三种:

Eagerly(热启动式): 立即启动数据流,并保持数据流(直到 scope 指定的作用域结束);

Lazily(懒启动式): 在首个订阅者注册时启动,并保持数据流(直到 scope 指定的作用域结束);

WhileSubscribed(): 在首个订阅者注册时启动,并保持数据流直到在最后一个订阅者注销时结束(或直到 scope 指定的作用域结束)。

使用示例:

        val sharedFlow = flowOf(1, 2, 3).shareIn(
            scope = lifecycleScope,
//            started = WhileSubscribed(5000, 1000),
//            started = Eagerly,
            started = Lazily,
            replay = 0
        )
        lifecycleScope.launch {
            sharedFlow.collect {
                YYLogUtils.w("shared-value $it")
            }
        }

打印结果:

创建的几种方式基本和StateFlow类似,那么它们之间有什么区别?

二、SharedFlow、StateFlow、LiveData的对比

我们直接举例,实现 LiveData 的功能。我们看看 LiveData StateFlow SharedFlow 实现同样的效果如何操作

@HiltViewModel
class Demo4ViewModel @Inject constructor(
    val savedState: SavedStateHandle
) : BaseViewModel() {
    private val _searchLD = MutableLiveData<String>()
    val searchLD: LiveData<String> = _searchLD
    private val _searchFlow = MutableStateFlow("")
    val searchFlow: StateFlow<String> = _searchFlow
    private val _sharedFlow = MutableSharedFlow<String>(replay = 1, onBufferOverflow = BufferOverflow.SUSPEND)
    val sharedFlow: SharedFlow<String> = _sharedFlow
    fun changeSearch(keyword: String) {
        _sharedFlow.tryEmit(keyword)
        _searchFlow.value = keyword
        _searchLD.value = keyword
    }
}

打印的结果:

可以看到 SharedFlow 通过设置之后是可以达到 LiveData 和 StateFlow 的效果的。

SharedFlow对比StateFlow的优势,不需要设置默认值,没有默认值的发送。

SharedFlow对比StateFlow的劣势,不能自由取值,这是致命的。

例如下面的代码,StateFlow 我可以在代码的任意地方取值,但是 SharedFlow 只能接收流,不能自由取值。

所以,我们一般才说 StateFlow 平替 LiveData,虽然 SharedFlow 可以通过 参数的方式达到一部分 LiveData 的效果,但是痛点更明显。

另外需要说明的是 StateFlow 与 SharedFlow 这么设置是去重的,也就是说如果点击登录按钮之后登录失败报告密码错误,然后再次点击登录按钮,就不会弹出吐司了。

这不符合我们的业务场景啊,如果按照 StateFlow 平替 LiveData 的原则,我们还需要改用 Channel 的方式才行 (毕竟SharedFlow不能自由取值真的不适合这个场景)。

@HiltViewModel
class Demo4ViewModel @Inject constructor(
    val savedState: SavedStateHandle
) : BaseViewModel() {
    val channel = Channel<String>(Channel.CONFLATED)
    private val _searchLD = MutableLiveData<String>()
    val searchLD: LiveData<String> = _searchLD
    private val _searchFlow = MutableStateFlow("")
    val searchFlow: StateFlow<String> = _searchFlow
    private val _sharedFlow = MutableSharedFlow<String>(replay = 1, onBufferOverflow = BufferOverflow.SUSPEND)
    val sharedFlow: SharedFlow<String> = _sharedFlow
    fun changeSearch(keyword: String) {
        _sharedFlow.tryEmit(keyword)
        _searchFlow.value = keyword
        _searchLD.value = keyword
        channel.trySend(keyword)
    }
}
    private fun testflow() {
        mViewModel.changeSearch("1234")
    }
    override fun startObserve() {
        mViewModel.searchLD.observe(this) {
            YYLogUtils.w("value $it")
        }
        lifecycleScope.launch {
            mViewModel.sharedFlow.collect {
                YYLogUtils.w("shared-value1 $it")
            }
        }
        lifecycleScope.launch {
            mViewModel.channel.consumeAsFlow().collect {
                YYLogUtils.w("shared-value2 $it")
            }
        }
        lifecycleScope.launchWhenCreated {
            mViewModel.searchFlow.collect {
                YYLogUtils.w("state-value $it")
            }
        }
    }

我们加入了使用 Channel 的方式,前文我们讲过 Channel 是协程中的通信通道,我们这边发送那一边转为Flow来collect。打印结果如下:

好麻烦哦,这还不如LiveData呢,所以大家知道 StateFlow 与 LiveData 的优缺点之后,按需选择即可。

三、SharedFlow 的粘性设置与事件总线

可以看到虽然 SharedFlow 不能平替 LiveData ,但是它在事件的发送与接收相关的配置与使用到时得天独厚,我们常用于事件总线的实现,例如SharedFlowBus,用于替代 EventBus

object FlowBus {
    private val busMap = mutableMapOf<String, EventBus<*>>()
    private val busStickMap = mutableMapOf<String, StickEventBus<*>>()
    @Synchronized
    fun <T> with(key: String): EventBus<T> {
        var eventBus = busMap[key]
        if (eventBus == null) {
            eventBus = EventBus<T>(key)
            busMap[key] = eventBus
        }
        return eventBus as EventBus<T>
    }
    @Synchronized
    fun <T> withStick(key: String): StickEventBus<T> {
        var eventBus = busStickMap[key]
        if (eventBus == null) {
            eventBus = StickEventBus<T>(key)
            busStickMap[key] = eventBus
        }
        return eventBus as StickEventBus<T>
    }
    //真正实现类
    open class EventBus<T>(private val key: String) : LifecycleObserver {
        //私有对象用于发送消息
        private val _events: MutableSharedFlow<T> by lazy {
            obtainEvent()
        }
        //暴露的公有对象用于接收消息
        val events = _events.asSharedFlow()
        open fun obtainEvent(): MutableSharedFlow<T> = MutableSharedFlow(0, 1, BufferOverflow.DROP_OLDEST)
        //主线程接收数据
        fun register(lifecycleOwner: LifecycleOwner, action: (t: T) -> Unit) {
            lifecycleOwner.lifecycle.addObserver(this)
            lifecycleOwner.lifecycleScope.launch {
                events.collect {
                    try {
                        action(it)
                    } catch (e: Exception) {
                        e.printStackTrace()
                        YYLogUtils.e("FlowBus - Error:$e")
                    }
                }
            }
        }
        //协程中发送数据
        suspend fun post(event: T) {
            _events.emit(event)
        }
        //主线程发送数据
        fun post(scope: CoroutineScope, event: T) {
            scope.launch {
                _events.emit(event)
            }
        }
        //自动销毁
        @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
        fun onDestroy() {
            YYLogUtils.w("FlowBus - 自动onDestroy")
            val subscriptCount = _events.subscriptionCount.value
            if (subscriptCount <= 0)
                busMap.remove(key)
        }
    }
    class StickEventBus<T>(key: String) : EventBus<T>(key) {
        override fun obtainEvent(): MutableSharedFlow<T> = MutableSharedFlow(1, 1, BufferOverflow.DROP_OLDEST)
    }
}

发送与接收消息

 // 主线程-发送消息
    FlowBus.with<String>("test-key-01").post(this@Demo11OneFragment2.lifecycleScope, "Test Flow Bus Message")
 // 接收消息
    FlowBus.with&lt;String&gt;("test-key-01").register(this) {
            LogUtils.w("收到FlowBus消息 - " + it)
        }
发送粘性消息
 FlowBus.withStick<String>("test-key-02").post(lifecycleScope, "Test Stick Message")
 // 接收粘性消息
FlowBus.withStick<String>("test-key-02").register(this){
        LogUtils.w("收到粘性消息:$it")
    }

看源码就知道粘性的实现就得益于 SharedFlow 的构造参数

replay的设置 ,代表重放的数据个数

replay 为0 代表不重放,也就是没有粘性

replay 为1 代表重放最新的一个数据,后来的接收器能接受1个最新数据。

replay 为2 代表重放最新的两个数据,后来的接收器能接受2个最新数据。

我们知道Flow的操作符有针对背压的处理,那么 SharedFlow 内部还对背压做了快速处理。我们只需要通过参数快速设置即可实现。

extraBufferCapacity的设置,额外数据的缓存

当上游事件发送过快,而消费太慢的情况,这种情况下,就需要使用缓存池,把未消费的数据存下来。

缓冲池容量 = replay + extraBufferCapacity

如果总量为 0 ,就 Int.MAX_VALUE

onBufferOverflow的设置

如果指定了有限的缓存容量,那么超过容量以后怎么办?

BufferOverflow.SUSPEND : 超过就挂起,默认实现

BufferOverflow.DROP_OLDEST : 丢弃最老的数据

BufferOverflow.DROP_LATEST : 丢弃最新的数据

总结

StateFlow 更加简便特定的场景使用,而 SharedFlow 更加的灵活,他们两者的侧重点也不同。

SharedFlow 基于缓存的处理可以实现一些特定的需求,如当发生订阅时,我需要将过去已经更新的N个值,同步给新的订阅者。比如有多个新的订阅者都想订阅这些改动的值。都可以使用 SharedFlow 来实现

而关于 SharedFlow、StateFlow、LiveData的对比,个人的结论是:根据不同的场景 LiveData StateFlow SharedFlow 都有自己特定的使用场景,谁也无法真的完全平替谁。谁也不是谁的超集,都有它们各自的有点和缺点,并不能完美覆盖所有场景,所以根据使用的场景不同按需选择即可。

关于StateFlow 与 SharedFlow 的实战,后面会总结一期。

以上就是Kotlin Flow封装类SharedFlow StateFlow LiveData使用对比的详细内容,更多关于Kotlin Flow封装类的资料请关注我们其它相关文章!

(0)

相关推荐

  • Kotlin Flow操作符及基本使用详解

    目录 一.Flow的基本概念 二.Flow的生命周期与异常处理 2.1 开始与结束 2.2 异常的处理 2.3 retry的处理 2.4 超时的处理 2.5 Flow的取消 三.Flow的创建方式 四.Flow的接收方式 五.Flow的转换操作符 5.1 基本操作符 5.2 特殊操作符 5.3 组合与展平操作符 5.4 切换线程 总结 一.Flow的基本概念 Kotlin 的 Flow 相信大家都或多或少使用过,毕竟目前比较火,目前我把Flow的使用整理了一下.希望和大家所学对照一下,能有所启发

  • Kotlin Flow常用封装类StateFlow使用详解

    目录 Kotlin中StateFlow的使用 一.StateFlow的使用 二.替代LiveData 总结 Kotlin中StateFlow的使用 StateFlow 是 Flow 的实现,是一个特殊的流,默认的 Flow 是冷流,而StateFlow 是热流,和 LiveData 比较类似.关于冷热流后面一期 SharedFlow 会详细说明. 使用 StateFlow 替代 LiveData 应该是目前很多开发者的呼吁了,确实 LiveData 的功能 StateFlow 都能实现,可以说是

  • Kotlin协程Flow生命周期及异常处理浅析

    目录 正文 Flow基本概念 Flow生命周期 处理异常 上游或者中间异常使用catch 下游使用try-catch 切换执行线程 终止操作符 "冷的数据流"从何而来 正文 Kotlin协程中的Flow主要用于处理复杂的异步数据,以一种”流“的方式,从上到下依次处理,和RxJava的处理方式类型,但是比后者更加强大. Flow基本概念 Flow中基本上有三个概念,即 发送方,处理中间层,接收方,可以类比水利发电站中的上游,发电站,下游的概念, 数据从上游开始发送”流淌“至中间站被”处理

  • 图解 Kotlin SharedFlow 缓存系统及示例详解

    目录 前言 replay extraBufferCapacity onBufferOverflow SharedFlow Buffer 前言 Kotlin 为我们提供了两种创建“热流”的工具:StateFlow 和 SharedFlow.StateFlow 经常被用来替代 LiveData 充当架构组件使用,所以大家相对熟悉.其实 StateFlow 只是 SharedFlow 的一种特化形式,SharedFlow 的功能更强大.使用场景更多,这得益于其自带的缓存系统,本文用图解的方式,带大家更

  • Kotlin Flow常见场景下的使用实例

    目录 Kotlin Flow在开发中的常用场景使用 一.网络请求搭载Retrofit 1.1 LiveDataCallAdapterFactory 1.2 suspend 二.协程与Flow的选择与差异 三.StateFlow与SharedFlow的选择 总结 Kotlin Flow在开发中的常用场景使用 大家了解了 Flow 的创建与接收流程,了解 SharedFlow 创建的几种方式,各个参数的用途,了解了SharedFlow的 "青春版" StateFlow 的创建与接收,已经他

  • Kotlin协程之Flow基础原理示例解析

    目录 引言 一.Flow的创建 二.Flow的消费 1.SafeFlow类 2.AbstractFlow类 3. SafeCollector类 4.消费过程中的挂起 引言 本文分析示例代码如下: launch(Dispatchers.Main) { flow { emit(1) emit(2) }.collect { delay(1000) withContext(Dispatchers.IO) { Log.d("liduo", "$it") } Log.d(&qu

  • Kotlin Flow封装类SharedFlow StateFlow LiveData使用对比

    目录 Kotlin中SharedFlow的使用 VS StateFlow SharedFlow的特点 一.SharedFlow的使用 二.SharedFlow.StateFlow.LiveData的对比 三.SharedFlow 的粘性设置与事件总线 总结 Kotlin中SharedFlow的使用 VS StateFlow SharedFlow 是继承于 Flow ,同时它是 StateFlow 的父类,它们都是是热流,先说一下冷流与热流的概念. 冷流 :只有订阅者订阅时,才开始执行发射数据流的

  • Kotlin + Flow 实现Android 应用初始化任务启动库

    特性 Kotlin + Flow 实现的 Android 应用初始化任务启动库. 支持模块化,按模块加载任务 可指定工作进程名称,main 表示仅在主进程运行,all 表示在所有进程运行,默认值all 可指定任务仅在工作线程执行 可指定任务仅在调试模式执行 可指定任务在满足合规条件后执行 可指定任务优先级,决定同模块内无依赖同步任务的执行顺序 可指定依赖任务列表,能检测循环依赖 使用 Flow 调度任务 仅200多行代码,简单明了 有耗时统计 引入依赖 项目地址:github.com/czy11

  • Java8中Optional类型和Kotlin中可空类型的使用对比

    本文主要给大家介绍了关于Java8中Optional类型和Kotlin中可空类型使用的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍: 在 Java 8中,我们可以使用 Optional 类型来表达可空的类型. package com.easy.kotlin; import java.util.Optional; import static java.lang.System.out; /** * Optional.ofNullable - 允许传递为 null 参数 *

  • Kotlin协程开发之Flow的融合与Channel容量及溢出策略介绍

    目录 一.协程间的通信 1.通道容量 2.溢出策略 二.FusibleFlow接口 三.ChannelFlow类 一.协程间的通信 当需要进行协程间的通信时,可以调用Channel方法,创建一个Channel接口指向的对象,通过调用该对象的send方法和receive方法实现消息的发送与接收.协程对Channel接口的实现,本质上与阻塞队列类似,这里不再赘述. 1.通道容量 事实上,send方法与receive方法并没有定义在Channel接口中,而是分别定义在SendChannel接口和Rec

  • Kotlin协程之Flow异常示例处理

    目录 示例 一.catch方法 catchImpl方法 二. onCompletion方法 1.unsafeFlow方法 2.ThrowingCollector类 三. retryWhen方法 示例 代码如下: launch(Dispatchers.Main) { // 第一部分 flow { emit(1) throw NullPointerException("e") }.catch { Log.d("liduo", "onCreate1: $it&q

  • 一文读懂Android Kotlin的数据流

    目录 一.Android分层架构 二.ViewModel + LiveData 2.1 LiveData 特性 观察者的回调永远发生在主线程 仅持有单个且最新数据 自动取消订阅 提供「可读可写」和「仅可读」两种方式 配合 DataBinding 实现「双向绑定」 2.2 LiveData的缺陷 value 可以是 nullable 的 传入正确的 lifecycleOwner 粘性事件 默认不防抖 transformation 工作在主线程 2.3 LiveData 小结 三.Flow 3.1

  • kotlin改善java代码实例分析

    序 本文主要举几个kotlin如何改善java代码的例子 字符串字面值及模板 字符串字面值 @Test fun testStringLiterals(){ val a = """if(a > 1) { | return a |}""".trimMargin() println(a) val b = """Foo Bar""".trimIndent() println(b) } 有了

  • Android实现消息总线的几种方式详解

    目录 前言 一.BroadcastReceiver 广播 二.EventBus 三.RxBus 四.LiveDataBus 五.FlowBus 总结 前言 消息总线又叫事件总线,为什么我们需要一个消息总线呢?是因为随着项目变大,页面变多,我们可能出现跨页面.跨组件.跨线程.跨进程传递消息与数据,为了更方便的直接通知到指定的页面实现具体的逻辑,我们需要消息总线来实现. 从最基本的 BroadcastReceiver 到 EventBus 再到RxBus ,后来官方出了AndroidX jetpac

随机推荐