游戏客户端架构 / 系统课时
哪些资源应该进入版本库
哪些资源应该进入版本库
资源目录里既有美术和音频源文件,也有导入缓存、临时数据库和打包产物。本节给出一套可落地的判断方法:哪些内容必须随代码一起版本化,哪些内容应该通过工具重新生成,以及如何用忽略规则把边界固定下来。
学习目标
- 区分源资产、导入结果、缓存文件和构建产物的管理方式
- 根据“是否能可靠重建”判断资源是否应该提交版本库
- 编写并验证一组可维护的忽略规则
版本库保存的是不可替代的输入
判断一个文件是否应该提交,不要先看它占多少空间,而要问:如果把它删除,只拿版本库中的其余内容和明确的工具版本,能否稳定重建它?
通常,创作者直接制作或人工维护的内容属于不可替代输入,例如模型源文件、贴图原图、音频源文件、关卡数据、资源配置和导入参数。这些内容一旦丢失,仅靠构建工具无法恢复,应该进入版本库,或者进入团队明确采用的版本化大文件存储方案。
自动生成的数据则要进一步区分。导入数据库、缩略图、着色器缓存和中间转换文件通常能够由源资产重新生成,提交后反而容易产生机器差异、频繁变更和合并冲突。安装包、压缩包等最终构建产物也通常由持续集成系统或发布系统保存,而不是长期混在源代码仓库中。
| 资源类别 | 典型内容 | 默认策略 |
|---|---|---|
| 源资产 | 模型源文件、原始贴图、音频、动画、关卡数据 | 版本化 |
| 人工配置 | 导入参数、资源清单、构建配置 | 版本化 |
| 可重建导入数据 | 转换后的中间文件、资源索引数据库 | 通常忽略 |
| 本机缓存 | 缩略图、编译缓存、临时日志 | 忽略 |
| 构建产物 | 安装包、资源包、发布压缩包 | 仓库外归档 |
用可重建性划清项目边界
假设项目约定 AssetsSource/ 保存创作源文件,GameProject/ 保存工程和人工配置,而 .cache/、.import-db/、build/ 都由工具产生。此时版本库边界可以直接写成忽略规则。
# 本机缓存
.cache/
# 可重新生成的资源导入数据库
.import-db/
# 本地构建输出
build/
# 临时日志和中间文件
logs/
*.tmp这里故意没有使用诸如 *.png、*.fbx 这样的宽泛规则,因为文件扩展名无法说明一个资源是源资产还是生成资产。忽略规则最好针对明确的生成目录和生命周期,否则很容易把真正需要版本化的文件一起排除。
配置生效后,可以用 Git 自带的检查命令验证某个路径是否被规则命中。以下命令假设当前目录已经是 Git 仓库,并且 .gitignore 使用了上面的规则。
git check-ignore -q .cache/example.bin && echo ignored
git check-ignore -q build/game-package.zip && echo ignored预期输出:
ignored
ignored如果某个本应忽略的路径没有输出 ignored,应先检查规则位置、目录名称和是否已经被 Git 跟踪。.gitignore 不会自动停止跟踪已经提交过的文件,因此修改规则前后都应查看仓库状态,而不是只观察文件是否还出现在工作目录中。
已经提交的生成文件要单独清理
团队经常遇到一种情况:先把缓存或构建目录提交了,后来才补 .gitignore。这时仅增加规则不够,因为 Git 已经把这些路径记录为受控文件。
可以先确认目标确实可重建,再从 Git 索引移除,同时保留本地文件。例如下面以 .cache/ 为例:
git rm -r --cached .cache
git status --short预期结果中,这些已跟踪文件会显示为待删除,而本地 .cache/ 目录仍然存在;具体文件名取决于项目实际内容。提交这次变更后,后续由工具重新生成的缓存文件将被忽略。
用干净检出验证边界是否正确
真正可靠的版本库边界,应通过“从零开始”验证:在没有旧缓存的环境中检出仓库,安装锁定版本的工具,执行资源导入和构建。如果项目能够恢复到可运行状态,说明被忽略的数据确实只是派生结果;如果必须从某位成员电脑复制额外文件才能继续,版本库里仍然缺少必要输入。
最终应形成一个简单原则:版本库保存能够定义项目结果的源资产与人工配置;缓存、可重建中间数据和发布产物由各自的缓存或制品系统管理。 这样既能降低仓库噪声,也能让资源流水线真正具备可重现性。