如何查看Firestore中变更文档的前后快照及嵌套数组变动？

Firestore的SnapshotListener没有直接提供对比嵌套数组变更的公共API，也绝对不建议依赖私有字段oldDocuments()（内部实现随时可能修改或移除，导致代码不稳定）。正确的做法是自行维护数组的历史状态，在每次快照回调中对比当前数组与历史数组，计算新增/删除项。

具体实现步骤 #

1. 定义数据模型（针对自定义对象数组） #

如果嵌套数组存储的是自定义对象，必须重写equals()和hashCode()（以元素的唯一标识为判断依据），否则集合对比会失效：

// 嵌套数组的元素类型
data class NestedItem(val itemId: String, val content: String) {
    // 以itemId作为元素唯一性判断标准
    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (javaClass != other?.javaClass) return false
        other as NestedItem
        return itemId == other.itemId
    }

    override fun hashCode(): Int {
        return itemId.hashCode()
    }
}

// 文档的整体数据模型
data class TargetDocument(val nestedArray: List<NestedItem> = emptyList())

2. 维护历史数组状态 #

在类中声明变量存储上一次快照的数组内容：

private var previousNestedArray: List<NestedItem>? = null

3. 在SnapshotListener中对比数组变更 #

在监听回调里获取当前数组，与历史数组对比计算新增/删除项：

// 初始化Firestore文档监听
firestore.collection("your_collection_name")
    .document("target_document_id")
    .addSnapshotListener { snapshot, error ->
        error?.let {
            // 处理监听错误
            return@addSnapshotListener
        }

        snapshot?.takeIf { it.exists() }?.let { docSnapshot ->
            // 将快照转换为数据模型，获取当前嵌套数组
            val currentDoc = docSnapshot.toObject(TargetDocument::class.java)
            val currentNestedArray = currentDoc?.nestedArray ?: emptyList()

            // 存在历史数据时才执行对比逻辑
            previousNestedArray?.let { oldArray ->
                // 计算新增项：当前数组有但历史数组没有的元素
                val addedItems = currentNestedArray subtract oldArray
                // 计算删除项：历史数组有但当前数组没有的元素
                val removedItems = oldArray subtract currentNestedArray

                // 根据业务需求处理变更
                if (addedItems.isNotEmpty()) {
                    // 处理新增逻辑，例如更新UI、记录日志等
                }
                if (removedItems.isNotEmpty()) {
                    // 处理删除逻辑
                }
            }

            // 更新历史数组为当前数组，供下一次对比使用
            previousNestedArray = currentNestedArray
        } ?: run {
            // 文档不存在时，重置历史数组
            previousNestedArray = null
        }
    }

4. 基本类型数组的简化处理 #

如果嵌套数组是String、Int等基本类型，无需重写equals()，直接用集合差集即可：

// 假设数组是List<String>类型
private var previousStringArray: List<String>? = null

// 监听回调中的对比逻辑
previousStringArray?.let { oldArray ->
    val addedItems = currentStringArray subtract oldArray
    val removedItems = oldArray subtract currentStringArray
    // 处理变更逻辑
}

注意事项 #

• 自定义对象的equals()和hashCode()逻辑必须准确，否则无法识别元素的新增/删除。
• 首次监听触发时，previousNestedArray为null，此时仅初始化历史状态，无需对比。
• 若文档被删除，需及时重置历史数组，避免后续对比出错。

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