Compose副作用域

Compose 中的副作用确实需要仔细管理，好在它提供了一系列副作用 API 来帮你安全、高效地处理这些场景。下面我将为你梳理这些副作用 API 的使用方法、适用场景以及一些最佳实践。

下面这个表格汇总了 Compose 中主要的副作用 API，帮助你快速了解它们的核心用途和特点：

💡 副作用 API 使用场景与示例

1. LaunchedEffect：执行协程任务

LaunchedEffect 允许你在可组合项的作用域内启动一个协程2。这个协程的生命周期会与可组合项的生命周期绑定：当可组合项进入组合或者** key 发生变化时，协程会启动或重新启动；当可组合项退出组合**时，协程会自动取消12。

基本用法：

kotlin

复制

下载

@Composable
fun MyScreen(userId: String) {
    var userData by remember { mutableStateOf<User?>(null) }

    // 当 userId 变化时，LaunchedEffect 会取消当前协程并重新启动一个新的
    LaunchedEffect(key1 = userId) {
        userData = userRepository.fetchUser(userId) // 假设 fetchUser 是挂起函数
    }

    // 根据 userData 显示 UI
    if (userData != null) {
        Text(text = "Hello, ${userData!!.name}")
    } else {
        CircularProgressIndicator()
    }
}

关键点：

• key 参数：用于控制协程的重启行为。只有当 key 发生变化时，LaunchedEffect 才会取消当前协程并启动一个新的。如果你希望效果只运行一次，可以使用 LaunchedEffect(Unit)27。

• 自动取消：当可组合项退出组合或 key 变化时，内部协程会自动取消，无需手动管理17。

• 常见场景：数据加载1、显示 Snackbar2、执行动画7。

2. rememberCoroutineScope：在组合外启动协程

rememberCoroutineScope 会返回一个与当前组合点生命周期绑定的 CoroutineScope。当你需要在可组合项之外（例如在按钮的 onClick 回调中）启动协程时，它非常有用25。

基本用法：

kotlin

复制

下载

@Composable
fun MyComposable() {
    val coroutineScope = rememberCoroutineScope() // 获取与组合绑定的协程作用域

    Button(
        onClick = {
            coroutineScope.launch { // 在按钮点击回调中启动协程
                // 执行一些异步操作，如提交数据
                submitData()
            }
        }
    ) {
        Text("Submit")
    }
}

关键点：

• 使用 rememberCoroutineScope 启动的协程会在组合退出时自动取消2。

• 适用于需要响应 UI 事件（如点击）而触发的异步操作2。

3. DisposableEffect：管理需要清理的资源

DisposableEffect 专为那些需要在组合退出或 key 变化时进行清理的副作用而设计，例如注册和取消注册监听器、订阅和取消订阅数据源等12。

基本用法：

kotlin

复制

下载

@Composable
fun HomeScreen(lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current) {
    val currentOnStart by rememberUpdatedState(onStart) // 使用 rememberUpdatedState 保持最新回调

    DisposableEffect(key1 = lifecycleOwner) {
        val observer = LifecycleEventObserver { _, event ->
            if (event == Lifecycle.Event.ON_START) {
                currentOnStart() // 执行最新的 onStart 回调
            }
        }
        lifecycleOwner.lifecycle.addObserver(observer)

        onDispose { // 必须实现 onDispose 块进行清理
            lifecycleOwner.lifecycle.removeObserver(observer)
        }
    }

    // ... 其他 UI 内容
}

关键点：

• 必须包含 onDispose 块：DisposableEffect 强制你提供一个 onDispose 块来释放资源，否则编译会报错2。

• key 变化会触发重启和清理：如果 key1 参数发生变化，DisposableEffect 会先执行上一次的 onDispose 清理，然后重新执行副作用代码6。

• 常见场景：生命周期监听2、广播接收器、订阅 RxJava 流。

4. SideEffect：每次重组后执行

SideEffect 用于在每次成功的重组之后执行一些操作。它没有 key 参数，因此每次重组都会运行1。它通常用于与 Compose 状态无关的轻量级操作，例如记录日志或上报分析事件。

基本用法：

kotlin

复制

下载

@Composable
fun TrackScreenView(screenName: String) {
    SideEffect {
        // 每次重组后都可能会执行，用于记录屏幕浏览等轻量级操作
        analyticsTracker.trackScreenView(screenName)
    }
}

关键点：

• 无 key 参数：每次重组后都会执行1。

• 同步执行：不能在 SideEffect 中调用挂起函数1。

