Firestore LiveData数据异常：单场景为空/Null，另一场景正常的原因排查

我尝试通过两种不同流程从Firestore数据库获取name字段，两种流程均借助工具类以Flow<List<String>>获取数据，再在ViewModel中收集并转换为LiveData<List<String>>。但其中一种场景（Case1）获取的数据为空或Null，另一种场景（Case2）能得到正确结果，无法定位原因。

Case1（获取空/Null值） #

1. ViewModel核心代码 #

val firestoreHelperForToken = FirestoreHelperForToken()
private val _getAllNames = MutableLiveData<List<String>>()
val getAllNames : LiveData<List<String>> get() = _getAllNames

init {
        viewModelScope.launch {
            firestoreHelperForToken.fetchAllNames.collect { namesList ->
                _getAllNames.postValue(namesList)
                Log.d("ChatViewModel", "List from Firestore: $namesList")
                delay(100)
                if (!namesList.isNullOrEmpty()) {
                    Log.d("ChatViewModel", "Valid list received: $namesList")
                } else {
                    Log.d("ChatViewModel", "Empty list received.")
                }
            }
            Log.d("ChatViewModel", "List outside the collect block: ${getAllNames.value}")
}}

2. 工具类核心代码 #

class FirestoreHelperForToken {
private val TAG = "FirestoreHelperForToken"
private val _db = Firebase.firestore
val fetchAllNames: Flow<List<String>> = channelFlow {
        Log.d(TAG, "Setting up addSnapshotListener")
        _db.collection("tokens")
            .addSnapshotListener { snapshot, e ->
                if (e != null) {
                    Log.w(TAG, "Listen failed with error: $e")
                    return@addSnapshotListener
                }
                if (snapshot == null || snapshot.isEmpty) {
                    Log.d(TAG, "Snapshot is null or empty.")
                    trySend(emptyList())
                    return@addSnapshotListener
                }
                val namesList = mutableListOf<String>()
                Log.d(TAG, "Snapshot size: ${snapshot.size()}")
                for (document in snapshot.documents) {
                    val name = document.getString("name")
                    name?.let {
                        namesList.add(it)
                    }
                }
                try {
                    Log.d(TAG, "Names list: $namesList")
                    trySend(namesList)
                } catch (sendError: Exception) {
                    Log.e(TAG, "Error while sending names list: ${sendError.message}")
                }
            }
    }.flowOn(Dispatchers.IO)
}

3. 对应日志 #

2024-10-06 10:57:26.586  1389-1422  FirestoreHelperForToken com.example.fcmpractice              D  Setting up addSnapshotListener
2024-10-06 10:57:27.296  1389-1389  ChatViewModel           com.example.fcmpractice              D  List outside the collect block: null
2024-10-06 10:57:27.299  1389-1389  FirestoreHelperForToken com.example.fcmpractice              D  Snapshot size: 17
2024-10-06 10:57:27.312  1389-1389  FirestoreHelperForToken com.example.fcmpractice              D  Names list: [mona, abhijit, mahesh, raka, ritu, ranna, jodha, biru, madhav, babu, rajat, sujal, mauni, meme, raghav, mamu, nammy]

Case2（获取正确列表，仅实现细节调整） #

1. 工具类代码 #

fun getNamesFlow() : Flow<List<String>> = callbackFlow {
        val collectionRef = _db.collection("tokens")
        val listener = collectionRef.addSnapshotListener { snapshot, error ->
            if (error != null) {
                close(error)
                return@addSnapshotListener
            }
            if (snapshot != null && !snapshot.isEmpty){
                val nameList = snapshot.documents.map {
                    it.getString("name") ?: ""
                }
                trySend(nameList)
        }else{
                trySend(emptyList())
            }
        }
        awaitClose {
            listener.remove()
        }
    }

2. ViewModel代码 #

viewModelScope.launch {
Log.d("ChatViewModel", "List outside the collect block: ${getAllNames.value}")
     firestoreHelperForToken.getNamesFlow()
                .collect { namesList ->
                    _getAllNames.postValue(namesList)
                    Log.d("ChatViewModel", "List from Firestore: $namesList")
                }
}

3. 对应日志 #

2024-10-06 11:03:12.399  1851-1851  ChatViewModel           com.example.fcmpractice              D  List outside the collect block: null
2024-10-06 11:03:13.103  1851-1851  ChatViewModel           com.example.fcmpractice              D  List from Firestore: [mona, abhijit, mahesh, raka, ritu, ranna, jodha, biru, madhav, babu, rajat, sujal, mauni, meme, raghav, mamu, nammy]

核心差异原因分析 #

1. Flow生命周期管理缺失（最关键） #

Case1使用channelFlow实现，但未添加awaitClose逻辑：

• channelFlow代码块仅完成监听器注册后就执行完毕，Channel会自动关闭，Flow随即终止。
• 当Firestore异步回调返回数据时，Channel已关闭，trySend无法将数据发送到Flow，导致ViewModel的collect块完全接收不到数据，LiveData始终为Null。

Case2使用callbackFlow并添加awaitClose { listener.remove() }：

• awaitClose会挂起当前协程，直到Flow被取消（如ViewModel销毁），确保Channel保持打开状态。
• Firestore回调返回数据时，Channel处于活跃状态，trySend能正常将数据发送到Flow，ViewModel的collect块可接收并更新LiveData。

2. Flow创建时机与线程调度问题 #

Case1中fetchAllNames是类成员属性，在FirestoreHelperForToken实例化时就创建了Flow：

• 加上flowOn(Dispatchers.IO)将Flow创建切换到IO线程，但Firestore监听器回调默认在主线程执行，此时Channel可能因channelFlow块执行完毕已关闭，进一步导致数据发送失败。

Case2中getNamesFlow()是函数，每次调用都会创建新的callbackFlow：

• 确保每次collect时都有全新且保持打开的Channel，避免提前关闭问题；同时无额外线程切换，回调线程与Flow发送线程一致，减少潜在线程冲突。

3. 错误处理与数据发送逻辑 #

Case1错误地用try-catch包裹trySend：

• trySend本身不会抛出异常，它返回Result对象表示发送结果，因此这个try-catch完全无效，无法捕获发送失败情况（如Channel关闭），导致问题难以排查。

Case2错误处理更合理：

• 遇到Firestore错误时调用close(error)终止Flow并传递错误，符合Flow错误处理规范；同时无需多余try-catch，逻辑更清晰。

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