Firebase Firestore查询流重复返回历史文档 如何仅返回新增文档

Firestore的snapshots()流默认每次触发时都会返回当前查询条件匹配的全量文档快照，这是官方设计的默认行为，用于支撑直接渲染完整列表的业务场景。

要实现每次仅返回新增文档，不需要修改现有查询逻辑，只需要在流的转换环节处理QuerySnapshot自带的documentChanges属性即可，该字段会记录和上一次快照相比发生了变更的文档集合，筛选类型为added的变更项就能拿到纯新增的文档。

示例实现代码 #

import 'package:cloud_firestore/cloud_firestore.dart';

// 原有查询逻辑不变，仅修改map转换逻辑
Stream<List<QueryDocumentSnapshot>> getNewMessagesStream(String site, Conversation room, DateTime dateTime) {
  return FirebaseFirestore.instance
      .collection('chats/${site}/conversations/${room.id}/messages')
      .orderBy('createdAt', descending: true)
      .where("createdAt", isGreaterThan: dateTime)
      .snapshots()
      .map((snapshot) {
        // 仅筛选出新增类型的变更文档
        return snapshot.docChanges
            .where((change) => change.type == DocumentChangeType.added)
            .map((change) => change.doc)
            .toList();
      });
}

// 调用监听示例
getNewMessagesStream(site, room, DateTime.now()).listen((newDocs) {
  // newDocs 每次仅包含上一次监听触发后新增的文档
  for (var doc in newDocs) {
    Map<String, dynamic> messageData = doc.data() as Map<String, dynamic>;
    // 处理单条新增消息的业务逻辑
  }
});

注意事项 #

• 首次触发监听时，所有符合createdAt > dateTime条件的历史文档都会被标记为added类型推送。如果需要完全跳过历史数据，仅获取监听启动后新增的消息，将查询参数中的dateTime替换为监听触发时的DateTime.now()即可。
• DocumentChangeType一共包含added、modified、removed三类，如果你后续需要支持消息修改、删除的同步逻辑，增加对应类型的筛选分支即可。
• 如果业务需要缓存全量消息列表，也可以自行维护一个本地列表，每次收到added变更时往列表中追加数据，收到modified/removed变更时更新本地列表对应项即可。

内容的提问来源于stack exchange，提问作者Itai.S.