Stub Runner 核心

存根运行器核心为服务协作者运行存根。将存根视为 services 允许您使用 stub-runner 作为 Consumer 驱动的 Contract 的实现。spring-doc.cn

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

检索存根

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

基于 Aether 的解决方案，可从 Artifactory 或 Nexus 下载带有存根的 JARspring-doc.cn
Classpath-scanning 解决方案，它使用模式搜索 Classpath 以检索存根spring-doc.cn
编写您自己的实现以实现完全自定义org.springframework.cloud.contract.stubrunner.StubDownloaderBuilderspring-doc.cn

后一个示例在 Custom Stub Runner 部分中介绍。spring-doc.cn

下载 Stub

您可以使用开关控制存根的下载。它从枚举中选取值。您可以使用以下选项：stubsModeStubRunnerProperties.StubsModespring-doc.cn

StubRunnerProperties.StubsMode.CLASSPATH（默认值）：从 Classpath 中选择存根spring-doc.cn
StubRunnerProperties.StubsMode.LOCAL：从本地存储中选取存根（例如.m2)spring-doc.cn
StubRunnerProperties.StubsMode.REMOTE：从远程位置选取存根spring-doc.cn

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

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

类路径扫描

如果将属性设置为（或未设置任何内容，因为是默认值），则会扫描 Classpath。请考虑以下示例：stubsModeStubRunnerProperties.StubsMode.CLASSPATHCLASSPATHspring-doc.cn

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

您可以将依赖项添加到 Classpath 中，如下所示：spring-doc.cn

Maven 系列

<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
}

然后扫描 Classpath 上的指定位置。为将扫描以下位置：com.example:beer-api-producer-restdocsspring-doc.cn

/META-INF/com.example/beer-api-producer-restdocs/*/.*spring-doc.cn
/contracts/com.example/beer-api-producer-restdocs/*/.*spring-doc.cn
/mappings/com.example/beer-api-producer-restdocs/*/.*spring-doc.cn

对于，将扫描以下位置：com.example.thing1:thing2spring-doc.cn

/META-INF/com.example.thing1/thing2/*/.*spring-doc.cn
/contracts/com.example.thing1/thing2/*/.*spring-doc.cn
/mappings/com.example.thing1/thing2/*/.*spring-doc.cn

在打包 producer stub 的

为了实现正确的存根打包，生产者将按如下方式设置 Contract：spring-doc.cn

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

通过使用 Maven 程序集插件或 Gradle Jar 任务，您必须创建以下内容结构中：spring-doc.cn

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

通过维护此结构，可以扫描 Classpath，您可以从消息传递或 HTTP 存根，而无需下载构件。spring-doc.cn

配置 HTTP 服务器存根

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

Spring Cloud Contract Stub Runner 附带一个实现，您可以可以扩展 WireMock： . 在该方法中，您可以为给定的存根提供自己的自定义配置。用途 case 可能会在 HTTPS 端口上为给定的项目 ID 启动 WireMock。以下内容示例展示了如何做到这一点：org.springframework.cloud.contract.stubrunner.provider.wiremock.WireMockHttpServerStubConfigurerconfigurespring-doc.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
	}
}

然后，您可以将其与注释一起重复使用，如下所示：@AutoConfigureStubRunnerspring-doc.cn

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

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

运行 stub

本节介绍如何执行 stub。它包含以下主题：spring-doc.cn

HTTP 存根

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

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

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

查看已注册的映射

每个存根协作者都会在终端节点下公开一个已定义映射的列表。__/admin/spring-doc.cn

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

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

对于 JUnit 方法，它类似于以下示例：spring-doc.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/outputmappingsspring-doc.cn

.
├── fraudDetectionServer_13705
└── loanIssuance_12255

这意味着注册了两个存根。已在 port 和 port 注册。如果我们查看其中一个文件，我们将看到（对于 WireMock）可用于给定服务器的映射：fraudDetectionServer13705loanIssuance12255spring-doc.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.cn