附录

附录 A:常见应用程序属性

可以在文件内、文件内或作为命令行开关指定各种属性。 本附录提供了常见的 Spring Cloud Contract 属性列表以及对使用它们的基础类的引用。application.propertiesapplication.ymlspring-doc.cn

属性贡献可能来自 Classpath 上的其他 jar 文件,因此您不应将其视为详尽的列表。 此外,您还可以定义自己的属性。

A.1. 默认应用程序属性

名字 违约 描述

stubrunner.amqp.enabledspring-doc.cn

falsespring-doc.cn

是否启用对 Stub Runner 和 AMQP 的支持。spring-doc.cn

stubrunner.amqp.mock连接spring-doc.cn

truespring-doc.cn

是否启用对 Stub Runner 和 AMQP 模拟连接工厂的支持。spring-doc.cn

stubrunner.classifier 中spring-doc.cn

stubsspring-doc.cn

默认情况下在 ivy 坐标中使用的分类器 stub.spring-doc.cn

stubrunner.cloud.consul.enabledspring-doc.cn

truespring-doc.cn

是否在 Consul 中启用 stub 注册。spring-doc.cn

stubrunner.cloud.delegate.enabledspring-doc.cn

truespring-doc.cn

是否启用 DiscoveryClient 的 Stub Runner 实现。spring-doc.cn

stubrunner.cloud.enabledspring-doc.cn

truespring-doc.cn

是否启用 Spring Cloud 对 Stub Runner 的支持。spring-doc.cn

stubrunner.cloud.eureka.enabledspring-doc.cn

truespring-doc.cn

是否在 Eureka 中启用存根注册。spring-doc.cn

stubrunner.cloud.loadbalancer.enabledspring-doc.cn

truespring-doc.cn

是否启用 Stub Runner 的 Spring Cloud Load Balancer 集成。spring-doc.cn

stubrunner.cloud.stubbed.discovery.enabledspring-doc.cn

truespring-doc.cn

是否应该为 Stub Runner 对 Service Discovery 进行存根。如果设置为 false,则 stub 将在实际服务发现中注册。spring-doc.cn

stubrunner.cloud.zookeeper.enabledspring-doc.cn

truespring-doc.cn

是否在 Zookeeper 中启用 stub 注册。spring-doc.cn

stubrunner.consumer-名称spring-doc.cn

您可以通过为此参数设置值来覆盖此字段的默认 {@code spring.application.name}。spring-doc.cn

stubrunner.delete-stubs-after-testspring-doc.cn

truespring-doc.cn

如果设置为 {@code false},则不会在运行测试后从临时文件夹中删除存根。spring-doc.cn

stubrunner.fail-on-no-stubsspring-doc.cn

truespring-doc.cn

启用后,此标志将告诉 stub runner 在未找到 stub / Contract 时抛出异常。spring-doc.cn

stubrunner.generate-存根spring-doc.cn

falsespring-doc.cn

启用后,此标志将告诉 stub runner 不要加载生成的 stubs,而是在运行时将找到的 Contract 转换为 stub 格式并运行这些 stubs。spring-doc.cn

stubrunner.http-server-stub-configurerspring-doc.cn

HTTP 服务器存根的配置。spring-doc.cn

stubrunner.ids 文件spring-doc.cn

[]spring-doc.cn

要以 “ivy” 表示法运行的存根的 ID ([groupId]:artifactId:[version]:[classifier][:p ort])。{@code groupId}、{@code classifier}、{@code version} 和 {@code port} 可以是可选的。spring-doc.cn

stubrunner.ids 到服务 IDspring-doc.cn

将基于 Ivy 表示法的 ID 映射到应用程序内的 serviceId。示例 “a:b” → “myService” “artifactId” → “myOtherService”spring-doc.cn

stubrunner.integration.enabledspring-doc.cn

truespring-doc.cn

是否启用 Stub Runner 与 Spring Integration 的集成。spring-doc.cn

stubrunner.jms.enabledspring-doc.cn

truespring-doc.cn

是否启用 Stub Runner 与 Spring JMS 的集成。spring-doc.cn

stubrunner.kafka.enabledspring-doc.cn

truespring-doc.cn

是否启用 Stub Runner 与 Spring Kafka 的集成。spring-doc.cn

stubrunner.kafka.initializer.enabledspring-doc.cn

truespring-doc.cn

是否允许 Stub Runner 负责轮询消息,而不是 KafkaStubMessages 组件。后者应仅在生产者端使用。spring-doc.cn

stubrunner.mappings-output-folderspring-doc.cn

将每个 HTTP 服务器的映射转储到所选文件夹。spring-doc.cn

