Spring Cloud Contract快速入门Demo

1.什么是Spring Cloud Contract ？

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

典型使用场景

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

优势

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

2.代码工程

contract

实验目的

学习Spring Cloud Contract开发流程

provider

pom.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

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

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

契约文件

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

consumer

pom.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

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

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

测试类

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 {@Autowiredprivate UserClient userClient;@Testpublic 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");}
}

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

代码仓库

  • https://github.com/Harries/springcloud-demo(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
    • 消费者在集成测试中引入存根，模拟服务提供者的行为。
    • 存根帮助消费者独立测试，而无需真实调用提供者服务。
  • 服务交付
    • 提供者发布服务到生产环境。
    • 消费者基于已验证的契约安全地升级并与提供者交互。

4.引用

  • Spring Cloud Contract
  • Spring Cloud Contract快速入门Demo | Harries Blog™

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.rhkb.cn/news/470509.html

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

GISBox VS ArcGIS：分别适用于大型和小型项目的两款GIS软件

GISBox VS ArcGIS：分别适用于大型和小型项目的两款GIS软件

在现代地理信息系统&#xff08;GIS&#xff09;领域&#xff0c;有许多大家耳熟能详的GIS软件。它们各自具有独特的优势&#xff0c;适用于不同的行业需求和使用场景。在众多企业和开发者面前&#xff0c;如何选择合适的 GIS 软件成为了一个值得深入思考的问题。今天&#xff…
阅读更多...
Linux 进程线程间通信总结

Linux 进程线程间通信总结

线程 线程共享存储空间主要带来的问题是数据同步和互斥。由于线程在同一进程中运行&#xff0c;它们共享相同的内存空间&#xff0c;任何线程都可以访问共享数据。这样&#xff0c;多个线程并发执行时&#xff0c;可能会导致以下两种主要问题&#xff1a; 互斥问题&#xff0…
阅读更多...
【再谈设计模式】抽象工厂模式~对象创建的统筹者

【再谈设计模式】抽象工厂模式~对象创建的统筹者

一、引言 在软件开发的世界里&#xff0c;高效、灵活且易于维护的代码结构是每个开发者追求的目标。设计模式就像是建筑蓝图中的经典方案&#xff0c;为我们提供了应对各种常见问题的有效策略。其中&#xff0c;抽象工厂模式在对象创建方面扮演着重要的角色&#xff0c;它如同一…
阅读更多...
Web安全之SQL注入---基础

Web安全之SQL注入---基础

文章目录 SQL注入简介SQL注入基础SQL注入分类SQL注入流程 SQL注入简介 什么是SQL注入&#xff1f; SQL注入即是指web应用程序对用户输入数据的合法性没有判断或过滤不严&#xff0c;攻击者可以在web应用程序中事先定义好的查询语句的结尾上添加额外的SQL语句&#xff0c;在管理…
阅读更多...
机器学习——贝叶斯

机器学习——贝叶斯

&#x1f33a;历史文章列表&#x1f33a; 机器学习——损失函数、代价函数、KL散度机器学习——特征工程、正则化、强化学习机器学习——常见算法汇总机器学习——感知机、MLP、SVM机器学习——KNN机器学习——贝叶斯机器学习——决策树机器学习——随机森林、Bagging、Boostin…
阅读更多...
gdb编译教程（支持linux下X86和ARM架构）

gdb编译教程（支持linux下X86和ARM架构）

1、下载源码 http://ftp.gnu.org/gnu/gdb/ 我下载的8.2版本。 2、下载完后拷贝到linux的x86系统。 3、解压&#xff0c;然后进入到目录下&#xff0c;打开当前目录的命令行窗口。 4、创建一个生成目录。 5、我们先开始x86版本&#xff0c;这个比较简单&#xff0c;不需要配置…
阅读更多...
10款翻译工具实践体验感受与解析！！！！！

10款翻译工具实践体验感受与解析！！！！！

在现今的数字化时代&#xff0c;翻译工具如同语言的桥梁&#xff0c;为我们打开了通向世界的大门。今天咱们不聊别的&#xff0c;就聊聊那些让我又爱不释手的翻译工具们。因为我的职业因素&#xff0c;作为一个经常需要跟各种语言打交道的“文字搬运工”&#xff0c;这些工具可…
阅读更多...
【日志】392.判断子序列

【日志】392.判断子序列

2024.11.8 【力扣刷题】 392. 判断子序列 - 力扣&#xff08;LeetCode&#xff09;https://leetcode.cn/problems/is-subsequence/?envTypestudy-plan-v2&envIdtop-interview-150 整个题从一开始就是打算从双指针的思想往下走的。但是&#xff0c;我设置了四个变量sLeft…
阅读更多...
C++20 中最优雅的那个小特性 - Ranges

C++20 中最优雅的那个小特性 - Ranges

