首页 > Java > java教程 > 正文

如何使用Pact Java在契约体中注入动态ID

心靈之曲
发布: 2025-11-11 15:07:01
原创
524人浏览过

如何使用pact java在契约体中注入动态id

本文详细介绍了在Pact Java契约测试中,如何有效地向请求体注入动态生成的ID。通过利用Pact的Provider State机制和`valueFromProviderState`方法,结合正确的占位符语法`${}`,可以在Provider端动态生成数据并在Consumer端引用,从而解决因数据清理导致ID变化的问题,确保契约测试的健壮性和准确性。

在微服务架构中,契约测试是确保服务间兼容性的关键环节。然而,当服务的请求或响应体中包含动态生成的数据(如ID)时,传统的硬编码契约可能会失效。本文将深入探讨如何利用Pact Java在Provider端动态生成ID,并在Consumer端的契约请求体中正确引用这些动态ID,以应对数据清理后ID变化的问题。

1. 理解动态ID注入的挑战

在Pact契约测试中,Provider(服务提供方)和Consumer(服务消费方)都定义了预期的交互。当某个PUT或POST API需要根据一个ID来更新资源,而这个ID在每次测试运行前可能会动态生成或因数据清理而改变时,Consumer契约中硬编码的ID将不再有效。为了解决这个问题,我们需要一种机制,让Provider在测试执行时生成实际的ID,并将其传递给Consumer契约进行匹配。

2. Provider端的状态管理与动态ID生成

Pact通过Provider State(Provider状态)机制来处理动态数据。Provider可以在测试执行前设置一个特定的状态,并在这个状态下生成或获取动态数据。

立即学习Java免费学习笔记(深入)”;

Provider类示例:

千面视频动捕
千面视频动捕

千面视频动捕是一个AI视频动捕解决方案,专注于将视频中的人体关节二维信息转化为三维模型动作。

千面视频动捕 27
查看详情 千面视频动捕
@Slf4j
@Provider("Assignments API")
@Consumer("LTI-AGS-Tool")
@VerificationReports(value = {"console", "markdown"}, reportDir = "target/pacts")
class PactProviderLTIAGSIT {

    private HashMap<String, String> headers = new HashMap<>();
    private String updateAssignmentId; // 用于存储动态生成的ID
    private final String SERVICE_TOKEN = "myToken";

    @BeforeEach
    void createTeacherAssignment() {
        // 模拟创建资源并获取其ID
        String assignmentBody = createBodyStringForStudentAssignmentSetup();
        assignmentBody = assignmentBody.replace("CPWAG", "OTHER_TEXT_RESOURCE");

        headers.put("Content-Type", "application/json");
        headers.put("Authorization", "myToken");

        RequestSpecification rq = Util.getRequestSpecification().baseUri(baseAssignmentUrl).headers(headers);
        Response response = rq.body(assignmentBody).post();
        assertEquals(201, response.getStatusCode());

        // 从响应中提取动态生成的ID
        updateAssignmentId = response.jsonPath().get("assignments[0].refId");
        log.info("assignment id is " + updateAssignmentId);
    }

    @TestTemplate
    @ExtendWith(PactVerificationInvocationContextProvider.class)
    void pactTestTemplate(PactVerificationContext context, HttpRequest request) {
        request.addHeader("Authorization", SERVICE_TOKEN);
        logCurlFromPact(context, request);
        context.verifyInteraction();
    }

    @BeforeEach
    void before(PactVerificationContext context) {
        context.setTarget(new HttpsTestTarget(BASE_PACT_TEACHER_ASSIGNMENTS_URL, 443, ""));
    }

    /**
     * 定义Provider状态,并暴露动态ID
     * 当Consumer契约声明需要"Scoring info is passed between ags-tool and assignmentapi"状态时,
     * 此方法将被调用,并返回一个包含动态ID的Map。
     */
    @State("Scoring info is passed between ags-tool and assignmentapi")
    Map<String, Object> getScoringInfo() {
        Map<String, Object> map = new HashMap<>();
        map.put("assignmentId", updateAssignmentId); // 将动态ID放入Map中
        return map;
    }
}
登录后复制

在上述Provider代码中:

  • @BeforeEach 方法 createTeacherAssignment() 负责在每次测试前创建一个新的资源,并从其响应中提取一个唯一的 assignmentId。
  • @State("Scoring info is passed between ags-tool and assignmentapi") 注解的方法 getScoringInfo() 是关键。当Consumer契约指定需要这个状态时,Pact框架会调用此方法。该方法返回一个 Map<String, Object>,其中包含了Provider在运行时生成的动态数据。这里,我们将 updateAssignmentId 放入Map中,键名为 "assignmentId"。

3. Consumer契约中引用动态ID

Consumer端需要声明它依赖于Provider的某个状态,并使用Pact DSL提供的特定方法来引用Provider状态中暴露的动态数据。

Consumer契约示例(修正后):

@ExtendWith(PactConsumerTestExt.class)
class PactConsumerSendScoreIT {

    private final Map<String, String> headers = new HashMap<>();
    private final String path = "/v5/assignmentStatus/update";

