包含 Flutter 应用和静态网站的 Firebase 项目如何组织 GitHub 仓库?
建议优先使用 monorepo,将 Flutter 应用、静态网站、Cloud Functions 和 Firestore 配置放在同一个仓库中,分别构建和部署。这个建议适用于你描述的共享后端场景。如果各部分由不同团队维护,或需要隔离代码访问权限,使用多仓库也合理。
先确认移动应用和网站是否连接同一个 Firebase 项目中的同一个 Cloud Firestore 数据库。如果是,安全规则集中维护和部署一份即可,无需按客户端分别部署。
Firestore 规则为什么不需要维护两份?
Firestore 安全规则部署在数据库端。连接同一数据库的移动端和 Web 客户端,其请求都会接受该数据库已部署规则的检查。客户端代码所在的 GitHub 仓库不会改变规则的作用范围。规则的配置和发布方式可参见 Firebase 安全规则部署文档。
如果两个仓库各自保留并发布一份规则,容易出现维护分叉:一边修改了权限,另一边随后部署旧文件,就可能覆盖这些修改。
如果两端连接的是不同的 Firebase 项目或数据库,则需要分别管理部署目标。是否复用同一份规则,取决于数据结构和权限需求。
monorepo 可以怎样组织?
可以从以下结构开始,目录名称按项目习惯调整:
project/
├── apps/
│ ├── mobile/ # Flutter 项目
│ └── website/
│ └── public/ # 可部署的静态网站文件
├── functions/ # Cloud Functions 项目
├── tests/
│ └── firestore/ # 安全规则测试
├── firestore.rules
├── firestore.indexes.json
├── firebase.json
├── .firebaserc
└── .github/
└── workflows/
这种结构方便在一个 Pull Request 中审查客户端、后端和权限规则的关联修改。Flutter 和网站仍可以各自管理依赖、执行测试和发布,放在同一个仓库中不要求它们使用相同的发布周期。
假设网站可部署文件位于 apps/website/public,根目录的 firebase.json 可以包含:
{
"firestore": {
"rules": "firestore.rules",
"indexes": "firestore.indexes.json"
},
"functions": {
"source": "functions"
},
"hosting": {
"public": "apps/website/public",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
]
}
}
这是一个目录映射示例,需要合并进现有配置,并保留项目所需的其他设置。如果网站需要构建,hosting.public 应指向实际构建产物目录。该字段决定上传到 Firebase Hosting 的目录,详见 Hosting 配置文档。
如何避免部署相互影响?
统一仓库后,仍可以按组件分别部署。例如,在根目录运行以下命令,将 YOUR_PROJECT_ID 替换为目标 Firebase 项目 ID:
# 仅部署 Firestore 安全规则
firebase deploy --only firestore:rules --project YOUR_PROJECT_ID
# 仅部署 Cloud Functions
firebase deploy --only functions --project YOUR_PROJECT_ID
# 仅部署静态网站
firebase deploy --only hosting --project YOUR_PROJECT_ID
Firebase CLI 支持选择性部署规则,具体说明见 规则部署文档。Flutter 移动应用继续通过自己的构建和发布流程交付。
还建议约定以下事项:
- 指定唯一负责部署 Firestore 规则的工作流,避免多个流程发布不同副本。
- 使用 GitHub Actions 的路径过滤减少无关构建;规则变化时仍应运行相关权限测试。
- 发布前通过 Firebase Emulator 检查允许访问和拒绝访问的场景。
- 调整字段或权限时,考虑已发布的移动端旧版本。同一个提交包含所有修改,不意味着所有客户端会同时升级。
什么情况下保留多仓库?
如果移动端、网站和后端有明确的团队或权限边界,可以保留两个客户端仓库,再建立一个后端仓库,集中管理 Cloud Functions、Firestore 规则、索引和 Firebase 部署配置。
增加第三个仓库在结构上没有问题。后端仓库负责后端资源的版本和发布,客户端仓库无需复制规则。GitHub Actions 负责执行测试和部署,规则源文件的归属仍需要单独约定。
按目前的描述,monorepo 能减少跨仓库协调。如果拆仓确实有利于团队管理,就集中管理后端配置,并记录客户端依赖的数据结构和权限变化。
备注:内容仅供参考。