• 适用于轻量级操作：如记录日志1、更新分析数据1。

5. produceState：将异步数据转换为状态

produceState 用于将非 Compose 的异步数据源（如网络请求、数据库查询、Flow）转换为 Compose 的 State。它在后台使用 LaunchedEffect 来管理异步操作1。

基本用法：

kotlin

复制

下载

@Composable
fun loadUserData(userId: String): State<UserData?> {
    return produceState(initialValue = null, key1 = userId) {
        // 在协程中加载数据
        val userData = userRepository.fetchUser(userId)
        value = userData // 更新状态，触发重组
    }
}

// 在可组合项中使用
@Composable
fun UserProfile(userId: String) {
    val userData = loadUserData(userId).value // 获取状态值

    if (userData != null) {
        // 显示用户数据
    } else {
        // 显示加载中
    }
}

关键点：

• 自动管理状态：你只需要关心如何获取数据并设置 value，Compose 会帮你管理状态和重组1。

• 生命周期绑定：当可组合项退出组合时，异步操作会自动取消1。

6. derivedStateOf：优化派生状态

derivedStateOf 用于从一个或多个其他状态中派生出一个新的状态。它的主要目的是优化性能，只有当其依赖的状态发生变化并且计算结果真正改变时，才会触发重组1。

基本用法：

kotlin

复制

下载

@Composable
fun TodoList(allTodos: List<Todo>, showCompleted: Boolean) {
    val visibleTodos = remember(showCompleted, allTodos) {
        derivedStateOf {
            if (showCompleted) allTodos else allTodos.filter { !it.completed }
        }
    }

    LazyColumn {
        items(visibleTodos.value) { todo ->
            TodoItem(todo = todo)
        }
    }
}

关键点：

• 减少不必要的重组：即使依赖的状态（如 allTodos）频繁变化，但只要派生结果（visibleTodos）相同，就不会触发重组1。

• 计算应该轻量：derivedStateOf 中的计算逻辑应该尽可能快速，因为任何依赖的状态变化都会触发重新计算1。

7. rememberUpdatedState：引用最新值

rememberUpdatedState 用于解决在长生命周期的副作用（如 LaunchedEffect(Unit)）中捕获过时变量的问题。它能够确保你访问的总是该状态的最新值，而无需重启副作用6。

基本用法：

kotlin

复制

下载

@Composable
fun DelayShowMessage(message: String, onMessageShown: () -> Unit) {
    val currentOnMessageShown by rememberUpdatedState(newValue = onMessageShown) // 记住最新的回调

    LaunchedEffect(Unit) { // 使用 Unit 保证只启动一次
        delay(3000) // 等待 3 秒
        currentOnMessageShown() // 3 秒后调用最新的回调函数
    }

    Text(text = message)
}

关键点：

• 适用于长生命周期副作用中需要访问最新值的场景，如回调函数或某些状态6。

• 其本质是 remember { mutableStateOf } 加上即时更新的封装6。

🧠 副作用管理最佳实践

1. 遵循最小作用域原则：将副作用限制在尽可能小的作用域内，避免不必要的重启和资源消耗1。

2. 谨慎选择 Key：为副作用 API（如 LaunchedEffect, DisposableEffect）选择合适的 key，确保它们在真正需要的时候才重启。Key 应该是稳定且必要的1。

3. 及时清理资源：对于使用 DisposableEffect 注册的监听器或订阅，务必在 onDispose 中清理，防止内存泄漏12。

4. 避免不稳定的依赖：不要将频繁变化或不可预测的对象作为副作用 API 的 key1。

5. 状态提升：将可共享的状态提升到更高的层级，以便多个可组合项复用，并简化副作用管理1。

6. 纯 UI 逻辑：尽量将业务逻辑移出可组合项，放在 ViewModel 或其他业务层中，使可组合项更专注于 UI 渲染1。

⚠️ 注意事项

• 避免在可组合项主体中直接执行副作用：例如，不要直接在其中发起网络请求或修改共享状态，因为这可能会在每次重组时意外执行16。

• 理解重组可能跳过：Compose 可能会跳过重组某些可组合项，因此不能依赖副作用的执行次数1。

• 副作用API是唯一安全通道：务必使用 Compose 提供的副作用API（如 LaunchedEffect, DisposableEffect）来管理副作用，以确保其生命周期与组合正确绑定16。

Compose 的副作用 API 是其强大功能的重要组成部分，正确使用它们可以帮你构建出既响应迅速又资源管理得当的现代化 Android 应用。希望这些信息能帮助你更好地理解和使用它们。