SpringOne2023解读-01-使用spring-cloud-contract与TestContainer构建可靠程序

个人创作公约：本人声明创作的所有文章皆为自己原创，如果有参考任何文章的地方，会标注出来，如果有疏漏，欢迎大家批判。如果大家发现网上有抄袭本文章的，欢迎举报，并且积极向这个 github 仓库 提交 issue，谢谢支持~
另外，本文为了避免抄袭，会在不影响阅读的情况下，在文章的随机位置放入对于抄袭和洗稿的人的“亲切”的问候。如果是正常读者看到，笔者在这里说声对不起，。如果被抄袭狗或者洗稿狗看到了，希望你能够好好反思，不要再抄袭了，谢谢。

01-使用spring-cloud-contract与TestContainer构建可靠程序

笔者了解了 spring-cloud-contract 的用法之后，尝试了下，目前感觉这个还是太不智能，不推荐使用

  • 原始视频地址：https://www.youtube.com/watch?v=9Mc9Yonj9gs&list=PLgGXSWYM2FpPrAdQor9pi__EV1O69Qbom&index=6
  • 个人翻译地址：https://www.bilibili.com/video/BV1nU421Z7h8/
  • 个人总结代码与介绍地址：https://github.com/HashZhang/SpringOne-2023/tree/main/01-%E4%BD%BF%E7%94%A8spring-cloud-contracts%E4%B8%8ETestContainer%E6%9E%84%E5%BB%BA%E5%8F%AF%E9%9D%A0%E7%A8%8B%E5%BA%8F

我们在协作微服务的时候，可能是不同的人写的，不同的团队写的，不同的语言写的，不同的框架写的。通信方式也千奇百怪，可以通过 http 调用，grpc 调用，或者通过消息队列 kafka 这种异步方式通信。但是，核心其实就是我们之间达成某种约定，约定好数据的格式。这样，我们就需要一种方式，来保证我们的微服务之间的协作即数据格式是可靠的。

这时候，我们就需要使用 spring-cloud-contract 来实现这个功能。spring-cloud-contract 是一个测试框架，它可以帮助我们在开发微服务的时候，通过契约测试来保证微服务之间的协作是可靠的。它的核心思想是，通过契约来定义微服务之间的通信，然后通过测试来保证这个契约是可靠的。

spring-cloud-contract 包含三大块内容：

  • 契约定义：定义微服务之间的通信契约
  • 契约生成：生成契约测试代码
  • 契约测试：通过契约测试来保证微服务之间的通信是可靠的

spring-cloud-contract 使用

主要步骤是：

  1. 编写基类，用于定义测试需要的环境（比如需要 TestContainer 初始化哪些镜像进行使用）
  2. 编写上游信息的代码，来触发契约生成，这个一般需要配合 spring-cloud-contract-samples（ https://github.com/spring-cloud-samples/spring-cloud-contract-samples ），复制里面的代码模拟你的环境
  3. 编写契约定义
  4. 进行契约测试，自动生成契约测试代码

这里以他们的示例，演示下上面的步骤，他们的代码主要是一个咖啡服务，咖啡师通过 kafka 接收订单信息，然后制作咖啡，然后通过 kafka 发送制作好的咖啡信息，或者如果订单中的咖啡没有，就发送错误消息到 kafka。

首先编写测试基类，通过 TestContainer 初始化 kafka 镜像：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = {BaristaApplication.class, BaseTestClass.TestConfig.class})
@Testcontainers
@AutoConfigureMessageVerifier
@ActiveProfiles("contracts")
public abstract class BaseTestClass {@AutowiredKafkaHandler kafkaHandler;@Container@ServiceConnectionstatic KafkaContainer kafka = new KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka"));
}

