Flutter中如何确认离线修改的Firestore文档已全部同步？

Firestore本身没有直接提供“所有离线文档同步完成”的全局监听器，但可以通过以下几种方式实现类似需求：

1. 监听单个文档的同步状态 #

对每个离线写入的文档，使用DocumentReference的snapshots()监听，结合SnapshotMetadata中的hasPendingWrites属性判断：

final docRef = FirebaseFirestore.instance.collection('your_collection').doc('doc_id');
docRef.snapshots().listen((snapshot) {
  if (!snapshot.metadata.hasPendingWrites) {
    // 该文档已完成同步
  }
});

当hasPendingWrites为false时，说明该文档的本地修改已经同步到云端。

2. 跟踪所有离线写入任务 #

可以自行维护一个待同步文档ID的列表：

• 离线写入文档时，将文档ID加入列表
• 对列表中的每个文档设置上述snapshots监听，同步完成后从列表移除
• 当列表为空时，即可判定所有离线文档已同步完成

3. 结合Firestore连接状态触发检查 #

通过监听Firestore的连接状态变化，作为触发同步检查的时机：

FirebaseFirestore.instance.settings.addSettingsListener((settings) {
  if (settings.isPersistenceEnabled && settings.isOnline) {
    // 设备已联网，可开始检查待同步文档的状态
  }
});

注意：联网状态恢复不代表所有文档立刻同步完成，仅作为启动检查的信号。

4. 批量写入的回调（适用于明确的批量操作） #

如果使用writeBatch进行批量离线写入，可以通过commit()返回的Future判断批量同步结果：

final batch = FirebaseFirestore.instance.batch();
batch.set(docRef1, data1);
batch.set(docRef2, data2);

batch.commit().then((_) {
  // 该批量操作的所有文档已同步完成
}).catchError((error) {
  // 同步失败，可进行重试或错误处理
});

这种方式仅覆盖明确的批量操作，无法追踪零散的单个文档写入。

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