游戏客户端架构 / 系统课时

提交配置前怎样自动校验

提交配置前怎样自动校验

配置错误越晚发现,修复成本越高。与其等游戏启动、测试服报错甚至线上出现异常,不如在提交和构建前自动检查字段结构、数据类型、数值范围以及跨表引用,让明显错误在进入主分支之前就失败。

学习目标

  • 为配置建立结构、类型、范围和引用四层校验
  • 编写一个可以返回明确失败状态的最小校验程序
  • 把同一套校验接入本地提交检查和持续集成流程

校验应该覆盖哪些错误

第一层是结构检查,例如每个道具必须包含 itemId、name 和 price。第二层是类型检查,防止把数值字段写成任意字符串。第三层是业务范围,例如价格不能小于 0、概率必须处于合法区间。

第四层是跨表引用,它往往最容易漏掉。比如商店配置引用了 itemId=2001,但道具主表已经删除这个编号,单独检查两张表的 JSON 格式都不会报错,只有建立引用完整性检查才能发现问题。

配置从编辑到提交和构建的自动校验链路

写一个能够阻止错误配置的校验器

下面用 Python 构造两组配置数据,并完成四类核心检查。示例不依赖第三方库,可以直接运行。将代码保存为 validate_config.py:

python
items = [
    {"itemId": 1001, "name": "Potion", "price": 50},
    {"itemId": 1002, "name": "Elixir", "price": 120},
]

shop_entries = [
    {"shopId": 1, "itemId": 1001},
    {"shopId": 1, "itemId": 1002},
]


def validate_items(rows):
    required = {"itemId", "name", "price"}
    item_ids = set()

    for index, row in enumerate(rows):
        missing = required - row.keys()
        if missing:
            raise ValueError(f"items[{index}] missing fields: {sorted(missing)}")

        if not isinstance(row["itemId"], int) or not isinstance(row["price"], int):
            raise TypeError(f"items[{index}] itemId and price must be integers")

        if row["price"] < 0:
            raise ValueError(f"items[{index}] price must be >= 0")

        if row["itemId"] in item_ids:
            raise ValueError(f"duplicate itemId: {row['itemId']}")
        item_ids.add(row["itemId"])

    return item_ids


def validate_shop(rows, item_ids):
    for index, row in enumerate(rows):
        if not isinstance(row.get("itemId"), int):
            raise TypeError(f"shop_entries[{index}].itemId must be an integer")

        if row["itemId"] not in item_ids:
            raise ValueError(
                f"shop_entries[{index}] references missing itemId: {row['itemId']}"
            )


item_ids = validate_items(items)
validate_shop(shop_entries, item_ids)
print(f"validation passed: {len(items)} items, {len(shop_entries)} shop entries")

运行校验器:

bash
python validate_config.py

预期输出:

text
validation passed: 2 items, 2 shop entries

如果把商店中的某个 itemId 改成主表不存在的值,程序会抛出异常并以非零状态结束。提交钩子或 CI 只需要检查进程退出状态,就能阻止错误继续进入后续阶段。

本地检查和 CI 要复用同一套规则

只在开发者机器上检查并不可靠,因为钩子可能没有安装,也可能被跳过。只在 CI 检查又太慢,开发者往往要等提交、推送之后才看到错误。更实用的做法是两层都执行同一个校验入口。

项目可以提供一个简单的检查脚本,供本地和 CI 共同调用。例如:

bash
python validate_config.py

预期结果是进程退出码为 0,并输出:

text
validation passed: 2 items, 2 shop entries

本地提交阶段调用它,可以快速阻止明显错误;CI 在构建开始前再次调用,则负责最终兜底。不要分别维护两套校验逻辑,否则规则很容易逐渐不一致。

失败信息必须能够直接定位数据

自动校验的价值不仅是“报错”,还要让修改者知道去哪一行修。错误信息至少应该包含配置名称、记录位置或业务主键、字段名和失败原因。例如 shop_entries[3] references missing itemId: 2001 就比单纯的 validation failed 有用得多。

当结构、类型、范围和引用规则都集中到同一个可执行校验入口后,配置修改就从“靠测试人员发现”变成了“提交前即可验证”。随后无论接 Git 提交钩子、CI 构建还是发布流水线,都只是在不同阶段重复执行同一套规则。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

提交配置前怎样自动校验

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通