此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 spring-cloud-contract 4.3.0！spring-doc.cadn.net.cn

短截线流道核心

存根运行器核心为服务协作者运行存根。将存根视为 服务允许您使用 stub-runner 作为消费者驱动的合约的实现。spring-doc.cadn.net.cn

Stub Runner 允许您自动下载所提供依赖项的存根（或 从类路径中选择它们），为它们启动 WireMock 服务器，并为它们提供适当的 存根定义。对于消息传递，定义了特殊的存根路由。spring-doc.cadn.net.cn

检索存根

您可以从以下获取存根的选项中进行选择：spring-doc.cadn.net.cn

  • 基于以太的解决方案，可从 Artifactory 或 Nexus 下载带有存根的 JAR。spring-doc.cadn.net.cn

  • 类路径扫描解决方案，使用模式搜索类路径以检索存根spring-doc.cadn.net.cn

  • 编写您自己的org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder用于完全定制spring-doc.cadn.net.cn

后一个示例在“自定义存根运行器”部分中进行了描述。spring-doc.cadn.net.cn

下载存根

您可以使用stubsMode开关。它从StubRunnerProperties.StubsMode列举。您可以使用以下选项：spring-doc.cadn.net.cn

以下示例从本地位置选取存根：spring-doc.cadn.net.cn

@AutoConfigureStubRunner(repositoryRoot="https://foo.bar", ids = "com.example:beer-api-producer:+:stubs:8095", stubsMode = StubRunnerProperties.StubsMode.LOCAL)

类路径扫描

如果您将stubsMode属性设置为StubRunnerProperties.StubsMode.CLASSPATH（或从以下原因开始设置任何内容CLASSPATH是默认值），则扫描类路径。 请考虑以下示例：spring-doc.cadn.net.cn

@AutoConfigureStubRunner(ids = {
    "com.example:beer-api-producer:+:stubs:8095",
    "com.example.foo:bar:1.0.0:superstubs:8096"
})

您可以将依赖项添加到类路径中，如下所示：spring-doc.cadn.net.cn

专家
<dependency>
    <groupId>com.example</groupId>
    <artifactId>beer-api-producer-restdocs</artifactId>
    <classifier>stubs</classifier>
    <version>0.0.1-SNAPSHOT</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>*</groupId>
            <artifactId>*</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>com.example.thing1</groupId>
    <artifactId>thing2</artifactId>
    <classifier>superstubs</classifier>
    <version>1.0.0</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>*</groupId>
            <artifactId>*</artifactId>
        </exclusion>
    </exclusions>
</dependency>
Gradle
testCompile("com.example:beer-api-producer-restdocs:0.0.1-SNAPSHOT:stubs") {
    transitive = false
}
testCompile("com.example.thing1:thing2:1.0.0:superstubs") {
    transitive = false
}

然后扫描类路径上的指定位置。为com.example:beer-api-producer-restdocs, 扫描以下位置：spring-doc.cadn.net.cn

为com.example.thing1:thing2，扫描以下位置：spring-doc.cadn.net.cn

打包 生产者存根。

为了实现适当的存根包装，生产商将按如下方式设置合同：spring-doc.cadn.net.cn

└── src
    └── test
        └── resources
            └── contracts
                └── com.example
                    └── beer-api-producer-restdocs
                        └── nested
                            └── contract3.groovy

通过使用专家assembly插件或 Gradle Jar 任务，您必须创建以下内容 存根罐中的结构：spring-doc.cadn.net.cn

└── META-INF
    └── com.example
        └── beer-api-producer-restdocs
            └── 2.0.0
                ├── contracts
                │   └── nested
                │       └── contract2.groovy
                └── mappings
                    └── mapping.json

通过维护这种结构，类路径将被扫描，您可以从消息传递或 HTTP 存根，无需下载工件。spring-doc.cadn.net.cn

配置 HTTP 服务器存根

