SuperAPI AI 工具集

principle-migrate-callers-then-delete-legacy-apis

编程与开发

查看项目

更新于 10-16 08:21

技能介绍

用途

这条原则用于指导内部 API 的演进方式。当团队已经决定某个新 API 是更合理的设计时,它主张在同一轮重构中完成调用方迁移并删除旧 API,而不是为了兼容仍然存在的内部调用方而保留旧路径。

主要能力

原则给出了几条明确规则:

  • 不要仅仅因为内部调用方仍然存在,就保留旧 API 路径。
  • 盘点调用方,迁移它们,然后立即删除旧 API。
  • 将临时适配器视为例外,并为其设定时限,而不是把它当作默认架构。
  • 更新测试以断言新契约,并删除那些只保护重构前实现细节的测试。

使用方式

在引入新内部 API 且旧调用方仍然存在时应用该原则。具体做法是先清点所有调用方,逐一迁移到新 API,随后删除旧 API,并同步调整测试,使其验证新契约而非旧实现细节。若确实需要临时适配器,应明确其存在期限。

适用场景

该原则在以下条件下适用:

  • 没有外部用户依赖向后兼容。
  • 项目能够承受协调一致的破坏性变更。
  • 新 API 属于简化或重构计划的一部分。

限制

资料未提供该原则的具体实现代码、工具支持、安装命令或平台信息。其核心论点是:同时保留新旧 API 会带来双路径复杂性、拖慢清理进度,并使代码库呈现只增不减的状态。