使用orderBy函数后Firebase Firestore未返回用户数据问题

问题背景 #

希望通过orderBy("name")从Firestore的users集合中按字母顺序获取排除当前用户的列表，但返回结果为undefined。Firestore数据结构说明：users集合下的文档包含uid（字符串类型，用户唯一标识）、name（字符串类型，用户名称）等字段，文档ID由Firestore自动生成。

服务层代码如下：

class UsersService {
  async getUsers(): Promise<IUser[] | undefined> {
    const userUid = auth.currentUser?.uid;

    const q = query(
      collection(db, "users"),
      where("uid", "!=", userUid),
      orderBy("name")
    );
    const querySnapshot = await getDocs(q);
    return querySnapshot.docs.map((doc) => doc.data() as IUser);
  }
}

排查方向与解决方案 #

1. 缺少复合索引导致查询失败 #

Firestore同时使用where和orderBy时必须创建复合索引，否则查询会抛出未捕获的错误，最终导致函数返回undefined。

解决：

• 运行代码后查看控制台错误信息，里面会包含直接跳转至Firestore控制台创建索引的链接，点击即可一键生成所需索引；
• 也可手动登录Firestore控制台，进入「索引」页面，添加复合索引：集合选择users，字段选择uid（匹配条件为「等于」）和name（排序方式按需选择升序/降序），保存后等待索引生效（通常需数分钟）。

2. 未捕获异步查询异常 #

当前代码未对getDocs的异步操作做错误处理，一旦出现网络问题、权限不足等情况，查询会抛出异常，函数返回rejected状态的Promise，若调用方未正确处理，就会得到undefined。

修改代码添加错误捕获：

class UsersService {
  async getUsers(): Promise<IUser[] | undefined> {
    try {
      const userUid = auth.currentUser?.uid;
      
      // 提前处理未登录场景，避免无效查询
      if (!userUid) {
        console.warn("当前用户未登录，无法获取其他用户列表");
        return [];
      }

      const q = query(
        collection(db, "users"),
        where("uid", "!=", userUid),
        orderBy("name")
      );
      const querySnapshot = await getDocs(q);
      return querySnapshot.docs.map((doc) => doc.data() as IUser);
    } catch (error) {
      console.error("获取用户列表失败:", error);
      return undefined; // 或根据业务需求返回空数组
    }
  }
}

3. 当前用户未登录导致查询条件异常 #

若用户未登录，auth.currentUser为null，此时userUid是undefined，where("uid", "!=", undefined)会匹配所有存在uid字段的文档，但如果集合中没有其他用户，会返回空数组；若查询因其他异常失败，则返回undefined。

解决：

• 在查询前添加用户登录状态校验，如上述代码中的if (!userUid)逻辑，提前拦截无效请求并给出提示。

4. 部分文档缺少name字段 #

如果users集合中存在没有name字段的文档，Firestore会将这类文档排在排序结果的最前端，但如果所有文档都缺失name，或IUser接口要求name为必填项，会导致数据映射时出现问题，进而返回异常结果。

解决：

• 检查Firestore中的用户文档，确保每个文档都包含name字段；
• 映射数据时添加字段校验，避免类型断言出错：

return querySnapshot.docs.map((doc) => {
  const data = doc.data();
  // 给缺失name的文档设置默认值
  return { ...data, name: data.name || "未知用户" } as IUser;
});

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