如何检查浏览器端离线Firestore是否存在未同步至服务器的待处理写入

Firestore官方没有提供直接的全局API来批量检查所有待同步的本地更新，但可以通过以下两种方式实现需求：

方法1：通过监听全局写入状态（推荐，基于官方API） #

虽然没有全局检查的方法，但可以维护一个全局状态变量，结合文档的metadata.hasPendingWrites属性追踪状态：

• 应用初始化时，定义布尔变量hasPendingUpdates = false
• 对所有可能产生写入操作的集合/文档添加快照监听，在回调中更新状态：

  // 示例：监听目标集合的所有文档状态
  firebase.firestore().collection('target-collection').onSnapshot(querySnapshot => {
    // 检查是否存在任意文档有待同步写入
    const anyPending = querySnapshot.docs.some(doc => doc.metadata.hasPendingWrites);
    hasPendingUpdates = anyPending;
  });
  

• 这种方式需要覆盖所有可能产生写入的集合，但属于官方支持的安全方案，适合写入范围明确的应用。

方法2：使用私有API（不推荐，存在版本兼容风险） #

Firestore持久化层内部维护了待写入队列，可通过私有API直接访问：

// 获取持久化实例
const persistence = firebase.firestore()._getPersistence();
// 检查待写入队列是否非空
persistence.getPendingWrites().then(writes => {
  const hasPending = writes.length > 0;
  console.log('是否有待同步更新：', hasPending);
});

• 注意：私有API无官方维护承诺，Firestore版本更新可能导致此方法失效，仅适合临时调试或特殊场景。

当Firestore完成同步后，所有文档的metadata.hasPendingWrites会自动切换为false，可据此更新全局状态。

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