原生移动开发 / 系统课时
Compose 副作用基础
Compose 副作用基础
Composable 会随着状态变化反复重组,因此网络请求、延时任务、监听器注册等操作不能随意写在函数体里执行。Compose 提供 Effect API,把这些操作绑定到组合生命周期。本篇用一个可运行示例区分 LaunchedEffect、DisposableEffect 与 rememberCoroutineScope。
学习目标
- 根据触发时机选择
LaunchedEffect、DisposableEffect或rememberCoroutineScope - 理解 Effect 的 key 如何决定重启与清理
- 避免在普通 Composable 函数体中直接启动副作用
先按生命周期选择 API
LaunchedEffect(key) 适合“进入组合后自动启动”的协程任务;当 key 改变时旧协程会取消并重新启动,离开组合时也会取消。DisposableEffect(key) 适合需要成对注册与注销的资源。rememberCoroutineScope() 则提供与当前组合位置绑定的协程作用域,常用于点击事件里手动启动协程。

三者都与组合生命周期有关,但触发者不同:LaunchedEffect 由组合和 key 驱动,DisposableEffect 还承担清理责任,rememberCoroutineScope 通常由事件处理器驱动。
一个屏幕演示三种副作用
下面示例可直接放入已启用 Jetpack Compose 与 Material 3 的 Android 项目。MessageBus 模拟一个需要注册和注销的外部监听源,便于观察 DisposableEffect 是否正确清理。
package com.example.effects
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Button
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import kotlinx.coroutines.delay
import kotlinx.coroutines.launch
class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContent {
MaterialTheme {
SideEffectScreen()
}
}
}
}
private class MessageBus {
private val listeners = mutableSetOf<(String) -> Unit>()
fun addListener(listener: (String) -> Unit) {
listeners += listener
}
fun removeListener(listener: (String) -> Unit) {
listeners -= listener
}
fun emit(message: String) {
listeners.forEach { it(message) }
}
}
@Composable
fun SideEffectScreen() {
val bus = remember { MessageBus() }
var taskId by remember { mutableIntStateOf(1) }
var showPanel by remember { mutableStateOf(true) }
var status by remember { mutableStateOf("等待操作") }
Column(modifier = Modifier.padding(24.dp)) {
Text("状态:$status")
Button(onClick = { taskId += 1 }) {
Text("切换任务")
}
Button(onClick = { bus.emit("收到外部事件") }) {
Text("发送外部事件")
}
Button(onClick = { showPanel = !showPanel }) {
Text(if (showPanel) "移除面板" else "显示面板")
}
if (showPanel) {
EffectPanel(
taskId = taskId,
bus = bus,
onStatus = { status = it }
)
}
}
}
@Composable
private fun EffectPanel(
taskId: Int,
bus: MessageBus,
onStatus: (String) -> Unit
) {
// taskId 改变时,旧协程取消,并为新任务重新启动。
LaunchedEffect(taskId) {
delay(400)
onStatus("任务 $taskId 加载完成")
}
DisposableEffect(bus) {
val listener: (String) -> Unit = { message ->
onStatus(message)
}
bus.addListener(listener)
onDispose {
// 面板离开组合时注销监听,避免继续接收事件。
bus.removeListener(listener)
}
}
val scope = rememberCoroutineScope()
Button(
onClick = {
scope.launch {
delay(300)
onStatus("点击事件协程完成")
}
}
) {
Text("运行事件协程")
}
}预期结果
面板出现后约 400 ms,状态变为“任务 1 加载完成”。
点击“切换任务”后,LaunchedEffect 使用新的 taskId 重启并显示新任务编号。
点击“运行事件协程”后约 300 ms,状态变为“点击事件协程完成”。
移除面板后再点击“发送外部事件”,状态不会变为“收到外部事件”,因为监听器已在 onDispose 中注销。key 决定什么时候重启
Effect 中读取的外部值如果会改变,并且这种变化应该让任务重新开始,通常应把它作为 key。比如示例中的 taskId 变化后,旧加载任务已经没有意义,因此 LaunchedEffect(taskId) 会取消旧协程并启动新协程。
反过来,如果某个对象变化不应该重启 Effect,就不要随意把它加入 key。需要在不重启 Effect 的情况下读取最新回调时,可以进一步使用 rememberUpdatedState,但那属于更细的生命周期控制。
不要把副作用直接写在重组路径中
Composable 函数体应该主要负责描述 UI。若直接在函数体中启动协程、注册监听器或执行一次性任务,这些操作可能因重组被重复执行,也缺少可靠的取消或清理时机。
选择规则可以压缩成一句话:自动启动的挂起任务用 LaunchedEffect,需要注册并清理的资源用 DisposableEffect,由点击等事件主动启动协程时用 rememberCoroutineScope。