Skip to content

契约测试

一句话解释

契约测试确保 API 提供者和消费者就接口达成一致——无需完整的集成测试。

用大白话说

契约测试用于微服务和 API。不运行完整集成测试(慢且脆弱),每方针对共享「契约」(定义预期请求/响应格式的 JSON 文件)进行测试。工作原理:1. 消费者编写描述对提供者期望的测试

  1. 这些期望被提取为「契约」(JSON 文件)
  2. 提供者验证它能满足契约这解耦了消费者和提供者测试:
  • 消费者测试针对遵循契约的 mock 运行
  • 提供者测试验证契约被满足
  • 无需同时运行两个服务好处:1. 快速——无需集成测试设置
  1. 独立部署——消费者和提供者可分别部署
  2. 早期检测——部署前捕获契约不匹配
  3. 文档——契约本身就是 API 文档工具:Pact(多语言)、Spring Cloud Contract(Java)。

示例

javascript
// Consumer test (JavaScript with Pact)
const pact = new PactProvider({
  consumer: 'OrderService',
  provider: 'UserService',
});

pact
  .given('user 42 exists')
  .uponReceiving('a request for user 42')
  .withRequest({ method: 'GET', path: '/users/42' })
  .willRespondWith({
    status: 200,
    headers: { 'Content-Type': 'application/json' },
    body: { id: 42, name: 'Ada' },
  });

// Provider verification (separate test)
pact.verifyProvider({
  providerBaseUrl: 'http://localhost:8080',
  pactUrls: ['./pacts/userservice-orderservice.json'],
});
// If provider changes its API, contract verification fails.

消费者定义期望 → 生成契约 → 提供者验证它能满足契约。无需集成测试。Pact 是最流行的工具。

常见混淆

  • 容易混淆的对象: integration testing

    关键区别: 集成测试同时运行两个服务并端到端测试它们的交互——慢、脆弱、需要两个服务运行。契约测试让每方独立针对共享契约测试——快、解耦、早期捕获 API 不匹配。契约测试可替代许多集成测试。

相关术语

相关资源

相关课程

解读错误信息

用大白话解释常见错误——什么意思、为什么发生、如何修复。

查看错误

← 返回术语表