• 使用界面狀態(tài)
  https://developer.android.google.cn/topic/architecture/ui-layer#consume-ui-state

collectAsStateWithLifecycle

collectAsStateWithLifecycle 是一個可組合函數(shù)，可從數(shù)據(jù)流中收集值，并以生命周期感知方式將最新值表示為 Compose State。每當數(shù)據(jù)流發(fā)出新值時，此 State 對象的值都會更新，從而讓組合 (Composition) 中每個使用 State.value 的對象進行重新組合。

• State
  https://developer.android.google.cn/reference/kotlin/androidx/compose/runtime/State

默認情況下，collectAsStateWithLifecycle 使用 Lifecycle.State.STARTED 從數(shù)據(jù)流中開始和結(jié)束收集值。這些動作會在生命周期 (Lifecycle) 移入和移出目標狀態(tài)時發(fā)生。您可以通過 minActiveState 參數(shù)配置此生命周期狀態(tài)。

△ 默認情況下，當應(yīng)用處于后臺時 collectAsStateWithLifecycle 會取消收集數(shù)據(jù)流

• Lifecycle.State.STARTED
  https://developer.android.google.cn/reference/android/arch/lifecycle/Lifecycle.State#started

以下代碼片段展示了如何使用 collectAsStateWithLifecycle 來收集可組合函數(shù)中的 ViewModel 所公開的 StateFlow 的 uiState 字段:

/* Copyright 2022 Google LLC.     SPDX-License-Identifier: Apache-2.0 */
@OptIn(ExperimentalLifecycleComposeApi::class)@Composablefun AuthorRoute(  onBackClick: () -> Unit,  modifier: Modifier = Modifier,  viewModel: AuthorViewModel = hiltViewModel()) {  val uiState: AuthorScreenUiState by viewModel.uiState.collectAsStateWithLifecycle()
  AuthorScreen(    authorState = uiState.authorState,    newsState = uiState.newsState,    modifier = modifier,    onBackClick = onBackClick,    onFollowClick = viewModel::followAuthorToggle,  )}

每當 AuthorViewModel 的 uiState 發(fā)出新的 AuthorScreenUiState 值時，都會重新組合 AuthorRoute。有關(guān) collectAsStateWithLifecycle 的更多用法，請參考 "Now in Android" 應(yīng)用及相關(guān)遷移 PR。

• AuthorViewModel
  https://github.com/android/nowinandroid/blob/main/feature-author/src/main/java/com/google/samples/apps/nowinandroid/feature/author/AuthorViewModel.kt
• AuthorRoute
  https://github.com/android/nowinandroid/blob/main/feature-author/src/main/java/com/google/samples/apps/nowinandroid/feature/author/AuthorScreen.kt
• Now in Android
  https://github.com/android/nowinandroid/search?q=collectAsStateWithLifecycle
• 遷移 PR
  https://github.com/android/nowinandroid/pull/166

如果您要在項目中使用 collectAsStateWithLifecycle API，請將 androidx.lifecycle.lifecycle-runtime-compose 工件添加到項目中。

/* Copyright 2022 Google LLC.     SPDX-License-Identifier: Apache-2.0 */
// app/build.gradle filedependencies {    implementation "androidx.lifecycle2.6.0-alpha01"}

• 版本 2.6.0-alpha01
  https://developer.android.google.cn/jetpack/androidx/releases/lifecycle#version_26_2

• ExperimentalLifecycleComposeApi
  https://developer.android.google.cn/reference/kotlin/androidx/lifecycle/compose/ExperimentalLifecycleComposeApi

工作原理

collectAsStateWithLifecycle 在實現(xiàn)機制上使用了 repeatOnLifecycle API，我們也推薦大家在 Android 視圖 (View) 系統(tǒng)中收集數(shù)據(jù)流的 API。

• collectAsStateWithLifecycle 的實現(xiàn)機制
  https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:lifecycle/lifecycle-runtime-compose/src/main/java/androidx/lifecycle/compose/FlowExt.kt;l=168

• repeatOnLifecycle
  https://developer.android.google.cn/reference/kotlin/androidx/lifecycle/package-summary#(androidx.lifecycle.Lifecycle).repeatOnLifecycle(androidx.lifecycle.Lifecycle.State,kotlin.coroutines.SuspendFunction1)

借助 collectAsStateWithLifecycle，您無需輸入下方的樣板代碼，這些代碼同樣以生命周期感知的方式從可組合函數(shù)收集數(shù)據(jù)流:

/*Copyright2022GoogleLLC.   SPDX-License-Identifier: Apache-2.0 */@ComposablefunAuthorRoute(...){vallifecycle=LocalLifecycleOwner.current.lifecyclevaluiStatebyproduceState(initialValue=viewModel.uiState.valuekey1=lifecyclekey2=viewModel){lifecycle.repeatOnLifecycle(state=STARTED){viewModel.uiState.collect{value=it}}}
AuthorScreen(...)}

