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响应或消息的存根版本。