Firebase Admin Node 中 Firestore 连接问题排查与解决方案

问题背景

在使用 Firebase Admin Node SDK 连接 Firestore 数据库时，开发者经常会遇到一个常见的错误："Error: 5 NOT_FOUND"。这个错误信息非常模糊，没有提供具体的失败原因，给问题排查带来了很大困难。

错误现象

开发者在使用 getFirestore() 方法初始化 Firestore 连接后，尝试执行任何数据库操作（如创建文档、查询数据等）时，会收到这个 NOT_FOUND 错误。错误信息缺乏上下文，使得开发者难以确定问题根源。

根本原因分析

经过社区多位开发者的实践和验证，发现这个问题主要与 Firestore 数据库的命名和初始化配置有关：

1. 数据库命名问题：许多开发者创建 Firestore 数据库时使用了自定义名称（如"prod"、"dev"等），而不是保留默认的"(default)"名称。当使用 Admin SDK 时，如果没有显式指定数据库名称，SDK 会默认寻找名为"(default)"的数据库。

2. 初始化配置缺失：在使用 getFirestore() 方法时，如果项目中有多个数据库或使用了非默认名称的数据库，但没有在初始化时指定数据库ID，就会导致连接失败。

解决方案

方案一：使用默认数据库名称

最简单的解决方案是确保你的 Firestore 数据库使用默认名称"(default)"：

1. 在 Firebase 控制台中删除现有的非默认名称数据库
2. 创建一个新数据库，在命名时选择"(default)"选项

这种方法适用于大多数标准场景，特别是对于新项目或可以接受重建数据库的情况。

方案二：显式指定数据库ID

如果你必须使用自定义名称的数据库，可以在初始化时显式指定数据库ID：

const { getFirestore } = require("firebase-admin/firestore");
const db = getFirestore("your-custom-database-id");

其中"your-custom-database-id"应替换为你在 Firebase 控制台中为数据库设置的实际名称。

方案三：检查服务账户配置

确保你的服务账户配置正确：

1. 确认服务账户JSON文件是从正确的Firebase项目生成的
2. 检查服务账户是否具有足够的Firestore访问权限
3. 验证初始化代码是否正确加载了服务账户凭证

最佳实践建议

1. 错误处理：在代码中添加详细的错误处理逻辑，捕获并记录完整的错误堆栈，而不仅仅是错误消息。

2. 环境配置检查：实现一个启动时的配置验证步骤，主动检查Firestore连接是否正常。

3. 多环境管理：对于开发、测试和生产环境使用不同的Firebase项目，而不是同一个项目中的不同数据库。

4. 文档记录：在项目文档中明确记录使用的数据库名称和配置要求，方便团队成员查阅。

技术细节

Firebase Admin SDK 在底层使用Google Cloud的API与Firestore通信。当数据库不存在或不可访问时，API会返回NOT_FOUND错误。Admin SDK 默认寻找"(default)"数据库的行为是为了保持向后兼容性，因为这是Firestore最初推出时的唯一选项。

总结

"Error: 5 NOT_FOUND"错误虽然表面信息有限，但通过理解其背后的工作机制，可以有效地解决。开发者应根据项目需求选择使用默认数据库名称或显式指定数据库ID的方案。随着Firebase支持多数据库功能，明确指定数据库ID的做法将成为更可靠的长期解决方案。