
在前后端并行开发的过程中,接口往往是第一个被“各自想象”出来的部分。前端根据接口文档编写请求逻辑,后端按照相同的文档来生成响应,在联调的时候才发现字段名拼写错误、数据类型不匹配、必填参数缺失等问题。传统的解决方法是有一份更加详细的文档或者拉起整个环境进行端到端测试,前者依靠自觉,后者成本高、反馈慢、服务数量多时难以维持。
消费者驱动的契约测试提供了另外一种方式:由调用方来规定预期结果,被调用的服务在流水线里自己证明它符合这个标准。前端(消费者)在测试的时候用 Mock 来声明“请求某个接口会得到什么数据、什么样的格式”,测试通过后会产生一份合同文档;后端(提供者)则会在持续集成中启动真实的服务器,按照合同里的每一条请求依次执行并比较返回的结果。所有的合同文档都会被集中放在一个 Broker 里进行版本控制,还会跟踪哪些版本的合同已经通过了各个环境的验证。
落地过程一般分为四个步骤:消费者编写契约测试、生成契约、发布到Broker;提供者拉取契约进行验证;验证结果返回给合并请求;在发布之前检查兼容性,如果不通过就会被阻止部署。这个闭环的好处是把“集成时才暴露出来的不兼容”提前到了提交的时候,而且失败日志可以直接指出是哪一版哪一次修改破坏了约定。
版本兼容性的主要手段是Broker对部署状态进行核查,在发布之前要检查“待部署的提供者版本是否已经和所有的在线消费者版本都通过了验证”,这就像一道硬性的关卡一样。再加上语义化版本号以及“扩展—收缩”式的字段进化方式(即先并存新旧两个版本的字段,等所有消费者都完成迁移之后再去删除旧的字段),就可以把破坏性的改动分解成若干次安全地发布的步骤。
分层策略也很重要:契约测试要守住接口边界,不能代替业务逻辑测试、少量的端到端验收以及性能安全测试。在实践中一般是从调用次数最多、依赖程度最高的接口开始做起,先打通一条链路,然后再慢慢扩展开来;提供者验证一定要在自己的后端仓库和流水线中进行,不然修改字段的人看不到失败的情况,整个机制就会流于形式。
消费者驱动的契约测试并不是使交付过程更加复杂,而是把接口约定的验证成本分摊到了每次提交中。前后端各自进行测试,兼容性由机器来判断,问题通过日志来定位。对于多服务、多团队、独立部署的系统来说,这套机制使得并行开发从“各说各话”变成了“按合同验收”。