如何将Firestore监听代码转为Swift异步函数并实现实时更新？

问题分析 #

Firestore的snapshots()是一个AsyncSequence，会持续推送文档修改的快照，普通的async函数只能返回单次结果，无法承载这种实时更新的流数据。所以不能直接用async函数返回文档，而是要在ViewModel中通过@Published属性推送更新，同时用Task管理监听生命周期。

官方原代码（参考） #

你提到的在View的.task中可运行的官方代码：

.task {
    let docRef = Firestore.firestore().collection("yourCollection").document(documentID)
    for await snapshot in docRef.snapshots() {
        let data = snapshot.data()
        // 直接更新UI数据
    }
}

正确的ViewModel封装实现 #

import FirebaseFirestore
import Foundation

class DocumentViewModel: ObservableObject {
    // 用于推送实时更新的文档数据
    @Published var documentData: [String: Any]?
    // 推送错误信息
    @Published var fetchError: Error?
    // 管理监听任务，方便取消
    private var listenerTask: Task<Void, Never>?
    
    /// 开始监听指定ID的文档，实时接收更新
    /// - Parameter documentID: 目标文档的ID
    func startListening(to documentID: String) {
        // 先取消已有监听，避免重复订阅
        listenerTask?.cancel()
        
        listenerTask = Task { [weak self] in
            guard let self = self else { return }
            let docRef = Firestore.firestore().collection("yourCollection").document(documentID)
            
            do {
                // 遍历AsyncSequence获取实时快照
                for try await snapshot in docRef.snapshots() {
                    // 检查任务是否已取消，避免无效更新
                    guard !Task.isCancelled else { break }
                    self.documentData = snapshot.data()
                    self.fetchError = nil
                }
            } catch {
                guard !Task.isCancelled else { return }
                self.fetchError = error
                self.documentData = nil
            }
        }
    }
    
    /// 停止监听，释放资源
    func stopListening() {
        listenerTask?.cancel()
        listenerTask = nil
    }
}

预期的调用方式（View中使用） #

struct DocumentView: View {
    @StateObject private var viewModel = DocumentViewModel()
    // 传入目标文档ID
    let targetDocumentID: String
    
    var body: some View {
        VStack(spacing: 16) {
            if let data = viewModel.documentData {
                // 自定义展示文档内容
                Text("文档数据：\(data.description)")
            } else if let error = viewModel.fetchError {
                Text("加载失败：\(error.localizedDescription)")
            } else {
                ProgressView("加载中...")
            }
        }
        .onAppear {
            // 页面出现时开始监听
            viewModel.startListening(to: targetDocumentID)
        }
        .onDisappear {
            // 页面消失时停止监听，避免内存泄漏
            viewModel.stopListening()
        }
    }
}

核心要点 #

• 用@Published替代async函数返回值：因为实时更新是持续的数据流，@Published可以让View自动响应数据变化。
• 用Task管理监听：方便在切换文档或页面消失时取消任务，防止无用请求和内存泄漏。
• 弱引用+取消检查：避免ViewModel被循环引用，同时确保任务取消后不会再更新UI。

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