如何获取Firestore文档的活跃快照监听器数量并实现监控计数

核心思路 #

Firestore本身没有直接暴露监听器计数的API，但可以通过客户端标记+云函数维护计数器的方式实现：客户端订阅文档快照时，向专门的"在线状态"集合写入自身标识，取消订阅时删除该标识；云函数监听这个集合的增删操作，实时更新目标文档的计数器。

具体步骤 #

1. 客户端实现 #

• 订阅目标文档快照时，生成唯一用户标识（比如用户ID+设备ID），向/{targetDocPath}/onlineUsers子集合添加一条以该标识为ID的文档：

  // 订阅目标文档
  const unsubscribe = db.doc('chatRooms/room1').onSnapshot(snapshot => {
    // 处理快照数据
  });
  
  // 标记用户在线
  const userOnlineRef = db.doc('chatRooms/room1/onlineUsers/user1_device1');
  await userOnlineRef.set({ lastActive: firebase.firestore.FieldValue.serverTimestamp() });
  
  // 取消订阅时清理在线标记
  const cleanup = () => {
    unsubscribe();
    userOnlineRef.delete();
  };
  // 监听页面卸载/离开事件执行清理
  window.addEventListener('beforeunload', cleanup);
  

• 异常处理：若客户端意外断开（如网络中断），可借助Firestore的TTL策略自动清理超时的在线标记。

2. 云函数实现 #

• 监听onlineUsers集合的写入事件，同步更新目标文档的activeListeners计数器：

  exports.updateActiveListeners = functions.firestore
    .document('chatRooms/{roomId}/onlineUsers/{userId}')
    .onWrite(async (change, context) => {
      const roomRef = db.doc(`chatRooms/${context.params.roomId}`);
      const increment = change.after.exists ? 1 : -1;
  
      await roomRef.update({
        activeListeners: firebase.firestore.FieldValue.increment(increment)
      });
    });
  

• 初始化处理：首次使用时，需手动给目标文档设置activeListeners: 0，或在云函数中判断字段不存在时先初始化再执行增减操作。

3. 优化建议 #

• TTL自动清理：给onlineUsers集合的文档设置15分钟左右的TTL，避免客户端未正常删除标记导致计数偏差。
• 用户去重：若需按用户而非设备计数，可在onlineUsers文档中记录用户ID，云函数统计时按用户ID去重（需改为查询集合计数，而非单纯增减）。
• 性能优化：针对高并发场景，可使用分布式计数器拆分写入压力，避免触发Firestore写入限制。

注意事项 #

• 计数器为近似值，因网络或云函数执行延迟可能存在短暂不一致，但完全满足活跃用户数展示的需求。
• 需确保云函数拥有读写目标文档和onlineUsers集合的权限。

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