契约测试工程：OpenAPI接口性能调优与故障排查 - 第4节

4.1 Pact框架概述与核心概念

Pact是一个基于“消费者驱动契约”的测试框架，它允许服务消费者（Consumer）定义其对提供者（Provider）API的期望，并将这些期望作为“契约”文件共享给提供者。提供者端通过验证这些契约，确保自身变更不会破坏消费者的预期。Pact-JVM是Pact在JVM生态中的官方实现，支持Java、Kotlin、Scala等语言。

4.1.1 Provider与Consumer概念

4.1.2 Pact测试交互流程

下图展示了Pact框架中Consumer与Provider之间的完整交互流程，从契约生成到验证闭环。

4.2 Pact-JVM安装与配置

Pact-JVM通过Maven或Gradle集成到项目中，无需独立安装服务端。以下以Maven项目为例，展示核心依赖配置。

4.2.1 Maven依赖配置

在pom.xml中添加以下依赖：

<!-- Pact Consumer 端依赖 -->
<dependency>
    <groupId>au.com.dius.pact.consumer</groupId>
    <artifactId>junit5</artifactId>
    <version>4.6.6</version>
    <scope>test</scope>
</dependency>

<!-- Pact Provider 端依赖 -->
<dependency>
    <groupId>au.com.dius.pact.provider</groupId>
    <artifactId>junit5</artifactId>
    <version>4.6.6</version>
    <scope>test</scope>
</dependency>

4.2.2 Gradle依赖配置

// Pact Consumer 端依赖
testImplementation('au.com.dius.pact.consumer:junit5:4.6.6')

// Pact Provider 端依赖
testImplementation('au.com.dius.pact.provider:junit5:4.6.6')

4.2.3 配置Pact Broker（可选）

Pact Broker用于集中存储和管理契约文件，支持团队协作。配置方式如下：

// application.properties 或 application.yml
pactbroker.host=your-broker-host
pactbroker.port=443
pactbroker.scheme=https
pactbroker.authentication.scheme=basic
pactbroker.authentication.username=your-username
pactbroker.authentication.password=your-password

4.3 第一个Pact测试用例

我们将构建一个简单的用户查询场景：Consumer服务通过GET请求获取用户信息，Provider服务返回JSON格式的用户数据。下面分别展示Consumer端和Provider端的测试代码。

4.3.1 Consumer端测试：定义契约

Consumer端使用@PactTestFor注解定义期望的交互，并生成契约文件。

import au.com.dius.pact.consumer.dsl.PactDslJsonBody;
import au.com.dius.pact.consumer.dsl.PactDslWithProvider;
import au.com.dius.pact.consumer.junit5.PactConsumerTestExt;
import au.com.dius.pact.consumer.junit5.PactTestFor;
import au.com.dius.pact.core.model.RequestResponsePact;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import java.util.HashMap;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertEquals;

@ExtendWith(PactConsumerTestExt.class)
@PactTestFor(providerName = "UserProvider", port = "8080")
public class UserServiceConsumerTest {

    @Pact(consumer = "UserServiceConsumer")
    public RequestResponsePact createPact(PactDslWithProvider builder) {
        Map<String, String> headers = new HashMap<>();
        headers.put("Content-Type", "application/json");

        PactDslJsonBody responseBody = new PactDslJsonBody()
                .integerType("id", 1001)
                .stringType("name", "张三")
                .stringType("email", "zhangsan@example.com");

        return builder
                .given("用户ID 1001 存在")
                .uponReceiving("获取用户信息请求")
                    .path("/api/users/1001")
                    .method("GET")
                .willRespondWith()
                    .status(200)
                    .headers(headers)
                    .body(responseBody)
                .toPact();
    }

    @Test
    @PactTestFor(pactMethod = "createPact")
    public void testGetUser() {
        // 模拟HTTP请求，验证Consumer能否正确解析响应
        UserServiceClient client = new UserServiceClient("http://localhost:8080");
        User user = client.getUser(1001);
        assertEquals(1001, user.getId());
        assertEquals("张三", user.getName());
    }
}

4.3.2 Provider端测试：验证契约

Provider端使用@Provider和@PactBroker注解加载契约文件，并验证自身API实现。

import au.com.dius.pact.provider.junit5.HttpTestTarget;
import au.com.dius.pact.provider.junit5.Provider;
import au.com.dius.pact.provider.junit5.State;
import au.com.dius.pact.provider.junit5.loader.PactBroker;
import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.TestTemplate;
import org.junit.jupiter.api.extension.ExtendWith;

@Provider("UserProvider")
@PactBroker(url = "http://localhost:9292")
public class UserServiceProviderTest {

    @BeforeEach
    void setUp(PactVerificationContext context) {
        context.setTarget(new HttpTestTarget("localhost", 8081, "/"));
    }

    @TestTemplate
    @ExtendWith(PactVerificationInvocationContextProvider.class)
    void pactVerificationTestTemplate(PactVerificationContext context) {
        context.verifyInteraction();
    }

    @State("用户ID 1001 存在")
    public void userExists() {
        // 准备测试数据：确保用户ID 1001在数据库中存在
        UserRepository.save(new User(1001, "张三", "zhangsan@example.com"));
    }
}

4.3.3 契约文件结构

生成的Pact契约文件为JSON格式，包含以下核心字段：

4.4 常见问题与避坑指南

• 端口冲突： Consumer端测试会启动Mock Server，确保测试端口未被占用。建议使用随机端口或专用测试端口。
• 状态管理： Provider端的@State注解必须与Consumer端given()中的描述完全一致，包括空格和标点。
• 契约版本控制： 将契约文件纳入版本管理（Git），确保Consumer和Provider使用同一版本的契约。
• 超时设置： 在CI环境中，适当增加Pact验证的超时时间，避免因网络延迟导致误报。