Skip to main content

配置与数值标准

用于统一功能配置、数值字段、版本兼容和边界处理,减少“上线后配置误解”问题。

数据结构​

  • 配置字段需具备:
    • 字段名(全量)
    • 数据类型
    • 单位
    • 默认值
    • 最小/最大边界
    • 是否可为空
  • 任何新增字段必须同步更新文档模板与消费方验证。

变更规则​

  • id 与 version 必须稳定;修改 ID 一律判定为 breaking。
  • 新增字段默认值必须对既有客户端安全(无 NaN、无除零、无非法枚举)。
  • 兼容策略不得靠“留空即无效”偷懒,必须明确 fallback 逻辑。

数值审核​

  • 业务公式与最终倍率都应显式写出。
  • 关键数值字段至少提供:
    • 公式
    • 测试用例
    • 上下限测试结果
  • 避免跨功能复用时产生隐含耦合:共享字段必须在文档中说明共享边界。

验收​

  • 配置项缺默认值、边界或单位的:blocker
  • 字段缺失版本兼容说明的:blocker
  • 有“隐式依赖”(例如依赖未命名常量)必须补齐依赖定义。