编码怎么定才稳
指标编码要可读且稳定,常见结构是「域名_业务过程_度量_限定词」,例如 PAY_ORDER_AMT_7D 表示支付域下单过程的金额在近 7 日的取值。编码一经发布不再复用,语义变化时发新编码,废弃的编码保留映射与墓碑记录。编码是接口、血缘与权限体系的锚点:下游系统、报表订阅、数据权限都挂在编码上,所以改名不改码,改语义必须换码。
基本信息
| 结构 | 域_业务过程_度量_限定词 |
|---|---|
| 书写 | 统一大写,下划线分隔 |
| 稳定性 | 发布后不改名、不复用 |
| 废弃处理 | 保留映射与墓碑记录 |
| 唯一性 | 全局唯一,避免跨域重名 |
典型使用场景
- 新建指标时按规范生成编码,评审通过后入库
- 下游接口与报表订阅用编码引用,名称调整不影响调用
- 语义变化时发布新编码,旧编码标记废弃并给出替代关系
- 血缘与影响分析以编码为主键,追溯涉及的报表与任务
- 迁移历史指标时补齐别名,保证检索能命中老名字
编码示例
编码示例
# 指标编码示例
PAY_ORDER_AMT_7D 近 7 日成功支付金额
PAY_ORDER_CNT_D 当日成功支付笔数
USR_ACTIVE_UV_MAU 月活跃用户数
REFUND_AMT_RATE_D 当日退款率
# 规则:域_过程_度量_限定,全大写、下划线分隔
# 废弃编码保留墓碑并指向替代编码要素规则
| 要素 | 规则 | 违反的后果 |
|---|---|---|
| 域名 | 业务域缩写,全局唯一 | 跨域重名导致血缘混乱 |
| 度量 | 明确计量对象 | 同码不同义,接口返回错值 |
| 限定词 | 仅使用受控修饰词 | 自由拼接产生大量近似编码 |
| 版本 | 语义变化发新码 | 沿用旧码会让下游静默错数 |
编码既给人看也给系统用:可读性优先于长度,缩写要在编码规范里统一登记,避免同一个域出现多种写法。
不要把版本号塞进编码主体:用后缀或元数据字段记录版本,编码主体保持稳定,否则下游每换一次版本都要改配置。