然后，参考 spring-cloud-contract-samples（ https://github.com/spring-cloud-samples/spring-cloud-contract-samples ），复制其中的 MessageVerifierReceiver 代码，并且配置我们自己的超时时间：

    static class KafkaMessageVerifier implements MessageVerifierReceiver<Message<?>> {private static final Log LOG = LogFactory.getLog(KafkaMessageVerifier.class);Map<String, BlockingQueue<Message<?>>> broker = new ConcurrentHashMap<>();@Overridepublic Message receive(String destination, long timeout, TimeUnit timeUnit, @Nullable YamlContract contract) {broker.putIfAbsent(destination, new ArrayBlockingQueue<>(1));BlockingQueue<Message<?>> messageQueue = broker.get(destination);Message<?> message;try {message = messageQueue.poll(timeout, timeUnit);} catch (InterruptedException e) {throw new RuntimeException(e);}if (message != null) {LOG.info("Removed a message from a topic [" + destination + "]");LOG.info(message.getPayload().toString());}return message;}@KafkaListener(id = "baristaContractTestListener", topics = {"errors", "servings"})public void listen(ConsumerRecord payload, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic) {LOG.info("Got a message from a topic [" + topic + "]");Map<String, Object> headers = new HashMap<>();new DefaultKafkaHeaderMapper().toHeaders(payload.headers(), headers);broker.putIfAbsent(topic, new ArrayBlockingQueue<>(1));BlockingQueue<Message<?>> messageQueue = broker.get(topic);messageQueue.add(MessageBuilder.createMessage(payload.value(), new MessageHeaders(headers)));}@Overridepublic Message receive(String destination, YamlContract contract) {return receive(destination, 15, TimeUnit.SECONDS, contract);}}

然后，编写契约定义（可以用 groovy，也可以用 yaml，不推荐用 java）：

package contractsimport org.springframework.cloud.contract.spec.Contract/*** @author Olga Maciaszek-Sharma*/Contract.make {label("serving")input {triggeredBy("triggerServing()")}outputMessage {sentTo("servings")body([beverages:[[uuid  : $(anyUuid()),coffee: [name         : "V60",coffeeContent: "500",device       : "V60"]],[uuid  : $(anyUuid()),coffee: [name              : "Latte",coffeeContent     : "60",steamedMilkContent: "180",milkFoamContent   : "5"]]]])headers {messagingContentType(applicationJson())header 'testKey1', 'testValue1'}}}

这里的契约定义，就是定义了一个触发条件，然后定义了输出的消息内容（可以用很多方便的方法，例如 anyUuid()，anyInteger()，anyString() 等等）。触发条件是 triggerServing()，我们需要编写这个触发条件的代码，然后，spring-cloud-contract 会自动生成契约测试代码：

public void triggerServing() {Order order = new Order();order.add(new OrderEntry("latte", 1));order.add(new OrderEntry("v60", 2));//kafka 发送 order 消息kafkaHandler.process(order);
}

