系统集成数据契约:字段含义比字段名重要

两个系统都有 status 字段,取值和生命周期却不同,直接映射会改变业务含义。

edyang · 2022-09-24

两个系统都有 status 字段,取值和生命周期却不同,直接映射会改变业务含义。

契约包括类型、单位、枚举、缺失、时间和身份。传输 JSON 格式一致只证明可解析,不证明业务可互操作。

系统集成数据契约:字段含义比字段名重要:处理路径与验证条件

一、问题的范围与前提

接口由请求身份、参数语义、授权条件和结果状态共同构成。HTTP 层成功只描述传输与响应,业务处理还可能处于受理、执行或等待确认阶段。将外部输入转换为内部对象以后,仍需核对类型、范围和当前状态,不能因为 JSON 能解析就直接使用。

二、技术分析与方案取舍

例如两系统 status=1 可能分别表示在线与已完成,直接映射会把通信状态变成业务状态。契约逐项说明单位、枚举、缺失与有效期,未知值返回明确错误或保留待确认。版本改变先测试新旧组合,保存原始值与转换结果用于复盘。能成功解析 JSON 只是格式成立,不表示业务含义匹配。

应用入口应有明确大小、时间和并发预算。正常和异常返回都遵循稳定结构,调用方可以据此选择等待、查询、修正或重试。涉及写入与外部动作时,为同一业务意图提供稳定身份,并在持久化边界内管理已受理结果,防止回执丢失造成重复执行。

三、实现与排查的顺序

  1. 逐项定义字段语义。
  2. 确定转换和拒绝规则。
  3. 保留原始值可追溯。
  4. 测试未知状态。

按这个顺序保留中间结果,可以区分输入条件、处理过程和最终输出。前一阶段的条件不成立时,先解释对应错误,再继续后面的试验;单次返回成功不足以覆盖整条链路。

最小示例

1
{"schema_version": 1, "event_id": "example-001", "status": "pending", "payload": {}}

JSON 只是结构示意,后续需验证枚举、类型、对象与权限。事件 ID 不包含客户身份,版本只表达协议;合法解析不能代替事实与业务校验。

四、验证和结果解释

至少关联请求到达、关键依赖调用和处理结果。日志记录标识与阶段即可,密码、Cookie、token 和原始敏感请求不应进入公共记录。排查时用同一入口比较请求与响应,再结合后端证据,避免页面统一错误文案掩盖具体原因。

需要验证的结果 保留的对照 不能由此推出的结论
缺失不变正常 固定输入与配置、对应输出 一次成功代表所有条件成功
单位转换正确 中断前后状态与错误阶段 没有报错代表结果正确
升级不会静默改变语义 恢复后的同条件复测 临时恢复代表根因已经消失

验收除了正常返回,还包括重复提交、格式错误、依赖超时与调用方取消。系统应能对未知结果查询或恢复,而不是把每个超时都当成未执行。恢复范围尽量匹配故障,防止一个依赖异常引发所有服务同时反复重启。

五、适用边界与结论

不为兼容无限接受错误,敏感字段和权限也属于接口契约。

这条路径把“逐项定义字段语义”与“测试未知状态”连在一起,中间保留可复查的条件。实施时优先确认“缺失不变正常”,再检查“升级不会静默改变语义”;两者都满足,才能在当前样本与配置范围内评价方案。设备、数据或软件版本改变以后,相关假设需要重新验证。

参考资料