Spring Cloud Contract快速入门Demo

news2024/11/14 1:22:42

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

    @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");
    }
}

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

代码仓库

  • 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.coloradmin.cn/o/2239803.html

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

相关文章

OceanBase JDBC （Java数据库连接）的概念、分类与兼容性

OceanBase JDBC （Java数据库连接）的概念、分类与兼容性

本章将介绍 OceanBase JDBC的 概念与分类&#xff0c;已帮助使用 JDBC 的用户及技术人员更好的 了解JDBC&#xff0c;以及 OceanBase JDBC在与 MySQL 及 Oracle 兼容性方面的相关能力。 一、JDBC 基础 1.1 JDBC 的概念 JDBC 一般指 Java 数据库连接。Java 数据库连接&#xf…
阅读更多...
自定义springCloudLoadbalancer简述

自定义springCloudLoadbalancer简述

概述 目前后端用的基本都是springCloud体系&#xff1b; 平时在dev环境开发时&#xff0c;会把自己的本地服务也注册上去&#xff0c;但是这样的话&#xff0c;在客户端调用时请求可能会打到自己本地&#xff0c;对客户端测试不太友好. 思路大致就是前端在请求头传入指定ip&a…
阅读更多...
Go/Golang语言各种数据类型内存字节占用大小和最小值最大值

Go/Golang语言各种数据类型内存字节占用大小和最小值最大值

具体请前往&#xff1a;Go/golang语言基本数据类型字节大小和取值范围(最小值~最大值)
阅读更多...
力扣104 ： 二叉树最大深度

力扣104 ： 二叉树最大深度

补&#xff1a;二叉树的最大深度 描述&#xff1a; 给定一个二叉树 root &#xff0c;返回其最大深度。二叉树的 最大深度 是指从根节点到最远叶子节点的最长路径上的节点数。 何解&#xff1f; 树一般常用递归&#xff1a;递到叶子节点开始倒着处理
阅读更多...
Android GPU纹理数据拷贝

Android GPU纹理数据拷贝

在 Android 开发中读取纹理数据有以下几种方法&#xff1a; glReadPixelsImageReaderPBO&#xff08;Pixel BufferObject&#xff09; HardwareBuffer 1. glReadPixels glReadPixels 是 OpenGL ES 的 API&#xff0c;通常用于从帧缓冲区中读取像素数据&#xff0c;OpenGL ES…
阅读更多...
畅捷通T+ RecoverPassword.aspx

畅捷通T+ RecoverPassword.aspx

用友 畅捷通T RecoverPassword.aspx 存在未授权管理员密码修改漏洞&#xff0c;攻击者可以通过漏洞修改管理员账号密码登录后台 #漏洞影响版本 12.0&#xff0c;12.1.12.2.12.3 13.0 15.0 16.0 18.0 补丁号291都影响 19.0 补丁号167之前也有影响 对于老版本畅捷通已经…
阅读更多...
最全最简单理解迭代器

最全最简单理解迭代器

1. 迭代器的基础概念（iterator） 1.1 本质 迭代器能够用来遍历容器的对象，与能够遍历数组的指针类似，是广义指针。 1.2 作用： 能够让迭代器与算法不干扰的相互发展，最后又能无间隙的粘合起来。重载了*，++，＝＝，！＝，＝运算符。用以操作复杂的数据结构。容器提供迭代…
阅读更多...
python数据写入excel文件

python数据写入excel文件

主要思路&#xff1a;数据 转DataFrame后写入excel文件 一、数据格式为字典形式1 k e &#xff0c; v [‘1’, ‘e’, 0.83, 437, 0.6, 0.8, 0.9, ‘好’] 1、这种方法使用了 from_dict 方法&#xff0c;指定了 orient‘index’ 表示使用字典的键作为行索引&#xff0c;然…
阅读更多...
[CKS] Create/Read/Mount a Secret in K8S

[CKS] Create/Read/Mount a Secret in K8S

最近准备花一周的时间准备CKS考试&#xff0c;在准备考试中发现有一个题目关于读取、创建以及挂载secret的题目。 ​ 专栏其他文章: [CKS] Create/Read/Mount a Secret in K8S-CSDN博客[CKS] Audit Log Policy-CSDN博客 -[CKS] 利用falco进行容器日志捕捉和安全监控-CSDN博客[C…
阅读更多...
docker之容器设置开机自启（4）

docker之容器设置开机自启（4）

