游戏客户端架构 / 系统课时
命名规则怎样兼顾人工和脚本
命名规则怎样兼顾人工和脚本
资源命名既要让美术、策划和程序一眼看懂,也要让导入脚本能够稳定解析。本节建立一套可落地的字段顺序、大小写、版本和唯一性规则,并用一个简单脚本验证名称,避免规则只存在于文档里却无法自动执行。
学习目标
- 设计模型、材质、贴图、动画和预制资源都能复用的命名字段
- 明确大小写、分隔符、版本后缀和唯一标识的使用边界
- 编写脚本校验资源名称,使人工约定变成可执行规则
先把名称当成稳定接口
文件名不仅给人看,还常被导入器、批处理脚本、构建流水线和运行时代码读取。因此,好的规则首先应该可解析,其次才是尽可能详细。
可以把一个资源名控制在几个稳定字段内:
业务对象_资源角色_变体_可选标记
例如 hero_knight_body_lod0、hero_knight_body_normal、hero_knight_run_loop。字段含义应固定,不要让同一个位置今天表示版本,明天又表示颜色。
常见资源可以约定如下:
| 资源 | 推荐名称 | 关键字段 |
|---|---|---|
| 模型 | hero_knight_body_lod0 |
对象、部位、LOD |
| 材质 | hero_knight_body_mat |
对象、部位、角色 |
| 贴图 | hero_knight_body_normal |
对象、部位、纹理语义 |
| 动画 | hero_knight_run_loop |
对象、动作、播放特征 |
| 预制资源 | hero_knight_combat_prefab |
对象、用途、资源角色 |
这里没有强制所有资源拥有相同数量的字段。真正需要统一的是字段顺序和语义,而不是为了整齐给每个名字塞入没有信息价值的占位词。
大小写和分隔符必须只有一种答案
跨 Windows、macOS、Linux、版本控制系统和构建节点时,大小写差异很容易从“看起来没问题”变成实际路径错误。团队应直接规定一种规范,例如:
- 文件名全部使用小写 ASCII 字母、数字和下划线。
- 单词之间统一使用下划线,不混用空格、短横线和驼峰。
- 禁止中文、空格和工具自动产生的
copy、final2、new等临时词。 - 名称中的资源类型后缀只有在确实帮助识别或脚本处理时保留。
例如 HeroKnight_Body-Normal.png 即使人工能够读懂,也会让大小写和分隔符校验复杂化;规范化后使用 hero_knight_body_normal.png 更容易被所有工具一致处理。
用脚本验证而不是依赖人工记忆
下面的 Python 示例检查资源基本名称是否只包含小写字母、数字和下划线,同时拒绝连续下划线以及首尾下划线。实际项目可以在此基础上继续检查资源角色和字段数量。
import re
NAME_PATTERN = re.compile(r"^[a-z0-9]+(?:_[a-z0-9]+)*$")
def validate_asset_name(name: str) -> bool:
# 这里只校验不含扩展名的资源基本名称,便于不同文件格式复用规则。
return NAME_PATTERN.fullmatch(name) is not None
def main() -> None:
samples = [
"hero_knight_body_normal",
"hero_knight_run_loop",
"HeroKnight_body",
"hero__knight_body",
]
for name in samples:
result = "OK" if validate_asset_name(name) else "INVALID"
print(f"{name}: {result}")
if __name__ == "__main__":
main()预期输出
hero_knight_body_normal: OK
hero_knight_run_loop: OK
HeroKnight_body: INVALID
hero__knight_body: INVALID这类校验最好同时接入提交前检查和持续集成。这样命名错误在资源进入主分支前就会暴露,而不是等到打包或运行时才发现脚本找不到文件。
版本号不要承担版本管理系统的职责
长期资产不要普遍使用 v1、v2、final、final2 作为版本管理方式。Git、Perforce 等版本控制系统已经负责历史版本,文件名中的版本字段应该只用于多个版本必须同时存在的情况。
例如,同一角色同时保留两套可被游戏引用的网格时,可以使用 hero_knight_body_lod0 和 hero_knight_body_lod1;如果只是昨天和今天两个修改版本,则应保持同一个规范文件名,由版本控制系统记录变化。
唯一性也不等于给每个文件追加随机 ID。优先通过稳定的业务上下文获得唯一名称,例如 weapon_sword_iron_icon 与 weapon_sword_steel_icon。只有资源确实没有自然业务键,而且下游系统要求全局唯一标识时,才额外维护 GUID,并尽量把 GUID 放在元数据中而不是人工频繁编辑的文件名里。
规则要允许合理例外
命名规则的目标是降低协作成本,而不是制造超长文件名。一个实用的判断标准是:脚本能稳定解析关键字段,成员能从名字识别资源归属和用途,同时重命名不会因为添加无关字段而频繁发生。
外部供应商文件、引擎自动生成文件或第三方插件目录通常不应强行批量重命名。更安全的做法是在导入边界完成映射或转换,把团队自己的规范应用到进入正式资源库后的资产。这样人工阅读、自动校验和第三方兼容性才能同时成立。