在架構(gòu)中收集數(shù)據(jù)流

應(yīng)用架構(gòu)中的類型不應(yīng)該知道其他類型的實現(xiàn)細節(jié)。界面不應(yīng)該知道 ViewModel 如何產(chǎn)生界面狀態(tài)。如果界面在屏幕上不可見，則應(yīng)停止收集數(shù)據(jù)流，以釋放應(yīng)用資源 (如果可行的話)。

界面可以通過使用 collectAsStateWithLifecycle 收集界面狀態(tài)來幫助釋放資源。ViewModel 可以通過以收集器感知的方式生成界面狀態(tài)來完成相同的操作。如果沒有收集器，例如當界面在屏幕上不可見時，則停止收集來自數(shù)據(jù)層的上游數(shù)據(jù)流。您可以在生成界面狀態(tài)時使用 .stateIn(WhileSubscribed) 數(shù)據(jù)流 API 來執(zhí)行此操作。如需了解更多信息，請觀看 "Kotlin Flows 實戰(zhàn)" 講座的這一部分。如要測試以這種方法生成界面狀態(tài)的 ViewModel，請查看測試指南。

△ 在界面層中，使用 collectAsStateWithLifecycle 收集界面狀態(tài)，并在數(shù)據(jù)層公開響應(yīng)式數(shù)據(jù)流時使用 .stateIn(WhileSubscribed) 生成界面狀態(tài)。這樣一來應(yīng)用的其余部分便能在不需要的時候釋放資源

• .stateIn(WhileSubscribed)
  https://github.com/android/nowinandroid/blob/main/feature-author/src/main/java/com/google/samples/apps/nowinandroid/feature/author/AuthorViewModel.kt#L104

• Kotlin Flows 實戰(zhàn)
  https://www.youtube.com/watch?v=fSB6_KE95bU&t=1009s

• 測試 StateFlow
  https://developer.android.google.cn/kotlin/flow/test#statein

數(shù)據(jù)流的使用者和生產(chǎn)者不需要知道彼此的實現(xiàn)方式。在具備多個環(huán)境、變體、代碼庫和功能的大型應(yīng)用中找出實現(xiàn)細節(jié)是非常耗時的。更糟糕的是，依賴于實現(xiàn)細節(jié)的代碼維護起來非常困難。

讓資源在后臺保持活躍狀態(tài)

• CPU 使用: 在所有設(shè)備組件中，CPU 的耗電量最高。而電池續(xù)航時間一直是用戶關(guān)注的重點，因此如果發(fā)生 CPU 濫用的情況，用戶可能會卸載您的應(yīng)用；

• 流量消耗: 在未連接 Wi-Fi 時減少應(yīng)用的網(wǎng)絡(luò)流量，可以幫助用戶節(jié)省流量費用；

• 內(nèi)存用量: 應(yīng)用對內(nèi)存的使用方式也會對設(shè)備的整體穩(wěn)定性和性能產(chǎn)生非常大的影響。

• 為數(shù)十億用戶打造產(chǎn)品
  https://developer.android.google.cn/docs/quality-guidelines/build-for-billions

與 collectAsState 的差異

可組合函數(shù)的生命周期與 Compose 運行的平臺無關(guān)。正如 "可組合項的生命周期" 頁面中所述，可組合函數(shù)的實例進入組合，執(zhí)行 0 次或多次重組，然后離開組合:

△ 組合中可組合函數(shù)實例的生命周期

collectAsState API 遵循組合的生命周期。此 API 在可組合項進入組合時開始收集數(shù)據(jù)流，并在可組合項離開組合時停止收集。collectAsState 是用于收集數(shù)據(jù)流且與平臺無關(guān)的 API。

collectAsState 和 collectAsStateWithLifecycle 在 Compose 中各有用途。后者用于開發(fā) Android 應(yīng)用，前者用于在其他平臺進行開發(fā)。

從 collectAsState 遷移到 collectAsStateWithLifecycle 非常容易:

/* Copyright 2022 Google LLC.     SPDX-License-Identifier: Apache-2.0 */
@Composablefun AuthorRoute(...) {    val lifecycle = LocalLifecycleOwner.current.lifecycle    val uiState by produceState(        initialValue = viewModel.uiState.value        key1 = lifecycle        key2 = viewModel    ) {        lifecycle.repeatOnLifecycle(state = STARTED) {            viewModel.uiState.collect { value = it }        }    }
    AuthorScreen(...)}

• Jose Alcérreca
  https://medium.com/u/e0a4c9469bb5

• Marton Braun
  https://medium.com/u/ec2087b3c81f

• Alejandra Stamato
  https://medium.com/u/92c44d274e60