Stub Runner Core
Stub Runner Core 執行服務協作方的存根。將存根視為服務契約，可以使 Stub Runner 作為 消費者驅動契約 的實現。
Stub Runner 允許您自動下載所提供依賴項的存根（或從類路徑中選擇），為它們啟動 WireMock 伺服器，並向它們提供適當的存根定義。對於訊息傳遞，定義了特殊的存根路由。
獲取存根
您可以從以下選項中選擇獲取存根
-
基於 Aether 的解決方案，從 Artifactory 或 Nexus 下載包含存根的 JAR 包
-
類路徑掃描解決方案，透過模式搜尋類路徑以檢索存根
-
編寫您自己的
org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder實現以進行完全自定義
後一個示例在 自定義 Stub Runner 部分中描述。
下載存根
您可以使用 stubsMode 開關控制存根的下載。它從 StubRunnerProperties.StubsMode 列舉中獲取值。您可以使用以下選項
-
StubRunnerProperties.StubsMode.CLASSPATH（預設值）：從類路徑中選擇存根 -
StubRunnerProperties.StubsMode.LOCAL：從本地儲存（例如.m2）中選擇存根 -
StubRunnerProperties.StubsMode.REMOTE：從遠端位置選擇存根
以下示例從本地位置選擇存根
@AutoConfigureStubRunner(repositoryRoot="https://foo.bar", ids = "com.example:beer-api-producer:+:stubs:8095", stubsMode = StubRunnerProperties.StubsMode.LOCAL)類路徑掃描
如果您將 stubsMode 屬性設定為 StubRunnerProperties.StubsMode.CLASSPATH（或者不設定任何值，因為 CLASSPATH 是預設值），則會掃描類路徑。請考慮以下示例
@AutoConfigureStubRunner(ids = {
"com.example:beer-api-producer:+:stubs:8095",
"com.example.foo:bar:1.0.0:superstubs:8096"
})您可以將依賴項新增到類路徑，如下所示
<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>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，將掃描以下位置
-
/META-INF/com.example/beer-api-producer-restdocs/*/.*
-
/contracts/com.example/beer-api-producer-restdocs/*/.*
-
/mappings/com.example/beer-api-producer-restdocs/*/.*
對於 com.example.thing1:thing2，將掃描以下位置
-
/META-INF/com.example.thing1/thing2/*/.*
-
/contracts/com.example.thing1/thing2/*/.*
-
/mappings/com.example.thing1/thing2/*/.*
| 打包生產者存根時，您必須明確提供組 ID 和 artifact ID。 |
為了實現適當的存根打包，生產者將按如下方式設定契約
└── src
└── test
└── resources
└── contracts
└── com.example
└── beer-api-producer-restdocs
└── nested
└── contract3.groovy透過使用 Maven assembly 外掛 或 Gradle Jar 任務，您必須在存根 jar 中建立以下結構
└── META-INF
└── com.example
└── beer-api-producer-restdocs
└── 2.0.0
├── contracts
│ └── nested
│ └── contract2.groovy
└── mappings
└── mapping.json透過維護此結構，類路徑將被掃描，您可以受益於訊息傳遞或 HTTP 存根，而無需下載 artifacts。
配置 HTTP 伺服器存根
Stub Runner 有一個 HttpServerStub 概念，它抽象了 HTTP 伺服器的底層具體實現（例如，WireMock 是其中一種實現）。有時，您需要對存根伺服器執行一些額外的調整（對於給定的實現是具體的）。為此，Stub Runner 提供了 httpServerStubConfigurer 屬性，該屬性在註解和 JUnit 規則中可用，並透過系統屬性訪問，您可以在其中提供 org.springframework.cloud.contract.stubrunner.HttpServerStubConfigurer 介面的實現。這些實現可以更改給定 HTTP 伺服器存根的配置檔案。
Spring Cloud Contract Stub Runner 附帶了一個您可以為 WireMock 擴充套件的實現：org.springframework.cloud.contract.stubrunner.provider.wiremock.WireMockHttpServerStubConfigurer。在 configure 方法中，您可以為給定的存根提供自己的自定義配置。用例可能是在 HTTPS 埠上為給定的 artifact ID 啟動 WireMock。以下示例展示瞭如何實現
@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 註解一起重複使用，如下所示
@AutoConfigureStubRunner(mappingsOutputFolder = "target/outputmappings/",
httpServerStubConfigurer = HttpsForFraudDetection)無論何時發現 HTTPS 埠，它都會優先於 HTTP 埠。
執行存根
本節描述如何執行存根。它包含以下主題
HTTP 存根
存根在 JSON 文件中定義，其語法在 WireMock 文件 中定義。
以下示例在 JSON 中定義了一個存根
{
"request": {
"method": "GET",
"url": "/ping"
},
"response": {
"status": 200,
"body": "pong",
"headers": {
"Content-Type": "text/plain"
}
}
}檢視已註冊的對映
每個存根協作方都會在 __/admin/ 端點下公開一組已定義的對映。
您還可以使用 mappingsOutputFolder 屬性將對映轉儲到檔案中。對於基於註解的方法，它類似於以下示例
@AutoConfigureStubRunner(ids="a.b.c:loanIssuance,a.b.c:fraudDetectionServer",
mappingsOutputFolder = "target/outputmappings/")對於 JUnit 方法，它類似於以下示例
@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 資料夾，您將看到以下結構；
.
├── fraudDetectionServer_13705
└── loanIssuance_12255這意味著註冊了兩個存根。fraudDetectionServer 在埠 13705 上註冊，loanIssuance 在埠 12255 上註冊。如果我們檢視其中一個檔案，我們將看到（對於 WireMock）給定伺服器可用的對映
[{
"id" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7",
"request" : {
"url" : "/name",
"method" : "GET"
},
"response" : {
"status" : 200,
"body" : "fraudDetectionServer"
},
"uuid" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7"
},
...
]