C20 中最优雅的那个小特性 - Ranges 大家好&#xff0c;今天我们来聊聊 C20 的一项非常重要的新特性——Ranges&#xff0c;可以让你的代码更优雅、更高效、更炫酷&#xff0c;如果你是一个对代码有所追求的小伙伴&#xff0c;那么这个特性你绝对值得拥有&#xff01; 啥是 …
阅读更多...
Python多进程间通讯（包含共享内存方式）

Python多进程间通讯（包含共享内存方式）

文章目录 1 通过非共享内存配合队列方式2 通过共享内存配合队列方式 注&#xff1a;本博文测试环境为Linux系统。 1 通过非共享内存配合队列方式 下面是一个常见的生产者与消费者的模式示例&#xff0c;这里分别启动了两个子进程&#xff0c;一个为生产者&#xff08;producer…
阅读更多...
深入理解接口测试：实用指南与最佳实践5.0（一）

深入理解接口测试：实用指南与最佳实践5.0（一）

✨博客主页&#xff1a; https://blog.csdn.net/m0_63815035?typeblog &#x1f497;《博客内容》&#xff1a;.NET、Java.测试开发、Python、Android、Go、Node、Android前端小程序等相关领域知识 &#x1f4e2;博客专栏&#xff1a; https://blog.csdn.net/m0_63815035/cat…
阅读更多...
2024.11.12_大数据的诞生以及解决的问题

2024.11.12_大数据的诞生以及解决的问题

大数据的诞生以及解决的问题 视频一&#xff1a;大数据诞生的背景原因&#xff1a;传统的数据处理架构无法满足海量的数据存储和计算需求 视频三&#xff1a;区分离线处理场景和实时处理场景视频五&#xff1a;传统的大数据与现代的大数据区别&#xff08;离线场景&#xff09;…
阅读更多...
ML 系列： 第 24 节 — 离散概率分布（泊松分布）

ML 系列： 第 24 节 — 离散概率分布（泊松分布）

目录 一、说明 二、固定时间间隔示例 三、固定间隔的示例 四、泊松分布的主要特征 五、示例 5.1 平均客户数的计算&#xff1a; 5.2 用于计算和绘制泊松分布的 Python 代码&#xff1a; 一、说明 泊松概率分布是一种离散概率分布&#xff0c;它表示在固定的时间或空间间隔内发生…
阅读更多...
闯关leetcode——3174. Clear Digits

闯关leetcode——3174. Clear Digits

大纲 题目地址内容 解题代码地址 题目 地址 https://leetcode.com/problems/clear-digits/description/ 内容 You are given a string s. Your task is to remove all digits by doing this operation repeatedly: Delete the first digit and the closest non-digit cha…
阅读更多...
机器情绪及抑郁症算法

机器情绪及抑郁症算法

&#x1f3e1;作者主页&#xff1a;点击&#xff01; &#x1f916;编程探索专栏&#xff1a;点击&#xff01; ⏰️创作时间&#xff1a;2024年11月12日17点02分 点击开启你的论文编程之旅https://www.aspiringcode.com/content?id17230869054974 计算机来理解你的情绪&a…
阅读更多...
【深圳大学】数据结构A+攻略（计软版）

【深圳大学】数据结构A+攻略（计软版）

1. 考试 1.1 形式 分为平时&#xff0c;笔试&#xff0c;机试三部分。其中&#xff1a; 平时占30%&#xff0c;包含平时OJ测验和课堂练习&#xff0c;注意这个可能会因老师的不同和课题组的新策略而改变。笔试占60%&#xff0c;是分值占比的主要部分。机试占10%。 1.2 题型…
阅读更多...
Chrome使用IE内核

Chrome使用IE内核

Chrome使用IE内核 1.下载扩展程序IE Tab 2.将下载好的IE Tab扩展程序拖拽到扩展程序界面&#xff0c;之后重启chrome浏览器即可
阅读更多...
使用pytest+openpyxl做接口自动化遇到的问题

使用pytest+openpyxl做接口自动化遇到的问题

最近使用pytestopenpyxl做了个接口自动化的小项目&#xff0c;遇到了一些问题。 首先&#xff0c;使用pytest这个框架&#xff0c;主要是使用了pytest.fixture, pytest.mark.parametrize这两个fixture去做参数化&#xff0c;里面注入的数据是用openpyxl来实现的。 接口介绍&a…
阅读更多...
IEC60870-5-104 协议源码架构详细分析

IEC60870-5-104 协议源码架构详细分析

IEC60870-5-104 协议源码架构 前言一、资源三、目录层级一二、目录层级二config/lib60870_config.hdependencies/READMEexamplesCMakeLists.txtcs101_master_balancedcs104_client_asyncmulti_client_servertls_clienttls_server说明 make这些文件的作用是否需要导入这些文件&a…
阅读更多...
TensorRT基础知识

TensorRT基础知识

github:https://github.com/NVIDIA/TensorRT 官网快速入门链接&#xff1a;Quick Start Guide :: NVIDIA Deep Learning TensorRT Documentation 引言&#xff1a; TensorRT 是 NVIDIA 推出的一个高性能深度学习推理库&#xff0c;专门用于优化和加速已经训练好的深度学习模型…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023