使用更为安全的方式收集 Android UI 数据流

class LocationActivity : AppCompatActivity() {

// 位置的协程监听器

private var locationUpdatesJob: Job? = null

override fun onStart() {

super.onStart()

locationUpdatesJob = lifecycleScope.launch {

locationProvider.locationFlow().collect {

// 新的位置!更新地图。

}

}

}

override fun onStop() {

// 在视图进入后台时停止收集数据

locationUpdatesJob?.cancel()

super.onStop()

}

}

这是一个不错的解决方案,美中不足的是有些冗长。如果这个世界有一个有关 Android 开发者的普遍事实,那一定是我们都不喜欢编写模版代码。不必编写模版代码的一个最大好处就是——写的代码越少,出错的概率越小!

LifecycleOwner.addRepeatingJob

==========================================================================================

现在我们境遇相同,并且也知道问题出在哪里,是时候找出一个解决方案了。我们的解决方案需要:

  1. 简单;

  2. 友好或者说便于记忆与理解;

  3. 更重要的是安全!无论数据流的实现细节如何,它都应能够应对所有用例。

事不宜迟——您应该使用的 API 是 lifecycle-runtime-ktx 库中所提供的

LifecycleOwner.addRepeatingJob。请参考下面的代码:

class LocationActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

// 最早在 View 处于 STARTED 状态时从数据流收集数据,并在

// 生命周期进入 STOPPED 状态时 STOPPED(停止)收集操作。

// 它会在生命周期再次进入 STARTED 状态时自动开始进行数据收集操作。

lifecycleOwner.addRepeatingJob(Lifecycle.State.STARTED) {

locationProvider.locationFlow().collect {

// 新的位置!更新地图

}

}

}

}

addRepeatingJob 接收 Lifecycle.State 作为参数,并用它与传入的代码块一起,在生命周期到达该状态时,自动创建并启动新的协程;同时也会在生命周期低于该状态时取消正在运行的协程。

由于 addRepeatingJob 会在协程不再被需要时自动将其取消,因而可以避免产生取消操作相关的模版代码。您也许已经猜到,为了避免意外行为,这一 API 需要在 Activity 的 onCreate 或 Fragment 的 onViewCreated 方法中调用。下面是配合 Fragment 使用的示例:

class LocationFragment: Fragment() {

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {

// …

viewLifecycleOwner.addRepeatingJob(Lifecycle.State.STARTED) {

locationProvider.locationFlow().collect {

// 新的位置!更新地图

}

}

}

}

注意:这些 API 在

lifecycle:lifecycle-runtime-ktx:2.4.0-alpha01 库或其更新的版本中可用。

使用 repeatOnLifecycle

出于提供更为灵活的 API 以及保存调用中的 CoroutineContext 的目的,我们也提供了 挂起函数

Lifecycle.repeatOnLifecycle 供您使用。repeatOnLifecycle 会挂起调用它的协程,并会在进出目标状态时重新执行代码块,最后在 Lifecycle 进入销毁状态时恢复调用它的协程。

如果您需要在重复工作前执行一次配置任务,同时希望任务可以在重复工作开始前保持挂起,该 API 可以帮您实现这样的操作。示例如下:

class LocationActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

lifecycleScope.launch {

// 单次配置任务

val expensiveObject = createExpensiveObject()

lifecycle.repeatOnLifecycle(Lifecycle.State.STARTED) {

// 在生命周期进入 STARTED 状态时开始重复任务,在 STOPED 状态时停止

// 对 expensiveObject 进行操作

}

// 当协程恢复时,lifecycle 处于 DESTROY 状态。repeatOnLifecycle 会在

// 进入 DESTROYED 状态前挂起协程的执行

}

}

}

Flow.flowWithLifecycle

==================================================================================

当您只需要收集一个数据流时,也可以使用 Flow.flowWithLifecycle 操作符。这一 API 的内部也使用 suspend Lifecycle.repeatOnLifecycle 函数实现,并会在生命周期进入和离开目标状态时发送项目和取消内部的生产者。

class LocationActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

locationProvider.locationFlow()

.flowWithLifecycle(this, Lifecycle.State.STARTED)

.onEach {

// 新的位置!更新地图

}

.launchIn(lifecycleScope)

}

}

注意:Flow.flowWithLifecycle API 的命名以 Flow.flowOn(CoroutineContext) 为先例,因为它会在不影响下游数据流的同时修改收集上游数据流的 CoroutineContext。与 flowOn 相似的另一点是,Flow.flowWithLifecycle 也加入了缓冲区,以防止消费者无法跟上生产者。这一特点源于其实现中使用的 callbackFlow。

配置内部生产者

===================================================================

即使您使用了这些 API,也要小心那些可能浪费资源的热流,就算它们没有被收集亦是如此!虽然针对这些热流有一些合适的用例,但是仍要多加注意并在必要时进行记录。另一方面,在一些情况下,即使可能造成资源的浪费,令处于后台的内部数据流生产者保持活跃状态也会利于某些用例,如:您需要即时刷新可用数据,而不是去获取并暂时展示陈旧数据。您可以根据用例决定生产者是否需要始终处于活跃状态。

