Spring Cloud Contract快速入门Demo-优快云博客

本文链接：https://blog.youkuaiyun.com/rgrt868/article/details/143798532

1.什么是Spring Cloud Contract ？

Spring Cloud Contract 是 Spring 提供的一套工具，用于帮助开发者通过契约（Contract）驱动的方式进行微服务的测试和集成。它主要解决微服务之间通信时，如何确保服务提供者和消费者之间的接口保持一致的问题。

典型使用场景

**服务提供者测试:**开发者可以通过契约生成单元测试，验证服务提供者的接口实现是否符合契约。
**服务消费者测试:**消费者可以使用生成的存根，独立测试消费者应用，而无需依赖服务提供者的真实服务。
**API 升级:**当服务提供者需要升级接口时，可以根据现有契约验证对消费者的影响，降低 API 改动带来的风险。

优势

**减少集成问题:**契约明确了服务的行为，避免了消费者和提供者之间的接口不匹配问题。
**提高测试效率:**消费者可以使用存根独立测试，减少对真实服务环境的依赖。
**自动化:**契约驱动的测试过程自动化程度高，生成的存根和测试代码大大减轻了手工编写的负担。
**更好的文档:**契约本身可以作为接口的文档，清晰描述了服务交互的细节。

2.代码工程

实验目的

学习Spring Cloud Contract开发流程

provider

pom.xml

xml

代码解读

复制代码

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>spring-cloud-contract</artifactId> <groupId>com.et</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>provider</artifactId> <properties> <maven.compiler.source>17</maven.compiler.source> <maven.compiler.target>17</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-contract-verifier</artifactId> <version>3.1.0</version> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-contract-maven-plugin</artifactId> <version>3.1.0</version> <extensions>true</extensions> <executions> <execution> <goals> <goal>convert</goal> <goal>generateTests</goal> </goals> </execution> </executions> </plugin> </plugins> </build> </project>

controller

kotlin

代码解读

复制代码

package com.et.consumer; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RestController; @RestController public class UserController { @GetMapping("/user/{id}") public ResponseEntity<User> getUser(@PathVariable Long id) { User user = new User(1L, "John Doe", "john.doe@example.com"); return ResponseEntity.ok(user); } }

entity

kotlin

代码解读

复制代码

package com.et.consumer; import lombok.Data; @Data public class User { private Long id; private String name; private String email; public User(Long id, String name, String email) { this.id = id; this.name = name; this.email = email; } }

契约文件

less

代码解读

复制代码

import org.springframework.cloud.contract.spec.Contract Contract.make { description "should return user details" request { method 'GET' url '/user/1' } response { status 200 body([ id: 1, name: "John Doe", email: "john.doe@example.com" ]) headers { contentType(applicationJson()) } } }

consumer

pom.xml

xml

代码解读

复制代码

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>spring-cloud-contract</artifactId> <groupId>com.et</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>consumer</artifactId> <properties> <maven.compiler.source>17</maven.compiler.source> <maven.compiler.target>17</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-contract-stub-runner</artifactId> <version>3.1.0</version> <scope>test</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> </dependencies> </project>

service

kotlin

代码解读

复制代码

package com.et.consumer; import org.springframework.stereotype.Service; import org.springframework.web.client.RestTemplate; @Service public class UserClient { private final RestTemplate restTemplate; public UserClient(RestTemplate restTemplate) { this.restTemplate = restTemplate; } public UserDTO getUser(Long id) { return restTemplate.getForObject("http://localhost:8080/user/" + id, UserDTO.class); } }

dto

kotlin

代码解读

复制代码

package com.et.consumer; import lombok.Data; @Data public class UserDTO { private Long id; private String name; private String email; }

测试类

java

代码解读

复制代码

package com.et.consumer; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.contract.stubrunner.junit.StubRunnerExtension; import org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties; import org.springframework.cloud.contract.stubrunner.spring.AutoConfigureStubRunner; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest @ExtendWith(StubRunnerExtension.class) @AutoConfigureStubRunner( stubsMode = StubRunnerProperties.StubsMode.LOCAL, ids = "com.et:provider:+:stubs:8080" ) public class UserClientTest { @Autowired private UserClient userClient; @Test public void shouldReturnUser() { UserDTO user = userClient.getUser(1L); assertThat(user.getId()).isEqualTo(1L); assertThat(user.getName()).isEqualTo("John Doe"); assertThat(user.getEmail()).isEqualTo("john.doe@example.com"); } }

以上只是一些关键代码，所有代码请参见下面代码仓库

代码仓库

github.com/Harries/spr…(Spring Cloud Contract )

3.Spring Cloud Contract 标准工作流

提供者定义契约
- 服务提供者根据其 API 的行为定义契约，明确描述接口请求和响应的格式。
- 契约文档通常放在服务提供者的代码仓库中，并可以通过 CI/CD 管道共享给消费者。
验证提供者
- 提供者基于契约生成自动化测试，确保其服务实现符合契约要求。
- Spring Cloud Contract 的 Contract Verifier 会自动生成测试代码，运行时验证服务端逻辑与契约的一致性。
****提供者生成存根 mvn clear install
- 验证完成后，Spring Cloud Contract 生成服务提供者的存根（Stub）。
- 存根可以发布到私有的 Maven 或其他制品仓库，供消费者下载和使用。
消费者测试. mvn test
- 消费者在集成测试中引入存根，模拟服务提供者的行为。
- 存根帮助消费者独立测试，而无需真实调用提供者服务。
服务交付
- 提供者发布服务到生产环境。
- 消费者基于已验证的契约安全地升级并与提供者交互。