首页/开发/代码质量与评审速查/接口稳定性与兼容性设计
设计原则与模式62 条

接口稳定性与兼容性设计

对外接口是承诺:向后兼容优先(新增而非删除、可选参数、默认值),破坏性变更走版本与废弃周期;参考 Postel 法则(发送保守、接收宽容)设计边界输入。

兼容策略只增不删、弃用标记、新版本并行
Postel 法则接收端宽容、发送端保守
工具SemVer 语义化版本、废弃注解

兼容改造示例

兼容改造示例
// 破坏:缩小合法输入范围或改字段语义
// 兼容:新增可选字段并给默认行为
{"timeout_ms": 3000}          // 旧调用
{"timeout_ms": 3000, "retry": 2}  // 新调用,旧字段语义不变

易错点

  • 接收端宽容到吞掉错误:坏数据被悄悄接受
  • 废弃标记不设移除计划:旧接口永久并行维护

数据来源与参考

  • RFC 1122(Postel 法则出处)与语义化版本 SemVer 2.0.0 规范
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