Flutter Firestore读取指定路径嵌套集合数据返回空如何解决

问题背景 #

现有Firestore数据结构如下：

/Admin/Dashboard/MRmZh9mixve1CV3M0EI8wfyDnb82/20220607/Anonymous/Entry

需求为读取路径/Admin/Dashboard/MRmZh9mixve1CV3M0EI8wfyDnb82下的所有数据，包含该路径下所有子集合，以及每个子集合中存储的文档。
原有实现代码返回空结果：

String collection = "/Admin/Dashboard/MRmZh9mixve1CV3M0EI8wfyDnb82";

await FirebaseFirestore.instance.collection(collection).get().then(
      (res) => print("Successfully completed ${res}"),
  onError: (e) => print("Error completing: $e"),
);

数据结构参考截图：

问题原因 #

原有代码无法拿到数据的两个核心原因：

• 路径类型不匹配：/Admin/Dashboard/MRmZh9mixve1CV3M0EI8wfyDnb82是文档路径而非集合路径，直接调用collection()方法传入文档路径属于API误用，无法正常返回结果。
• Firestore默认查询为浅查询：即使路径配置正确，直接调用get()方法也只会返回当前层级下直接挂载的文档，不会自动递归拉取所有层级的嵌套子集合数据。

可直接复用的实现代码 #

通过递归遍历文档下所有子集合的方式拉取全量数据，代码如下：

import 'package:cloud_firestore/cloud_firestore.dart';

// 配置目标文档路径
final DocumentReference targetDoc = FirebaseFirestore.instance.doc(
  "/Admin/Dashboard/MRmZh9mixve1CV3M0EI8wfyDnb82"
);
// 存储全量拉取结果，key为文档完整路径，value为文档字段数据
Map<String, Map<String, dynamic>> allNestedData = {};

Future<void> fetchAllSubCollectionData(DocumentReference docRef) async {
  // 拉取当前文档自身的字段数据
  final DocumentSnapshot currentDoc = await docRef.get();
  if (currentDoc.exists) {
    allNestedData[docRef.path] = currentDoc.data() as Map<String, dynamic>;
  }
  // 获取当前文档下挂载的所有子集合
  final List<CollectionReference> subCollections = await docRef.listCollections();
  for (final colRef in subCollections) {
    // 拉取子集合下的所有文档
    final QuerySnapshot colSnapshot = await colRef.get();
    for (final docItem in colSnapshot.docs) {
      // 递归处理每个子文档下的更深层级集合
      await fetchAllSubCollectionData(docItem.reference);
    }
  }
}

// 调用示例
void runFetch() async {
  try {
    await fetchAllSubCollectionData(targetDoc);
    print("数据拉取完成，共读取${allNestedData.length}份文档");
    // 此处可对allNestedData中的全量数据做业务处理
  } catch (e) {
    print("数据拉取报错：$e");
  }
}

注意事项 #

• 递归拉取全量嵌套数据会产生大量文档读操作，生产环境使用时需要评估数据量级，避免产生超额的计费开销。
• 如果业务中嵌套的集合层级是固定的，不建议使用通用递归逻辑，手动按层级编写查询代码性能更高，也更容易做异常处理。
• listCollections()方法默认需要管理员权限，如果在客户端（Flutter移动端、Web端）直接调用，需要配置对应的Firestore安全规则允许客户端枚举集合；更推荐将该递归逻辑部署在云函数中运行，客户端只调用云函数拿最终结果，安全性更好。

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