使用SnapshotStateList搭配LazyColumn添加新项时触发重复Key异常

问题场景 #

我在ViewModel中维护了一个可增删的SnapshotStateList，它与其他UI状态一同存储在MutableStateFlow中，以StateFlow形式暴露给Composable组件，用于切换频道时整体替换消息列表。相关代码如下：

ViewModel代码 #

data class SomeUiState(
    val channelId: String? = null,
    // ... 其他UI状态 ...
    val messages: SnapshotStateList<Message> = mutableStateListOf()
)

@HiltViewModel
class SomeViewModel @Inject constructor(
    // MessagesRepository为每个频道暴露消息的MutableStateFlow，内部处理消息的增删改
    private val messagesRepository: MessagesRepository
) : ViewModel() {
    private val _uiState = MutableStateFlow(SomeUiState())
    val uiState: StateFlow<SomeUiState> = _uiState.asStateFlow()

    // ...

    init {
        viewModelScope.launch {
            currentChannelStateFlow.collectLatest { channelId: String? ->
                _uiState.update {
                    it.copy(
                        channelId = channelId,
                        messages = messagesRepository.getMessagesForChannel(channelId)
                    )
                }
            }
        }
    }
}

Composable代码 #

val uiState by channelViewModel.uiState.collectAsState()
LazyColumn {
    itemsIndexed(
        uiState.messages,
        key = { _, it -> "${it.messageId}${it.timestamp}" },
    ) { index, message ->
        Message(message)
    }
}

多数情况下运行正常，但约10%的概率添加新消息时会触发IllegalArgumentException，提示"key is already being used"。已将毫秒级timestamp加入key排除服务器复用消息ID的可能，且日志确认触发异常的新key从未被使用过，判定是LazyColumn误判全新唯一key为重复。

原因分析 #

1. LazyColumn内部状态残留：切换频道时，通过_uiState.update替换messages列表会触发Composable重组，但LazyColumn内部可能保留旧列表的key缓存。如果新列表的某个key与旧缓存中已失效的key重叠，就会触发重复key误判。
2. 状态通知竞态：SnapshotStateList的细粒度变更通知与StateFlow的整体状态更新存在时机差，在频道切换的过渡阶段，LazyColumn可能同时处理新旧列表的状态，导致瞬时的key冲突判定。

解决方案 #

方案1：给LazyColumn绑定频道ID作为全局key #

通过为LazyColumn添加key = uiState.channelId，让频道切换时LazyColumn被完全重建，彻底清除旧的内部缓存状态：

val uiState by channelViewModel.uiState.collectAsState()
LazyColumn(key = uiState.channelId) { // 添加频道ID作为组件key
    itemsIndexed(
        uiState.messages,
        key = { _, it -> "${it.messageId}${it.timestamp}" },
    ) { index, message ->
        Message(message)
    }
}

方案2：确保消息列表实例的新鲜性 #

修改MessagesRepository的getMessagesForChannel方法，每次调用返回全新的SnapshotStateList实例，避免复用旧列表的状态：

// MessagesRepository中的实现示例
fun getMessagesForChannel(channelId: String?): SnapshotStateList<Message> {
    return if (channelId == null) {
        mutableStateListOf()
    } else {
        val channelMessages = fetchMessagesFromDataSource(channelId)
        // 创建新实例并填充数据
        mutableStateListOf<Message>().apply { addAll(channelMessages) }
    }
}

方案3：优化ViewModel状态更新时机 #

在更新UI状态前先获取完整的消息列表，确保状态更新时列表已准备完毕，避免竞态：

init {
    viewModelScope.launch {
        currentChannelStateFlow.collectLatest { channelId: String? ->
            // 先获取完整的消息列表
            val newMessages = messagesRepository.getMessagesForChannel(channelId)
            _uiState.update {
                it.copy(
                    channelId = channelId,
                    messages = newMessages
                )
            }
        }
    }
}

内容的提问来源于stack exchange，提问作者Alexis Purslane