构建 Compose 界面

在 Compose 中,界面是不可变的,在绘制后无法进行更新。您可以控制的是界面的状态。每当界面的状态发生变化时,Compose 都会重新创建界面树中已更改的部分。可组合项可以接受状态并公开事件,例如 TextField 接受值并公开请求回调处理程序更改值的回调 onValueChange

var name by remember { mutableStateOf("") }
OutlinedTextField(
    value = name,
    onValueChange = { name = it },
    label = { Text("Name") }
)

由于可组合项接受状态并公开事件,因此单向数据流模式非常适合 Jetpack Compose。本指南将重点介绍如何在 Compose 中实现单向数据流模式,如何实现事件和状态容器,以及如何在 Compose 中使用 ViewModel。

单向数据流

单向数据流 (UDF) 是一种设计模式,在该模式下状态向下流动,事件向上流动。通过采用单向数据流,您可以将在界面中显示状态的可组合项与应用中存储和更改状态的部分分离开来。

使用单向数据流的应用的界面更新循环如下所示:

  • 事件:界面的某一部分生成一个事件,并将其向上传递,例如将按钮点击传递给 ViewModel 进行处理;或者从应用的其他层传递事件,如指示用户会话已过期。
  • 更新状态:事件处理脚本可能会更改状态。
  • 显示状态:状态容器向下传递状态,界面显示此状态。

单向数据流

使用 Jetpack Compose 时遵循此模式可带来下面几项优势:

  • 可测试性:将状态与显示状态的界面分离开来,更方便单独对二者进行测试。
  • 状态封装:因为状态只能在一个位置进行更新,并且可组合项的状态只有一个可信来源,所以不太可能由于状态不一致而出现 bug。
  • 界面一致性:通过使用可观察的状态容器,例如 LiveDataStateFlow,所有状态更新都会立即反映在界面中。

Jetpack Compose 中的单向数据流

可组合项基于状态和事件进行工作。例如,只有在更新其 value 参数并公开 onValueChange 回调(这是一个请求将值更改为新值的事件)时,TextField 才会更新。Compose 将 State 对象定义为值容器,而对状态值的更改会触发重组。您可以将状态保存在 remember { mutableStateOf(value) }rememberSaveable { mutableStateOf(value) 中,具体取决于您需要记住值的时长。

TextField 可组合项的值的类型为 String,因此该值可以来自任意位置,包括来自硬编码值、ViewModel 或从父级可组合项传入。您不必将它保存在 State 对象中,但在调用 onValueChange 时需要更新该值。

定义可组合项参数

在定义可组合项的状态参数时,您应牢记以下问题:

  • 可组合项的可重用性或灵活性如何?
  • 状态参数如何影响此可组合项的性能?

为了促进分离和重复使用,每个可组合项都应包含尽可能少的信息。例如,构建可组合项以保存新闻报道的标题时,最好仅传递需要显示的信息,而不是整篇新闻报道:

@Composable
fun Header(title: String, subtitle: String) {
    // Recomposes when title or subtitle have changed.
}

@Composable
fun Header(news: News) {
    // Recomposes when a new instance of News is passed in.
}

有时,使用独立参数还能提高性能,例如,如果 News 包含的不仅仅是 titlesubtitle 的信息,每当有 News 的新实例传入 Header(news) 时,即使 titlesubtitle 没有变化,可组合项也将重组。

请仔细考虑传入的参数数量。如果一个函数拥有过多参数,会降低该函数的工效,因此在这种情况下,建议您将这些参数分到一个类下。

Compose 中的事件

应用的每项输入都应表示为事件:点按、文本更改,甚至计时器或其他更新。当这些事件更改界面的状态时,ViewModel 应负责处理这些事件并更新界面状态。

界面层绝不应更改事件处理脚本之外的状态,因为这样做可能会导致应用出现不一致和 bug。

最好为状态和事件处理脚本 lambda 传递不可变值。此方法具有以下优势:

  • 提升可重用性。
  • 确保您的界面不会直接更改状态的值。
  • 避免并发问题,因为您可确保不会从其他线程修改状态。
  • 通常情况下,还可以降低代码的复杂性。

例如,接受 String 和 lambda 作为参数的可组合项可以从许多上下文中调用,并且可重用性较高。假设应用中的顶部应用栏始终显示文本并包含返回按钮。您可以定义一个更通用的 MyAppTopAppBar 可组合项,该可组合项用于接收文本和返回按钮句柄作为参数:

@Composable
fun MyAppTopAppBar(topAppBarText: String, onBackPressed: () -> Unit) {
    TopAppBar(
        title = {
            Text(
                text = topAppBarText,
                textAlign = TextAlign.Center,
                modifier = Modifier
                    .fillMaxSize()
                    .wrapContentSize(Alignment.Center)
            )
        },
        navigationIcon = {
            IconButton(onClick = onBackPressed) {
                Icon(
                        Icons.Filled.ArrowBack,
                        contentDescription = localizedString
                    )
            }
        },
        // ...
    )
}

ViewModel、状态和事件:示例

借助 ViewModelmutableStateOf,如果出现以下任一情况,您还可以在应用中引入单向数据流:

  • 您的界面的状态通过 LiveData 作为可观察状态容器实现公开。
  • ViewModel 处理来自应用界面或其他层的事件,并根据事件更新状态容器。

例如,在实现登录屏幕时,点按登录按钮应该会使应用显示一个进度旋转图标和网络调用。如果登录成功,您的应用会转到其他屏幕;如果发生错误,应用会显示信息提示控件。以下是如何为屏幕状态和事件建模的方法:

该屏幕有四种状态:

  • 退出登录:当用户尚未登录时。
  • 进行中:当您的应用目前正在尝试通过执行网络调用来让用户登录时。
  • 错误:登录时出现错误。
  • 登录成功:用户登录后。

您可以将这些状态建模为密封类。ViewModel 将状态公开为 State,设置初始状态,并根据需要更新状态。ViewModel 还会通过公开 onSignIn() 方法来处理登录事件。

sealed class UiState {
    object SignedOut : UiState()
    object InProgress : UiState()
    object Error : UiState()
    object SignIn : UiState()
}

class MyViewModel : ViewModel() {
    private val _uiState = mutableStateOf<UiState>(SignedOut)
    val uiState: State<UiState>
        get() = _uiState

    // ...
}

除了 mutableStateOf API 之外,Compose 还提供 LiveDataFlowObservable扩展项,用于注册为监听器,并将值表示为状态。

class MyViewModel : ViewModel() {
    private val _uiState = MutableLiveData<UiState>(SignedOut)
    val uiState: LiveData<UiState>
        get() = _uiState

    // ...
}

@Composable
fun MyComposable(viewModel: MyViewModel) {
    val uiState = viewModel.uiState.observeAsState()
    // ...
}