stubrunner.max 端口spring-doc.cn

15000spring-doc.cn

自动启动的 WireMock 服务器的端口的最大值。spring-doc.cn

stubrunner.min-portspring-doc.cn

10000spring-doc.cn

自动启动的 WireMock 服务器的端口的最小值。spring-doc.cn

stubrunner.passwordspring-doc.cn

存储库密码。spring-doc.cn

stubrunner.propertiesspring-doc.cn

可以传递给自定义 {@link org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder} 的属性映射。spring-doc.cn

存根运行者代理主机spring-doc.cn

存储库代理主机。spring-doc.cn

stubrunner.代理端口spring-doc.cn

存储库代理端口。spring-doc.cn

stubrunner.server-idspring-doc.cn

stubrunner.stream.enabledspring-doc.cn

truespring-doc.cn

是否启用 Stub Runner 与 Spring Cloud Stream 的集成。spring-doc.cn

stubrunner.stubs 模式spring-doc.cn

选择 stub 的来源。spring-doc.cn

stubrunner.stubs-per-consumerspring-doc.cn

falsespring-doc.cn

只应将此特定使用者的存根注册到 HTTP 服务器存根中。spring-doc.cn

stubrunner.usernamespring-doc.cn

仓库用户名。spring-doc.cn

wiremock.placeholders.enabledspring-doc.cn

truespring-doc.cn

指示应过滤生成的 wiremock 存根中的 http URL 以添加或解析动态端口的占位符的标志。spring-doc.cn

wiremock.reset-mappings-after-each-testspring-doc.cn

falsespring-doc.cn

wiremock.rest-template-ssl-已启用spring-doc.cn

falsespring-doc.cn

wiremock.server.文件spring-doc.cn

[]spring-doc.cn

wiremock.server.https-portspring-doc.cn

-1spring-doc.cn

wiremock.server.https-端口动态spring-doc.cn

falsespring-doc.cn

wiremock.server.portspring-doc.cn

8080spring-doc.cn

wiremock.server.port-动态spring-doc.cn

falsespring-doc.cn

wiremock.server.stubsspring-doc.cn

[]spring-doc.cn

A.2. 其他应用程序属性

以下属性可以作为系统属性(例如)、环境变量(例如)或存根运行程序的注释或 JUnit 规则 (JUnit 4) 或扩展 (JUnit 5) 中的属性传递。在后一种情况下,您可以传递 property 而不是 .stubrunner.properties.git.branchSTUBRUNNER_PROPERTIES_GIT_BRANCHgit.branchstubrunner.properties.git.branch
表 1.Stubrunner 属性选项
名字 违约 描述

stubrunner.properties.pactbroker.provider-name-with-group-idspring-doc.cn

falsespring-doc.cn

使用基于 Pact Broker 的方法时,您可以自动将 ID 分组到提供程序名称。spring-doc.cn

stubrunner.properties.git.branchspring-doc.cn

使用基于 SCM 的方法时,您可以自定义要签出的分支名称。spring-doc.cn

stubrunner.properties.git.commit-messagespring-doc.cn

使用存根更新项目 [$project]spring-doc.cn

使用基于 SCM 的方法时,您可以自定义已创建存根的提交消息。文本将替换为项目名称。$projectspring-doc.cn

stubrunner.properties.git.no-of-attemptsspring-doc.cn

10spring-doc.cn

使用基于 SCM 的方法时,您可以自定义重试次数以将存根推送到 Git。spring-doc.cn

stubrunner.properties.git.usernamespring-doc.cn

使用基于 SCM 的方法时,您可以传递用户名以连接到 git 存储库。spring-doc.cn

stubrunner.properties.git.passwordspring-doc.cn

使用基于 SCM 的方法时,您可以传递密码以连接到 git 存储库。spring-doc.cn

stubrunner.properties.git.wait-between-attemptsspring-doc.cn

1000spring-doc.cn

使用基于 SCM 的方法时,您可以自定义尝试将存根推送到 git 之间的等待时间(以毫秒为单位)。spring-doc.cn

stubrunner.properties.git.ensure-git-suffixspring-doc.cn

truespring-doc.cn

使用基于 SCM 的方法时,您可以通过将此属性设置为 来阻止 stubrunner 添加到存储库 URL。这增加了与不支持此类 URL 的 git 存储库(例如 Azure DevOps)的兼容性。.gitfalsespring-doc.cn

stubrunner.properties.stubs.find-producerspring-doc.cn

falsespring-doc.cn

使用该协议时,您可以切换此标志以在 中搜索 contract,而不是直接从提供的文件夹中获取存根。stubsgroup id / artifact idspring-doc.cn