您可以使用 MutableStateFlow 与 MutableSharedFlow 两个 API 中暴露的 subscriptionCount 字段来控制它们,当该字段值为 0 时,内部的生产者就会停止。默认情况下,只要持有数据流实例的对象还在内存中,它们就会保持生产者的活跃状态。针对这些 API 也有一些合适的用例,比如使用 StateFlow 将 UiState 从 ViewModel 中暴露给 UI。这么做很合适,因为它意味着 ViewModel 总是需要向 View 提供最新的 UI 状态。

相似的,也可以为此类操作使用 共享开始策略 配置 Flow.stateIn 与 Flow.shareIn 操作符。WhileSubscribed() 将会在没有活跃的订阅者时停止内部的生产者!相应的,无论数据流是 Eagerly (积极) 还是 Lazily (惰性) 的,只要它们使用的 CoroutineScope 还处于活跃状态,其内部的生产者就会保持活跃。

注意: 本文中所描述的 API 可以很好的作为默认从 UI 收集数据流的方式,并且无论数据流的实现方式如何,都应该使用它们。这些 API 做了它们要做的事: 在 UI 于屏幕中不可见时,停止收集其数据流。至于数据流是否应该始终处于活动状态,则取决于它的实现。

在 Jetpack Compose 中安全地收集数据流

=======================================================================================

Flow.collectAsState 函数可以在 Compose 中收集来自 composable 的数据流,并可以将值表示为 State,以便能够更新 Compose UI。即使 Compose 在宿主 Activity 或 Fragment 处于后台时不会重组 UI,数据流生产者仍会保持活跃并会造成资源的浪费。Compose 可能会遭遇与 View 系统相同的问题。

在 Compose 中收集数据流时,可以使用 Flow.flowWithLifecycle 操作符,示例如下:

@Composable

fun LocationScreen(locationFlow: Flow) {

val lifecycleOwner = LocalLifecycleOwner.current

val locationFlowLifecycleAware = remember(locationFlow, lifecycleOwner) {

locationFlow.flowWithLifecycle(lifecycleOwner.lifecycle, Lifecycle.State.STARTED)

}

val location by locationFlowLifecycleAware.collectAsState()

// 当前位置,可以拿它做一些操作

}

注意:您需要记得生命周期感知型数据流使用 locationFlow 与 lifecycleOwner 作为键,以便始终使用同一个数据流,除非其中一个键发生改变。

Compose 的副作用 (Side-effect) 便是必须处在受控环境中,因此,使用 LifecycleOwner.addRepeatingJob 不安全。作为替代,可以使用 LaunchedEffect 来创建跟随 composable 生命周期的协程。在它的代码块中,如果您需要在宿主生命周期处于某个 State 时重新执行一个代码块,可以调用挂起函数 Lifecycle.repeatOnLifecycle。

对比 LiveData

=======================================================================

您也许会觉得,这些 API 的表现与 LiveData 很相似——确实是这样!LiveData 可以感知 Lifecycle,而且它的重启行为使其十分适合观察来自 UI 的数据流。同理 LifecycleOwner.addRepeatingJob、suspend Lifecycle.repeatOnLifecycle 以及 Flow.flowWithLifecycle 等 API 亦是如此。

在纯 Kotlin 应用中,使用这些 API 可以十分自然地替代 LiveData 收集数据流。如果您使用这些 API 收集数据流,换成 LiveData (相对于使用协程和 Flow) 不会带来任何额外的好处。而且由于 Flow 可以从任何 Dispatcher 收集数据,同时也能通过它的操作符获得更多功能,所以 Flow 也更为灵活。相对而言,LiveData 的可用操作符有限,且它总是从 UI 线程观察数据。

数据绑定对 StateFlow 的支持

另一方面,您会想要使用 LiveData 的原因之一,可能是它受到数据绑定的支持。不过 StateFlow 也一样!更多有关数据绑定对 StateFlow 的支持信息,请参阅官方文档。

在 Android 开发中,请使用 LifecycleOwner.addRepeatingJob、suspend Lifecycle.repeatOnLifecycle 或 Flow.flowWithLifecycle 从 UI 层安全地收集数据流。

最后

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长,自己不成体系的自学效果低效漫长且无助

因此我收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点!不论你是刚入门Android开发的新手,还是希望在技术上不断提升的资深开发者,这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助,需要这份全套学习资料的朋友可以戳我获取!!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
3470)]

[外链图片转存中…(img-4sf4dyml-1715883303471)]

[外链图片转存中…(img-NDr7QcRy-1715883303472)]

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点!不论你是刚入门Android开发的新手,还是希望在技术上不断提升的资深开发者,这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助,需要这份全套学习资料的朋友可以戳我获取!!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

  • 4
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值