附录

附录 A:常用应用属性

您可以在 application.properties 文件、application.yml 文件中或作为命令行开关指定各种属性。本附录列出了常见的 Spring Cloud Contract 属性,并提供了引用它们的底层类。spring-doc.cadn.net.cn

属性贡献可能来自类路径(classpath)中的额外 JAR 文件,因此你不应将此视为详尽无遗的列表。 此外,你也可以定义自己的属性。

A.1. 默认应用属性

姓名 默认 描述

stubrunner.amqp.enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

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

stubrunner.amqp.mockCOnnectionspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.classifierspring-doc.cadn.net.cn

stubsspring-doc.cadn.net.cn

默认在 ivy 坐标中用于存根的分类器。spring-doc.cadn.net.cn

stubrunner.cloud.consul.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.cloud.delegate.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.cloud.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.cloud.eureka.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.cloud.loadbalancer.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否启用 Stub Runner 的 Spring Cloud 负载均衡集成。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

是否应为 Stub Runner 模拟服务发现。如果设置为 false,存根将注册到真实的服务发现中。spring-doc.cadn.net.cn

stubrunner.cloud.zookeeper.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否在 Zookeeper 中注册存根。spring-doc.cadn.net.cn

stubrunner.consumer-namespring-doc.cadn.net.cn

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

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

truespring-doc.cadn.net.cn

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

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

truespring-doc.cadn.net.cn

启用此标志后,stub runner 将在未找到 stubs / contracts 时抛出异常。spring-doc.cadn.net.cn

stubrunner.generate-stubsspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

启用此标志后,stub runner 将不会加载生成的存根,而是将在运行时将找到的契约转换为存根格式并运行这些存根。spring-doc.cadn.net.cn

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

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

stubrunner.idsspring-doc.cadn.net.cn

[]spring-doc.cadn.net.cn

用于以 "ivy" 格式运行的存根的标识符([groupId]:artifactId:[version]:[classifier][:port])。{@code groupId}、{@code classifier}、{@code version} 和 {@code port} 均可选。spring-doc.cadn.net.cn

stubrunner.ids-to-service-idsspring-doc.cadn.net.cn

将 Ivy 符号表示的 ID 映射到应用程序内的 serviceId。示例:"a:b" → "myService","artifactId" → "myOtherService"spring-doc.cadn.net.cn

stubrunner.integration.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.jms.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.kafka.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.kafka.initializer.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否允许 Stub Runner 代替 KafkaStubMessages 组件来轮询消息。后者仅应在生产者端使用。spring-doc.cadn.net.cn

stubrunner.mappings-output-folderspring-doc.cadn.net.cn

将每个HTTP服务器的映射导出到所选文件夹。spring-doc.cadn.net.cn

stubrunner.max-portspring-doc.cadn.net.cn

15000spring-doc.cadn.net.cn

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

stubrunner.min-portspring-doc.cadn.net.cn

10000spring-doc.cadn.net.cn

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

stubrunner.passwordspring-doc.cadn.net.cn

Repository 密码。spring-doc.cadn.net.cn

stubrunner.propertiesspring-doc.cadn.net.cn

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

stubrunner.proxy-hostspring-doc.cadn.net.cn

Repository proxy host.spring-doc.cadn.net.cn

stubrunner.proxy-portspring-doc.cadn.net.cn

仓库代理端口。spring-doc.cadn.net.cn

stubrunner.stream.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

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

stubrunner.stubs-modespring-doc.cadn.net.cn

选择存根应来自何处。spring-doc.cadn.net.cn

stubrunner.stubs-per-consumerspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

应仅将此特定消费者所需的存根注册到 HTTP 服务器存根中。spring-doc.cadn.net.cn

stubrunner.usernamespring-doc.cadn.net.cn

仓库用户名。spring-doc.cadn.net.cn

wiremock.placeholders.enabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

标志,用于指示在生成的 WireMock 模拟响应中,HTTP URL 是否应被过滤,以添加或解析动态端口的占位符。spring-doc.cadn.net.cn

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

falsespring-doc.cadn.net.cn

wiremock.rest-template-ssl-enabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

wiremock.server.filesspring-doc.cadn.net.cn

[]spring-doc.cadn.net.cn

wiremock.server.https-portspring-doc.cadn.net.cn

-1spring-doc.cadn.net.cn

wiremock.server.https-port-dynamicspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

wiremock.server.portspring-doc.cadn.net.cn

8080spring-doc.cadn.net.cn

wiremock.server.port-dynamicspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

wiremock.server.stubsspring-doc.cadn.net.cn

[]spring-doc.cadn.net.cn

A.2. 额外的application属性

下面这些属性可以作为系统属性(比如 0)传递,或者通过环境变量传递(比如 1),或者通过注释或 JUnit Rule/Extension 中的属性传递。在后一种情况下,您可以传递 2 属性名,而不是 3 的属性名。
表1. Stubrunner 属性选项
姓名 默认 描述

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

falsespring-doc.cadn.net.cn

使用 Pact Bro ker 基于 Pact Bro ker 的方法,您可以自动将组 ID 映射到提供程序名称。spring-doc.cadn.net.cn

stubrunner.properties.git.branchspring-doc.cadn.net.cn

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

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

更新项目([$project]) 的占位代码spring-doc.cadn.net.cn

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

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

10spring-doc.cadn.net.cn

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

stubrunner.properties.git.usernamespring-doc.cadn.net.cn

使用基于SCM的方法时,可以传递用户名以连接到Git仓库。spring-doc.cadn.net.cn

stubrunner.properties.git.passwordspring-doc.cadn.net.cn

使用基于SCM的方法时,可以传递密码以连接到Git仓库。spring-doc.cadn.net.cn

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

1000spring-doc.cadn.net.cn

使用基于 SCM 的方法时,可以自定义在尝试将桩推送到 Git 之间的等待时间(毫秒)。spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

当使用基于SCM的方法时,可以通过将此属性设置为false,防止stubrunner向仓库URL添加.git。这可与不支持此类URL的Git仓库兼容,例如Azure DevOps。spring-doc.cadn.net.cn

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

falsespring-doc.cadn.net.cn

使用存根协议时,您可以切换此标志以通过group id / artifact id搜索合约,而不是直接从提供的文件夹获取存根。spring-doc.cadn.net.cn