附录
附录 A:常用应用属性
您可以在 application.properties 文件、application.yml 文件中或作为命令行开关指定各种属性。本附录列出了常见的 Spring Cloud Contract 属性,并提供了引用它们的底层类。
| 属性贡献可能来自类路径(classpath)中的额外 JAR 文件,因此你不应将此视为详尽无遗的列表。 此外,你也可以定义自己的属性。 |
A.1. 默认应用属性
| 姓名 | 默认 | 描述 |
|---|---|---|
stubrunner.amqp.enabled |
|
是否启用对 Stub Runner 和 AMQP 的支持。 |
stubrunner.amqp.mockCOnnection |
|
是否启用对 Stub Runner 和 AMQP 模拟连接工厂的支持。 |
stubrunner.classifier |
|
默认在 ivy 坐标中用于存根的分类器。 |
stubrunner.cloud.consul.enabled |
|
是否在 Consul 中启用存根注册。 |
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 负载均衡集成。 |
stubrunner.cloud.stubbed.discovery.enabled |
|
是否应为 Stub Runner 模拟服务发现。如果设置为 false,存根将注册到真实的服务发现中。 |
stubrunner.cloud.zookeeper.enabled |
|
是否在 Zookeeper 中注册存根。 |
stubrunner.consumer-name |
您可以通过将此参数设置为一个值来覆盖此字段的默认 {@code spring.application.name}。 |
|
stubrunner.delete-stubs-after-test |
|
如果设置为 {@code false},则在运行测试后不会删除临时文件夹中的存根文件。 |
stubrunner.fail-on-no-stubs |
|
启用此标志后,stub runner 将在未找到 stubs / contracts 时抛出异常。 |
stubrunner.generate-stubs |
|
启用此标志后,stub runner 将不会加载生成的存根,而是将在运行时将找到的契约转换为存根格式并运行这些存根。 |
stubrunner.http-server-stub-configurer |
HTTP服务器存根的配置。 |
|
stubrunner.ids |
|
用于以 "ivy" 格式运行的存根的标识符([groupId]:artifactId:[version]:[classifier][:port])。{@code groupId}、{@code classifier}、{@code version} 和 {@code port} 均可选。 |
stubrunner.ids-to-service-ids |
将 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-port |
|
自动启动的 WireMock 服务器端口的最大值。 |
stubrunner.min-port |
|
自动启动的 WireMock 服务器端口的最小值。 |
stubrunner.password |
Repository 密码。 |
|
stubrunner.properties |
可传递给自定义 {@link org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder} 的属性映射。 |
|
stubrunner.proxy-host |
Repository proxy host. |
|
stubrunner.proxy-port |
仓库代理端口。 |
|
stubrunner.stream.enabled |
|
是否启用 Stub Runner 与 Spring Cloud Stream 的集成。 |
stubrunner.stubs-mode |
选择存根应来自何处。 |
|
stubrunner.stubs-per-consumer |
|
应仅将此特定消费者所需的存根注册到 HTTP 服务器存根中。 |
stubrunner.username |
仓库用户名。 |
|
wiremock.placeholders.enabled |
|
标志,用于指示在生成的 WireMock 模拟响应中,HTTP URL 是否应被过滤,以添加或解析动态端口的占位符。 |
wiremock.reset-mappings-after-each-test |
|
|
wiremock.rest-template-ssl-enabled |
|
|
wiremock.server.files |
|
|
wiremock.server.https-port |
|
|
wiremock.server.https-port-dynamic |
|
|
wiremock.server.port |
|
|
wiremock.server.port-dynamic |
|
|
wiremock.server.stubs |
|
A.2. 额外的application属性
| 下面这些属性可以作为系统属性(比如 0)传递,或者通过环境变量传递(比如 1),或者通过注释或 JUnit Rule/Extension 中的属性传递。在后一种情况下,您可以传递 2 属性名,而不是 3 的属性名。 |
| 姓名 | 默认 | 描述 |
|---|---|---|
stubrunner.properties.pactbroker.provider-name-with-group-id |
false |
使用 Pact Bro ker 基于 Pact Bro ker 的方法,您可以自动将组 ID 映射到提供程序名称。 |
stubrunner.properties.git.branch |
使用 SCM 基于的方法时,您可以自定义要检出的分支名称。 |
|
stubrunner.properties.git.commit-message |
更新项目([$project]) 的占位代码 |
使用基于SCM的方法时,您可以自定义创建存根的提交消息。 |
stubrunner.properties.git.no-of-attempts |
10 |
使用基于SCM的方法时,可以自定义将存根推送到Git的重试次数。 |
stubrunner.properties.git.username |
使用基于SCM的方法时,可以传递用户名以连接到Git仓库。 |
|
stubrunner.properties.git.password |
使用基于SCM的方法时,可以传递密码以连接到Git仓库。 |
|
stubrunner.properties.git.wait-between-attempts |
1000 |
使用基于 SCM 的方法时,可以自定义在尝试将桩推送到 Git 之间的等待时间(毫秒)。 |
stubrunner.properties.git.ensure-git-suffix |
true |
当使用基于SCM的方法时,可以通过将此属性设置为 |
stubrunner.properties.stubs.find-producer |
false |
使用存根协议时,您可以切换此标志以通过 |