命令语法&#xff1a; docker update --restartalways 容器ID/容器名 选项&#xff1a; --restart参数 no 默认策略&#xff0c;在容器退出时不重启容器 on-failure 在容器非正常退出时&#xff08;退出状态非0&#xff09;&#xff0c;才会重启容器 …
阅读更多...
机器学习：决策树——ID3算法、C4.5算法、CART算法

机器学习：决策树——ID3算法、C4.5算法、CART算法

决策树是一种常用于分类和回归问题的机器学习模型。它通过一系列的“决策”来对数据进行分类或预测。在决策树中&#xff0c;每个内部节点表示一个特征的测试&#xff0c;每个分支代表特征测试的结果&#xff0c;而每个叶节点则表示分类结果或回归值。 决策树工作原理 根节点&…
阅读更多...
Angular 和 Vue2.0 对比

Angular 和 Vue2.0 对比

前言 &#xff1a;“业精于勤&#xff0c;荒于嬉&#xff1b;行成于思&#xff0c;毁于随” 很久没写博客了&#xff0c;大多记录少进一步探查。 Angular 和 Vue2.0 对比&#xff1a; 一.概念 1.1 Angular 框架&#xff1a; 是一款由谷歌开发的开源web前端框架&#xff08;核…
阅读更多...
Python酷库之旅-第三方库Pandas(208)

Python酷库之旅-第三方库Pandas(208)

目录 一、用法精讲 971、pandas.MultiIndex.set_levels方法 971-1、语法 971-2、参数 971-3、功能 971-4、返回值 971-5、说明 971-6、用法 971-6-1、数据准备 971-6-2、代码示例 971-6-3、结果输出 972、pandas.MultiIndex.from_arrays类方法 972-1、语法 972-2…
阅读更多...
[Linux]：IO多路转接之epoll

[Linux]：IO多路转接之epoll

1. IO 多路转接之epoll 1.1 epoll概述 epoll是Linux内核为处理大规模并发网络连接而设计的高效I/O多路转接技术。它基于事件驱动模型&#xff0c;通过在内核中维护一个事件表&#xff0c;能够快速响应多个文件描述符上的I/O事件&#xff0c;如可读、可写、异常等&#xff0c;…
阅读更多...
Spring Security 认证流程，长话简说

Spring Security 认证流程，长话简说

一、代码先行 1、设计模式 SpringSecurity 采用的是 责任链 的设计模式&#xff0c;是一堆过滤器链的组合&#xff0c;它有一条很长的过滤器链。 不过我们不需要去仔细了解每一个过滤器的含义和用法,只需要搞定以下几个问题即可&#xff1a;怎么登录、怎么校验账户、认证失败…
阅读更多...
API 接口进行多分支管理的方法

API 接口进行多分支管理的方法

原文链接&#xff1a;API 接口进行多分支管理的方法
阅读更多...
链表类算法【leetcode】

链表类算法【leetcode】

链表的定义 面试时&#xff0c;需要自己手写... // 单链表 struct ListNode {int val; // 节点上存储的元素ListNode *next; // 指向下一个节点的指针ListNode(int x) : val(x), next(NULL) {} // 节点的构造函数 }; 【构造函数可以省略&#xff0c;C默认生成一个构造函数…
阅读更多...
重构开发之道，Blackbox.AI为技术注入智能新动力

重构开发之道，Blackbox.AI为技术注入智能新动力

本文目录 一、引言二、Blackbox.AI实战体验2.1 基于网页界面生成前端代码进行应用开发2.2 与AI助手实现实时智能对话2.3 重塑大型文件交互方式2.4 链接Github仓库进行对话编程 三、总结 一、引言 在生产力工具加速进化的浪潮中&#xff0c;Blackbox.AI开始崭露头角&#xff0c…
阅读更多...
【STM32F1】——9轴姿态传感器JY901与IIC通信

【STM32F1】——9轴姿态传感器JY901与IIC通信

【STM32F1】——9轴姿态传感器JY901与IIC通信 一、简介 本篇主要对9轴姿态传感器JY901的调试过程进行总结，实现了以下功能。 IIC通信采集+串口收发：使用STM32F103C8T6的GPIO口模拟IIC，从JY901读取数据，并通过USART1串口发送到PC。二、JY901介绍 电压：3.3-5V量程：X/Z轴 …
阅读更多...
Linux网络——自定义协议与序列化

Linux网络——自定义协议与序列化

一、协议 协议是一种 " 约定 ". socket api 的接口 , 在读写数据时 , 都是按 " 字符串 " 的方式来发送接收的。如 果我们要传输一些 " 结构化的数据 "&#xff0c;依然可以通过协议。 其实&#xff0c;协议就是双方约定好的结构化的数据。…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023