附录
附录 A:常见应用程序属性
可以在文件内、文件内或作为命令行开关指定各种属性。
本附录提供了常见的 Spring Cloud Contract 属性列表以及对使用它们的基础类的引用。application.properties
application.yml
属性贡献可能来自 Classpath 上的其他 jar 文件,因此您不应将其视为详尽的列表。 此外,您还可以定义自己的属性。 |
A.1. 默认应用程序属性
名字 | 违约 | 描述 |
---|---|---|
stubrunner.amqp.enabled |
|
是否启用对 Stub Runner 和 AMQP 的支持。 |
stubrunner.amqp.mock连接 |
|
是否启用对 Stub Runner 和 AMQP 模拟连接工厂的支持。 |
stubrunner.classifier 中 |
|
默认情况下在 ivy 坐标中使用的分类器 stub. |
stubrunner.cloud.consul.enabled |
|
是否在 Consul 中启用 stub 注册。 |
stubrunner.cloud.delegate.enabled |
|
是否启用 DiscoveryClient 的 Stub Runner 实现。 |
stubrunner.cloud.enabled |
|
是否启用 Spring Cloud 对 Stub Runner 的支持。 |
stubrunner.cloud.eureka.enabled |
|
是否在 Eureka 中启用存根注册。 |
stubrunner.cloud.loadbalancer.enabled |
|
是否启用 Stub Runner 的 Spring Cloud Load Balancer 集成。 |
stubrunner.cloud.stubbed.discovery.enabled |
|
是否应该为 Stub Runner 对 Service Discovery 进行存根。如果设置为 false,则 stub 将在实际服务发现中注册。 |
stubrunner.cloud.zookeeper.enabled |
|
是否在 Zookeeper 中启用 stub 注册。 |
stubrunner.consumer-名称 |
您可以通过为此参数设置值来覆盖此字段的默认 {@code spring.application.name}。 |
|
stubrunner.delete-stubs-after-test |
|
如果设置为 {@code false},则不会在运行测试后从临时文件夹中删除存根。 |
stubrunner.fail-on-no-stubs |
|
启用后,此标志将告诉 stub runner 在未找到 stub / Contract 时抛出异常。 |
stubrunner.generate-存根 |
|
启用后,此标志将告诉 stub runner 不要加载生成的 stubs,而是在运行时将找到的 Contract 转换为 stub 格式并运行这些 stubs。 |
stubrunner.http-server-stub-configurer |
HTTP 服务器存根的配置。 |
|
stubrunner.ids 文件 |
|
要以 “ivy” 表示法运行的存根的 ID ([groupId]:artifactId:[version]:[classifier][:p ort])。{@code groupId}、{@code classifier}、{@code version} 和 {@code port} 可以是可选的。 |
stubrunner.ids 到服务 ID |
将基于 Ivy 表示法的 ID 映射到应用程序内的 serviceId。示例 “a:b” → “myService” “artifactId” → “myOtherService” |
|
stubrunner.integration.enabled |
|
是否启用 Stub Runner 与 Spring Integration 的集成。 |
stubrunner.jms.enabled |
|
是否启用 Stub Runner 与 Spring JMS 的集成。 |
stubrunner.kafka.enabled |
|
是否启用 Stub Runner 与 Spring Kafka 的集成。 |
stubrunner.kafka.initializer.enabled |
|
是否允许 Stub Runner 负责轮询消息,而不是 KafkaStubMessages 组件。后者应仅在生产者端使用。 |
stubrunner.mappings-output-folder |
将每个 HTTP 服务器的映射转储到所选文件夹。 |
|
stubrunner.max 端口 |
|
自动启动的 WireMock 服务器的端口的最大值。 |
stubrunner.min-port |
|
自动启动的 WireMock 服务器的端口的最小值。 |
stubrunner.password |
存储库密码。 |
|
stubrunner.properties |
可以传递给自定义 {@link org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder} 的属性映射。 |
|
存根运行者代理主机 |
存储库代理主机。 |
|
stubrunner.代理端口 |
存储库代理端口。 |
|
stubrunner.server-id |
||
stubrunner.stream.enabled |
|
是否启用 Stub Runner 与 Spring Cloud Stream 的集成。 |
stubrunner.stubs 模式 |
选择 stub 的来源。 |
|
stubrunner.stubs-per-consumer |
|
只应将此特定使用者的存根注册到 HTTP 服务器存根中。 |
stubrunner.username |
仓库用户名。 |
|
wiremock.placeholders.enabled |
|
指示应过滤生成的 wiremock 存根中的 http URL 以添加或解析动态端口的占位符的标志。 |
wiremock.reset-mappings-after-each-test |
|
|
wiremock.rest-template-ssl-已启用 |
|
|
wiremock.server.文件 |
|
|
wiremock.server.https-port |
|
|
wiremock.server.https-端口动态 |
|
|
wiremock.server.port |
|
|
wiremock.server.port-动态 |
|
|
wiremock.server.stubs |
|
A.2. 其他应用程序属性
以下属性可以作为系统属性(例如)、环境变量(例如)或存根运行程序的注释或 JUnit 规则 (JUnit 4) 或扩展 (JUnit 5) 中的属性传递。在后一种情况下,您可以传递 property 而不是 .stubrunner.properties.git.branch STUBRUNNER_PROPERTIES_GIT_BRANCH git.branch stubrunner.properties.git.branch |
名字 | 违约 | 描述 |
---|---|---|
|
|
使用基于 Pact Broker 的方法时,您可以自动将 ID 分组到提供程序名称。 |
|
使用基于 SCM 的方法时,您可以自定义要签出的分支名称。 |
|
|
使用存根更新项目 [$project] |
使用基于 SCM 的方法时,您可以自定义已创建存根的提交消息。文本将替换为项目名称。 |
|
|
使用基于 SCM 的方法时,您可以自定义重试次数以将存根推送到 Git。 |
|
使用基于 SCM 的方法时,您可以传递用户名以连接到 git 存储库。 |
|
|
使用基于 SCM 的方法时,您可以传递密码以连接到 git 存储库。 |
|
|
|
使用基于 SCM 的方法时,您可以自定义尝试将存根推送到 git 之间的等待时间(以毫秒为单位)。 |
|
|
使用基于 SCM 的方法时,您可以通过将此属性设置为 来阻止 stubrunner 添加到存储库 URL。这增加了与不支持此类 URL 的 git 存储库(例如 Azure DevOps)的兼容性。 |
|
|
使用该协议时,您可以切换此标志以在 中搜索 contract,而不是直接从提供的文件夹中获取存根。 |