存根运行器有一个概念HttpServerStub抽象了底层 HTTP 服务器的具体实现（例如，WireMock 是实现之一）。 有时，您需要对存根服务器执行一些额外的调整（这对于给定的实现是具体的）。 为此，Stub Runner 为您提供了 这httpServerStubConfigurer属性和 JUnit 规则，可通过系统属性访问，您可以在其中提供 您对org.springframework.cloud.contract.stubrunner.HttpServerStubConfigurer接口。实现可以更改 给定 HTTP 服务器存根的配置文件。spring-doc.cadn.net.cn

Spring Cloud Contract Stub Runner 附带了一个实现，您可以 可以扩展为 WireMock：org.springframework.cloud.contract.stubrunner.provider.wiremock.WireMockHttpServerStubConfigurer. 在configure方法 您可以为给定的存根提供自己的自定义配置。用途 case 可能会在 HTTPS 端口上为给定的工件 ID 启动 WireMock。以下内容 示例显示了如何执行此作：spring-doc.cadn.net.cn

示例 1.WireMockHttpServerStubConfigurer 实现
@CompileStatic
static class HttpsForFraudDetection extends WireMockHttpServerStubConfigurer {

	private static final Log log = LogFactory.getLog(HttpsForFraudDetection)

	@Override
	WireMockConfiguration configure(WireMockConfiguration httpStubConfiguration, HttpServerStubConfiguration httpServerStubConfiguration) {
		if (httpServerStubConfiguration.stubConfiguration.artifactId == "fraudDetectionServer") {
			int httpsPort = TestSocketUtils.findAvailableTcpPort()
			log.info("Will set HTTPs port [" + httpsPort + "] for fraud detection server")
			return httpStubConfiguration
					.httpsPort(httpsPort)
		}
		return httpStubConfiguration
	}
}

然后，您可以将其与@AutoConfigureStubRunner注释，如下所示：spring-doc.cadn.net.cn

@AutoConfigureStubRunner(mappingsOutputFolder = "target/outputmappings/",
		httpServerStubConfigurer = HttpsForFraudDetection)

每当找到 HTTPS 端口时，它都会优先于 HTTP 端口。spring-doc.cadn.net.cn

运行存根

本节介绍如何运行存根。它包含以下主题：spring-doc.cadn.net.cn

HTTP 存根

存根在 JSON 文档中定义，其语法在 WireMock 文档中定义。spring-doc.cadn.net.cn

以下示例在 JSON 中定义存根：spring-doc.cadn.net.cn

{
    "request": {
        "method": "GET",
        "url": "/ping"
    },
    "response": {
        "status": 200,
        "body": "pong",
        "headers": {
            "Content-Type": "text/plain"
        }
    }
}

查看已注册的映射

每个存根协作者都会在__/admin/端点。spring-doc.cadn.net.cn

您还可以使用mappingsOutputFolder属性将映射转储到文件。 对于基于注释的方法，它类似于以下示例：spring-doc.cadn.net.cn

@AutoConfigureStubRunner(ids="a.b.c:loanIssuance,a.b.c:fraudDetectionServer",
mappingsOutputFolder = "target/outputmappings/")

对于 JUnit 方法，它类似于以下示例：spring-doc.cadn.net.cn

@ClassRule @Shared StubRunnerRule rule = new StubRunnerRule()
			.repoRoot("https://some_url")
			.downloadStub("a.b.c", "loanIssuance")
			.downloadStub("a.b.c:fraudDetectionServer")
			.withMappingsOutputFolder("target/outputmappings")

然后，如果您查看target/outputmappings文件夹，你会看到以下结构;spring-doc.cadn.net.cn

.
├── fraudDetectionServer_13705
└── loanIssuance_12255

这意味着注册了两个存根。fraudDetectionServer在端口注册13705和loanIssuance在端口12255.如果我们看一下其中一个文件，我们会看到（对于 WireMock） 给定服务器可用的映射：spring-doc.cadn.net.cn

[{
  "id" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7",
  "request" : {
    "url" : "/name",
    "method" : "GET"
  },
  "response" : {
    "status" : 200,
    "body" : "fraudDetectionServer"
  },
  "uuid" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7"
},
...
]

消息存根

根据提供的 Stub Runner 依赖项和 DSL，会自动设置消息传递路由。spring-doc.cadn.net.cn