    @Pact(provider = PACT_PROVIDER, consumer = PACT_CONSUMER)
    public RequestResponsePact scoreConsumerPact(PactDslWithProvider builder) {

        headers.put("Content-Type", "application/json");

        // 构建请求体
        DslPart body = new PactDslJsonBody()
                // 关键:使用 valueFromProviderState 引用Provider状态中的动态ID
                // 第一个参数是JSON体中的键名
                // 第二个参数是Provider状态Map中的键名,需要用 ${} 包裹以进行字符串插值
                // 第三个参数是Consumer测试时的示例值(用于Consumer端Mock Server匹配)
                .valueFromProviderState("assignmentId", "${assignmentId}", "c1ef3bbf-55a2-4638-8f93-22b2916fe085")
                .stringType("timestamp", DateTime.now().plusHours(3).toString())
                .decimalType("scoreGiven", 75.00)
                .decimalType("scoreMaximum", 100.00)
                .stringType("comment", "Good work!")
                .stringType("status", "IN_PROGRESS")
                .stringType("userId", "c2ef3bbf-55a2-4638-8f93-22b2916fe085")
                .close();

        return builder
                .given("Scoring info is passed between ags-tool and assignmentapi") // 声明依赖的Provider状态
                .uponReceiving("Scoring info is passed between ags-tool and assignmentapi")
                .path(path)
                .method("POST")
                .body(body)
                .headers(headers)
                .willRespondWith()
                .status(201)
                .body(body) // 响应体也可能包含动态ID,此处为简化示例
                .toPact();
    }

    @Test
    @PactTestFor(pactMethod = "scoreConsumerPact", providerName = PACT_PROVIDER, port = "8080", pactVersion = PactSpecVersion.V3)
    void runTest(MockServer mockServer) {
        // Consumer测试时,可以继续使用示例值,因为MockServer会根据契约匹配
        // 或者在实际请求中构造动态数据(如果Consumer自身也需要动态数据)
        String updateAssignmentId = "c2ef3bbf-55a2-4638-8f93-22b2916fe085"; 

        HashMap<String, Object> map = new HashMap<>();
        map.put("timestamp", DateTime.now().plusHours(3).toString());
        map.put("scoreGiven", 75.00);
        map.put("scoreMaximum", 100.00);
        map.put("comment", "Good work!");
        map.put("status", "IN_PROGRESS");
        map.put("userId", "c2ef3bbf-55a2-4638-8f93-22b2916fe085");
        map.put("assignmentId", updateAssignmentId); // Consumer测试时使用的示例ID

        RequestSpecification rq = Util.getRequestSpecification().baseUri(mockServer.getUrl()).headers(headers);
        Response response = rq.body(map).post(path);
        assertEquals(201, response.getStatusCode());
    }
}
登录后复制

在上述Consumer代码中:

  • builder.given("Scoring info is passed between ags-tool and assignmentapi") 声明了Consumer需要Provider处于这个特定的状态。
  • PactDslJsonBody 中的 valueFromProviderState("assignmentId", "${assignmentId}", "c1ef3bbf-55a2-4638-8f93-22b2916fe085") 是实现动态ID注入的关键。
    • 第一个参数 "assignmentId" 是Consumer请求JSON体中期望的键名。
    • 第二个参数 "${assignmentId}" 是引用Provider状态中键名为 "assignmentId" 的值。注意: 当Provider状态中的值是字符串类型时,必须使用 ${} 语法进行字符串插值,Pact框架才能正确识别并替换为Provider实际生成的值。
    • 第三个参数 "c1ef3bbf-55a2-4638-8f93-22b2916fe085" 是一个示例值,仅在Consumer端运行其单元测试(即针对Mock Server)时使用。在Provider验证阶段,Pact会使用Provider实际生成的值来替换 ${assignmentId}。

4. 核心原理与注意事项

  1. Provider State的匹配: Consumer契约中的 given() 方法声明了一个Provider State。当Pact运行Provider验证时,它会查找Provider类中带有 @State 注解且名称匹配的方法,并执行该方法以获取动态数据。
  2. valueFromProviderState 方法: 这是Pact DSL中专门用于从Provider State中获取值的机制。它允许Consumer契约声明某个字段的值应该来自Provider State。
  3. ${} 语法的重要性: 对于字符串类型的动态值,使用 "${keyName}" 这样的占位符语法至关重要。Pact框架会解析这个表达式,并在Provider验证时将其替换为 getScoringInfo() 方法返回Map中 keyName 对应的值。如果缺少 ${},Pact可能只会将其视为一个字面字符串 "assignmentId" 而不是一个引用。
  4. Consumer端示例值: valueFromProviderState 的第三个参数提供了一个示例值。这个值主要用于Consumer端运行其针对Mock Server的单元测试。在Consumer测试时,Mock Server会根据契约定义(包括这个示例值)来匹配请求。
  5. 类型匹配: 确保Provider State中返回的数据类型与Consumer契约中期望的类型相匹配。例如,如果Provider返回的是一个字符串ID,Consumer契约中也应该期望一个字符串。

总结

通过Pact的Provider State机制和 valueFromProviderState 方法,我们可以优雅地解决在契约测试中动态ID的注入问题。关键在于Provider端正确地通过 @State 方法暴露动态数据,并在Consumer契约中使用 valueFromProviderState 结合 ${} 占位符语法来引用这些数据。这种方法不仅保证了契约测试的准确性,也极大地提升了测试的灵活性和健壮性,尤其适用于那些依赖于动态生成数据的API。

以上就是如何使用Pact Java在契约体中注入动态ID的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号