之后，运行 mvn clean test，spring-cloud-contract 会自动生成契约测试代码并运行测试，生成的测试代码在 target/generated-test-sources/contracts 目录下，样子是：

    @Testpublic void validate_shouldSendServing() throws Exception {// when:triggerServing();// then:ContractVerifierMessage response = contractVerifierMessaging.receive("servings",contract(this, "shouldSendServing.yml"));assertThat(response).isNotNull();// and:assertThat(response.getHeader("contentType")).isNotNull();assertThat(response.getHeader("contentType").toString()).isEqualTo("application/json");assertThat(response.getHeader("testKey1")).isNotNull();assertThat(response.getHeader("testKey1").toString()).isEqualTo("testValue1");// and:DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.getPayload()));assertThatJson(parsedJson).array("['beverages']").contains("['uuid']").matches("[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['name']").isEqualTo("V60");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['coffeeContent']").isEqualTo("500");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['device']").isEqualTo("V60");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['name']").isEqualTo("Latte");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['coffeeContent']").isEqualTo("60");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['steamedMilkContent']").isEqualTo("180");assertThatJson(parsedJson).array("['beverages']").field("['coffee']").field("['milkFoamContent']").isEqualTo("5");}

通过 mvn clean deploy，我们可以将契约测试代码部署到我们的 CI/CD 环境中，这样，其他人就可以使用我们的契约测试代码来保证他们的微服务是可靠的。

笔者为何不推荐使用

但是，笔者不推荐使用 spring-cloud-contract 的原因：

  1. spring-cloud-contract 需要配合 spring-cloud-contract-samples（ https://github.com/spring-cloud-samples/spring-cloud-contract-samples ） 这个项目使用，根据自己的场景需要复制对应的代码去模拟对应的场景。
  2. 需要手动编写 contracts 约定，同时，如果 contracts 更新，需要手动更新对应的测试代码（即每次都要 mvn clean 重新生成）。
  3. 同时，测试代码的可读性大大降低，学习成本很高。

虽然 spring-cloud-contract 有很多的优点，但是笔者认为，它的缺点更多，还需要很长的路要走。可以保持关注。

Spring Boot 与 TestContainer 的集成改进

可以参考这篇文章：https://spring.io/blog/2023/06/23/improved-testcontainers-support-in-spring-boot-3-1
详细的有关 TestContainer 的介绍可以参考我的系列文章：深入理解并应用TestContainer系列

其实就是我们在开发过程中，可能也需要用到 TestContainer 来本地启动我们的项目，但是把 TestContainer 加入非 test 的依赖（例如maven 的 dependency 的 scope 为 test，这样打包的时候不会打进去需要这个依赖），可能会导致我们的项目打包臃肿。 所以，spring-boot 3.1 提供了一个新的特性，我们可以在单元测试中添加一个新的 Main 类。

@SpringBootApplication
public class LocalTestMain {public static void main(String[] args) {SpringApplication.from(Main::main).with(TestContainerConfig.class).run(args);}@TestConfiguration(proxyBeanMethods = false)static class TestContainerConfig {@Bean@ServiceConnectionpublic MySQLContainer<?> mysqlContainer() {return new MySQLContainer<>("mysql");}}
}

这里是使用了一个新的方法 SpringApplication.from， MyApplication 是你原来的 Spring Boot 应用入口类，这里的意思是从原来的入口类启动。有了这个方法，我们可以在启动的时候加入一个包含 MySQLContainer 的 TestContainer 配置的类。

其实，这里的 @ServiceConnection 是一个自定义的注解，就是起到了之前下面这段代码的作用（@Container自动在合适的时候调用 start 方法启动容器，并且在测试结束时关闭容器，@DynamicPropertySource 在容器启动后，将容器的属性塞入 spring 对应属性来兼容测试）：

@Container
static MySQLContainer mySQLContainer = new MySQLContainer("mysql");@DynamicPropertySource
static void setProperties(DynamicPropertyRegistry registry) {registry.add("spring.datasource.url", mySQLContainer::getJdbcUrl);registry.add("spring.datasource.username", mySQLContainer::getUsername);registry.add("spring.datasource.password", mySQLContainer::getPassword);
}

目前，这个特性支持的 TestContainer 的容器类型有限，参考：https://spring.io/blog/2023/06/23/improved-testcontainers-support-in-spring-boot-3-1 ，其实也很好理解，因为要自动填充 spring 的属性，必须是 spring 封装了客户端的容器，所以目前支持的容器有：

  • CassandraContainer
  • CouchbaseContainer
  • ElasticsearchContainer
  • GenericContainer（使用的镜像是：redis 或者 openzipkin/zipkin）
  • JdbcDatabaseContainer
  • KafkaContainer
  • MongoDBContainer
  • MariaDBContainer
  • MSSQLServerContainer
  • MySQLContainer
  • Neo4jContainer
  • OracleContainer
  • PostgreSQLContainer
  • RabbitMQContainer
  • RedpandaContainer

微信搜索“hashcon”关注公众号，加作者微信：
image
我会经常发一些很好的各种框架的官方社区的新闻视频资料并加上个人翻译字幕到如下地址（也包括上面的公众号），欢迎关注：

  • 知乎：https://www.zhihu.com/people/zhxhash
  • B 站：https://space.bilibili.com/31359187

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

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

相关文章

如何在vue中使用拖动排序组件sortablejs

如何在vue中使用拖动排序组件sortablejs

效果图&#xff1a; 1.首先&#xff0c;我们需要在vue项目中安装依赖&#xff1a; npm install -save sortablejs2.创建demo文件>demoTest.vue&#xff0c;直接附上实例代码&#xff1a; <template><div><div id"table-names"><div class&…
阅读更多...
如何使用CLZero对HTTP1.1的请求走私攻击向量进行模糊测试

如何使用CLZero对HTTP1.1的请求走私攻击向量进行模糊测试

关于CLZero CLZero是一款功能强大的模糊测试工具&#xff0c;该工具可以帮助广大研究人员针对HTTP/1.1 CL.0的请求走私攻击向量进行模糊测试。 工具结构 clzero.py - 工具主脚本&#xff1b; default.py - 包含了大多数标准攻击测试方法和字符&#xff1b; exhaustive.py - 包…
阅读更多...
山西电力市场日前价格预测【2024-02-08】

山西电力市场日前价格预测【2024-02-08】

日前价格预测 预测说明&#xff1a; 如上图所示&#xff0c;预测明日&#xff08;2024-02-08&#xff09;山西电力市场全天平均日前电价为200.58元/MWh。其中&#xff0c;最高日前电价为347.58元/MWh&#xff0c;预计出现在07:00。最低日前电价为0.00元/MWh&#xff0c;预计出…
阅读更多...
Redhat7.9/Centos7.9配置双网卡bonding

Redhat7.9/Centos7.9配置双网卡bonding

一、网卡bonding及其7种模式简介&#xff1a; 1、网卡bonding&#xff1a; 一台服务器如果只有一块网卡&#xff0c;当这块网卡故障时&#xff0c;服务器网络就会瘫痪。bonding&#xff08;绑定&#xff09;是一种Linux系统下的网卡绑定技术&#xff0c;是Linux系统内核层面实…
阅读更多...
蓝桥杯第八届省赛题笔记------基于单片机的电子钟程序设计与调试

蓝桥杯第八届省赛题笔记------基于单片机的电子钟程序设计与调试

题目要求&#xff1a; 一、基本要求 1.1 使用 CT107D 单片机竞赛板&#xff0c;完成“电子钟”功能的程序设计与调试&#xff1b; 1.2 设计与调试过程中&#xff0c;可参考组委会提供的“资源数据包”&#xff1b; 1.3 Keil 工程文件以准考证号命名&#xff0c;保存在…
阅读更多...
RibbonOpenFeign源码(待完善)

RibbonOpenFeign源码(待完善)

Ribbon流程图 OpenFeign流程图
阅读更多...
python3实现gitlab备份文件上传腾讯云COS

python3实现gitlab备份文件上传腾讯云COS

gitlab备份文件上传腾讯云COS 脚本说明脚本名称&#xff1a;upload.py 假设gitlab备份文件目录&#xff1a;/opt/gitlab/backups gitlab备份文件格式&#xff1a;1706922037_2024_02_06_14.2.1_gitlab_backup.tar1.脚本需和gitlab备份文件同级目录 2.根据备份文件中的日期判断…
阅读更多...
C++面向对象编程：explicit关键字

C++面向对象编程：explicit关键字

explicit关键字的作用就是防止有一个参数的类构造函数进行隐式自动转换。 所以explicit只能用于修饰只有一个参数的类构造函数,表明该构造函数是显示的, 而非隐式的, 跟它相对应的另一个关键字是implicit, 意思是隐藏的,类构造函数默认情况下即声明为implicit(隐式)。 explicit…
阅读更多...
Yii特性

Yii特性

Yii几乎拥有了当今Web 2.0应用发展的全部特性。下面是这些特性的一个简短的清单。 模型-视图-控制器&#xff08;MVC&#xff09;设计模式&#xff1a;Yii在WEB编程中采用这一成熟的技术从而可以更好的将逻辑层和表现层分开。数据库访问对象&#xff08;DAO&#xff09;和Acti…
阅读更多...
Unity学习笔记之【IK反向动力学操作】

Unity学习笔记之【IK反向动力学操作】

反向动力学Inverse Kinematics 反向动力学&#xff0c;简称IK。相较于正向动力学&#xff0c;反向动力学旨在子级对父级产生的影响。 使用IK&#xff0c;可以实现根据目标位置或方向来计算并调整角色的关节&#xff08;骨骼&#xff09;链&#xff0c;以使角色的末端&#xff…
阅读更多...
一、OpenAI API介绍

一、OpenAI API介绍

Open AI API可以应用到任何的业务场景。 文本生成 创造助理 嵌入数据 语音转化 图片生成 图片输入 1. 核心概念 1.1 Text generation models OpenAI 的文本生成模型(通常被称为generative pre-trained transformers 模型简称&#xff1a;GPT),有GPT-4和G…
阅读更多...
Node.js_基础知识（全局变量）

Node.js_基础知识（全局变量）

介绍 global&#xff1a;相当于浏览器里的window对象process&#xff1a; 是nodejs用来控制和管理进程的工具 主要方法&#xff1a; cwd&#xff1a;获取当前的工作目录&#xff0c;是执行node命令时候的项目地址。补充&#xff1a;__dirname是被执行的js文件地址。chdir&…
阅读更多...
无头浏览器 Puppeteer-案例demo

无头浏览器 Puppeteer-案例demo

一、无头浏览器 Puppeteer基础介绍&#xff1a; 我们日常使用浏览器的步骤为&#xff1a; 启动浏览器、打开一个网页、进行交互。而无头浏览器指的是我们使用脚本来执行以上过程的浏览器&#xff0c;能模拟真实的浏览器使用场景。 有了无头浏览器&#xff0c;我们就能做包括但…
阅读更多...
（十六）springboot实战——spring securtity的认证流程源码解析

（十六）springboot实战——spring securtity的认证流程源码解析

前言 本节内容是关于spring security安全框架认证流程的源码分析&#xff0c;spring security的认证流程主要是在UsernamePasswordAuthenticationFilter过滤器中实现的。我们会通过源码层级的分析&#xff0c;了解清楚spring security的底层是如何实现用户的认证的。 正文 1…
阅读更多...
MySQL数据库练习【二】

MySQL数据库练习【二】

MySQL数据库练习【二】 一、MySQL基本语法二、建库建表-数据准备三、MySQL经典50题-题目四、MySQL经典50题-答案4.1、查询"01"课程比"02"课程成绩高的学生的信息及课程分数4.2、查询"01"课程比"02"课程成绩低的学生的信息及课程分数4.…
阅读更多...
云计算运维1

云计算运维1

1、企业服务器LNMP环境搭建 集群&#xff1a;多台服务器在一起作同样的事 。分布式 &#xff1a;多台服务器在一起作不同的事 。 环境准备&#xff1a; 1、设置静态ip&#xff08;NAT模式网关为.2&#xff09; # cat /etc/sysconfig/network-scripts/ifcfg-ens33 TYPE"E…
阅读更多...
【多模态大模型】Latent Diffusion：在潜在空间而非像素空间进行操作，从而减少了计算复杂度

【多模态大模型】Latent Diffusion：在潜在空间而非像素空间进行操作，从而减少了计算复杂度

Latent Diffusion Stable Diffusion 和 Latent Diffusion扩散模型的成本问题子问题1: 高计算成本和训练复杂度子问题2: 保持生成图像的视觉保真度子问题3: 实现多模态和高分辨率图像合成子问题4: 保持图像质量与细节Latent Diffusion 过程&#xff1a; 总结子问题/子解法1&…
阅读更多...
关于php匿名函数中的use

关于php匿名函数中的use

匿名函数中的use&#xff0c;其作用就是从父作用域继承变量。 下例是最常见的用法&#xff0c;如果不使用use&#xff0c;函数中将找不到变量$msg。 <?php $msg [1,2,3]; $func function()use($msg){print_r($msg); }; $func(); ?>运行输出 Array ([0] > 1[1] …
阅读更多...
识别CMS指纹与WAF识别

识别CMS指纹与WAF识别

目录 识别CMS指纹 1 什么是CMS指纹&#xff1f; 2 常见的CMS指纹 3 识别CMS指纹的方法有哪些&#xff1f; &#xff08;1&#xff09;分析HTTP响应头&#xff0c;识别CMS的特定标头。 &#xff08;2&#xff09;通过配置文件/特殊文件 &#xff08;3&#xff09;分析网站…
阅读更多...
SSM框架，Spring-ioc的学习（上）

SSM框架，Spring-ioc的学习（上）

知识点引入 关于框架 框架( Framework )是一个集成了基本结构、规范、设计模式、编程语言和程序库等基础组件的软件系统&#xff0c;它可以用来构建更高级别的应用程序。框架的设计和实现旨在解决特定领域中的常见问题&#xff0c;帮助开发人员更高效、更稳定地实现软件开发目…
阅读更多...
最新文章

Copyright @ 2022~2023