原生移动开发 / 系统课时

UiState 与用户事件

UiState 与用户事件

这一节把页面的“现在是什么样”和“用户刚做了什么”分开建模:ViewModel 用 UiState 持有可渲染状态,UI 用用户事件表达点击与重试意图。通过一个先失败、再重试成功的示例,你会看到加载、失败、成功如何形成可预测的单向数据流。

学习目标

  • 用密封类型表达互斥的加载、成功和失败状态
  • 用用户事件把 UI 输入统一交给 ViewModel 处理
  • 使用 StateFlow 公开只读 UiState,并验证状态随事件更新

状态和事件承担不同职责

UiState 描述“此刻 UI 应该渲染什么”,例如正在加载、已经拿到列表或显示错误;它应该是可重复读取的结果。用户事件描述“刚发生了什么”,例如点击刷新、点击重试,它是输入而不是页面事实。

当页面状态之间互斥时,sealed interface 很适合建立有限状态集合,而每个需要携带数据的分支再使用 data class。这样代码无法同时出现“既 Loading 又 Success”的矛盾组合,when 也能对全部状态进行穷举检查。

建立单向数据流

页面只读取 uiState,不直接改写它;点击行为通过 UserEvent 传给 ViewModel。ViewModel 处理事件、调用数据层,再写入新的 UiState,UI 收到状态后重新渲染。状态向下、事件向上,就形成了单向数据流。

UiState 与用户事件的单向数据流

用密封类型实现加载、失败与成功

下面示例放在已启用 Jetpack Compose、Lifecycle Compose 和 Coroutines 的 Android 模块中。演示仓库第一次请求故意失败,点击“重试”后成功,因此可以在一次运行中观察三个 UiState。

kotlin
package com.example.uistatedemo

import androidx.compose.foundation.layout.Column
import androidx.compose.material3.Button
import androidx.compose.material3.CircularProgressIndicator
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.lifecycle.ViewModel
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch

sealed interface UiState {
    data object Loading : UiState
    data class Success(val items: List<String>) : UiState
    data class Error(val message: String) : UiState
}

sealed interface UserEvent {
    data object Refresh : UserEvent
    data object Retry : UserEvent
}

private class DemoRepository {
    private var attempts = 0

    suspend fun loadItems(): List<String> {
        delay(300)
        attempts += 1
        if (attempts == 1) error("临时网络错误")
        return listOf("ViewModel", "UiState")
    }
}

class ItemsViewModel : ViewModel() {
    private val repository = DemoRepository()
    private val _uiState = MutableStateFlow<UiState>(UiState.Loading)
    val uiState = _uiState.asStateFlow()

    init {
        load()
    }

    fun onEvent(event: UserEvent) {
        when (event) {
            UserEvent.Refresh,
            UserEvent.Retry -> load()
        }
    }

    private fun load() {
        viewModelScope.launch {
            _uiState.value = UiState.Loading
            _uiState.value = try {
                UiState.Success(repository.loadItems())
            } catch (error: Exception) {
                UiState.Error(error.message ?: "未知错误")
            }
        }
    }
}

@Composable
fun ItemsScreen(viewModel: ItemsViewModel = viewModel()) {
    val state by viewModel.uiState.collectAsStateWithLifecycle()

    when (val current = state) {
        UiState.Loading -> CircularProgressIndicator()
        is UiState.Error -> Column {
            Text("失败:${current.message}")
            Button(onClick = { viewModel.onEvent(UserEvent.Retry) }) {
                Text("重试")
            }
        }
        is UiState.Success -> Column {
            current.items.forEach { Text(it) }
            Button(onClick = { viewModel.onEvent(UserEvent.Refresh) }) {
                Text("刷新")
            }
        }
    }
}

预期结果

text
启动页面:先显示加载指示器,随后显示“失败:临时网络错误”和“重试”按钮
点击重试:再次短暂显示加载指示器,随后显示“ViewModel”和“UiState”
点击刷新:再次进入 Loading,随后仍显示成功列表

示例中的 300 毫秒只是为了让状态变化更容易观察,真实网络耗时会不同。UiState 的更新集中在 ViewModel 内部,因此 UI 不需要知道请求细节,只需按照当前状态渲染。

避免把所有东西都塞进一个状态类

并不是所有页面都必须用三分支的密封类型。如果搜索词、筛选项、列表和刷新标记能够同时存在,一个不可变 data class 往往更自然;如果 Loading、Success、Error 在业务上互斥,密封类型更能阻止非法组合。选择标准是页面状态之间的关系,而不是固定套模板。

同样,事件类型应该表达用户意图,而不是暴露控件细节。例如 Retry 比“第二个按钮被点击”更稳定。ViewModel 收到事件后更新状态,UI 再根据新状态决定显示什么,这样页面逻辑即使从传统 View 改为 Compose,核心状态模型仍然可以保持清晰。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

UiState 与用户事件

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通