Spring Cloud Contract5.0.0

[[on-the-producer-side]] = 在生產者側

要開始使用 Spring Cloud Contract，您可以將以 Groovy DSL 或 YAML 表示的 REST 或訊息契約檔案新增到 contracts 目錄中，該目錄由 contractsDslDir 屬性設定。預設情況下，它是 $rootDir/src/test/resources/contracts。

然後您可以將Spring Cloud Contract Verifier依賴和外掛新增到您的構建檔案中，示例如下

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-contract-verifier</artifactId>
    <scope>test</scope>
</dependency>

以下清單展示瞭如何新增外掛，它應該放在檔案中的 build/plugins 部分

<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <version>${spring-cloud-contract.version}</version>
    <extensions>true</extensions>
</plugin>

執行./mvnw clean install會自動生成測試，以驗證應用程式是否符合新增的契約。預設情況下，測試將在org.springframework.cloud.contract.verifier.tests下生成。

由於合同描述的功能尚未實現，測試會失敗。

要使它們透過，您必須新增處理HTTP請求或訊息的正確實現。此外，您必須為自動生成的測試向專案新增一個基本測試類。所有自動生成的測試都將擴充套件此基本類，並且它應該包含執行它們所需的所有設定資訊（例如RestAssuredMockMvc控制器設定或訊息測試設定）。

下面的示例來自pom.xml，展示瞭如何指定基本測試類

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-contract-maven-plugin</artifactId>
            <version>${spring-cloud-contract.version}</version>
            <extensions>true</extensions>
            <configuration>
                <baseClassForTests>com.example.contractTest.BaseTestClass</baseClassForTests> 
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

資訊：baseClassForTests 元素允許您指定您的基本測試類。它必須是spring-cloud-contract-maven-plugin中configuration元素的一個子元素。

一旦實現和測試基類到位，測試將透過，並且應用程式和存根artifact都將被構建並安裝到本地Maven倉庫中。您現在可以合併更改，並且可以將應用程式和存根artifact釋出到線上倉庫中。

[[on-the-consumer-side]] = 在消費者側

您可以在整合測試中使用 Spring Cloud Contract Stub Runner 來獲取一個正在執行的 WireMock 例項或訊息路由，以模擬實際服務。

為此，請新增對 Spring Cloud Contract Stub Runner 的依賴，示例如下

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-contract-stub-runner</artifactId>
    <scope>test</scope>
</dependency>

您可以透過以下兩種方式將生產者端的存根安裝到您的 Maven 倉庫中

透過檢出生產者端倉庫，新增契約並執行以下命令生成存根

$ cd local-http-server-repo
$ ./mvnw clean install -DskipTests

這些測試被跳過，因為生產者端的契約實現尚未到位，因此自動生成的契約測試會失敗。

透過從遠端倉庫獲取已有的生產者服務存根。為此，請將存根artifact ID和artifact倉庫URL作為Spring Cloud Contract Stub Runner屬性傳遞，示例如下

    spring.cloud.contract.stubrunner:
      ids: 'com.example:http-server-dsl:+:stubs:8080'
      repositoryRoot: https://repo.spring.io/libs-snapshot

現在你可以用@AutoConfigureStubRunner註解你的測試類。在註解中，提供group-id和artifact-id值，讓Spring Cloud Contract Stub Runner為你執行協作方的存根，示例如下

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.NONE)
@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:stubs:6565"},
        stubsMode = StubRunnerProperties.StubsMode.LOCAL)
public class LoanApplicationServiceTests {

從線上倉庫下載存根時使用REMOTE存根模式，離線工作時使用LOCAL模式。

現在，在您的整合測試中，您可以接收由協作服務預期發出的HTTP響應或訊息的存根版本。