@RequestMapping版本控制和自定版本控制的区别以及实现

2024-03-06 02:38

本文主要是介绍@RequestMapping版本控制和自定版本控制的区别以及实现,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

对比:

1.版本统一:

a.@RequestMapping当前版本是1,有两个接口AB,此时迭代到版本2,新增接口C,这时还有存在1版本的两个接口,因为是通过URI来调用,所以这样做不到版本统一

b.而根据spring配置来自定义版本控制,则会统一成一个版本,比如当前版本是1,有AB两个接口,此时迭代到2,新增C接口,但是在调用时是版本2,而后台会根据当前版本2去找小于等于当前版本的最高版本,也就是说会调用1版本的AB,和2版本的C,这样方便版本统一

2.版本管理:

a.迭代几个版本后,还会有之前多个版本的接口,这时调用则需要传入不同的版本号,这样不方便去管理

b.而自定义版本控制,只需要记住当前版本即可,因为后台则会根据当前版本去找小于等于当前版本的接口,这样方便管理

 

 

一、新建spring boot项目

1.新建一个springboot项目,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"><modelVersion>4.0.0</modelVersion><groupId>com.lich</groupId><artifactId>springboot.example</artifactId><version>0.0.1-SNAPSHOT</version><packaging>jar</packaging><name>springboot_version</name><description>Demo project for Spring Boot</description><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.0.4.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version></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></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build>
</project>

2.application.yml配置文件如下:

server:context-path: /apiport: 8023

 

二、实现自定义版本控制的代码

1、自定义版本控制的注解

/**
* 自定义版本号
* @author lich
*
*/
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ApiVersion {/*** 标识版本号* @return*/int value();
}

2、自定义url匹配逻辑

/**
* 版本控制
* @author lich
*
*/
public class ApiVersionCondition implements RequestCondition<ApiVersionCondition>{//路径中的版本前缀,这里用/v[1-9]/的形式private final static Pattern VERSION_PREFIX_PATTERN = Pattern.compile("v(\\d+)/");//api版本号private int apiVersion;public ApiVersionCondition(int apiVersion) {this.apiVersion = apiVersion;}/*** 将不同的筛选条件进行合并*/@Overridepublic ApiVersionCondition combine(ApiVersionCondition other) {// 采用最后定义优先原则,则方法上的定义覆盖类上面的定义return new ApiVersionCondition(other.getApiVersion());}/*** 版本比对,用于排序*/@Overridepublic int compareTo(ApiVersionCondition other, HttpServletRequest request) {//优先匹配最新版本号return other.getApiVersion() - this.apiVersion;}/*** 根据request的url进行查找匹配的筛选条件*/@Overridepublic ApiVersionCondition getMatchingCondition(HttpServletRequest request) {Matcher matcher = VERSION_PREFIX_PATTERN.matcher(request.getRequestURI());if(matcher.find()){Integer version = Integer.valueOf(matcher.group(1));if(version >= this.apiVersion){return this;}}return null;}public int getApiVersion() {return apiVersion;}}

 

3、自定义匹配的处理器


/**
* 自定义匹配处理器
* @author lich
*/
public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping{@Overrideprotected RequestCondition<?> getCustomTypeCondition(Class<?> handlerType) {ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion.class);return createCondition(apiVersion);}@Overrideprotected RequestCondition<?> getCustomMethodCondition(Method method) {ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion.class);return createCondition(apiVersion);}private RequestCondition<ApiVersionCondition> createCondition(ApiVersion apiVersion) {return apiVersion == null ? null : new ApiVersionCondition(apiVersion.value());}}

4、自定义WebMvcConfigurationSupport

  核心代码如下:

/**
* 注解配置类
* @author lich
*
*/
@SpringBootConfiguration
public class WebConfig extends WebMvcConfigurationSupport {/*** 注册请求的版本请求方法*/@Overridepublic RequestMappingHandlerMapping requestMappingHandlerMapping() {RequestMappingHandlerMapping handlerMapping = new CustomRequestMappingHandlerMapping();handlerMapping.setOrder(0);handlerMapping.setInterceptors(getInterceptors());return handlerMapping;}}

三、编写测试的控制器

1、版本1的控制器:

/**
* 版本控制验证1
* @author lich
*
*/
@RestController
@ApiVersion(1)
@RequestMapping("/{version}/hello")
public class ApiTest1Controller {@RequestMapping("/world")@ResponseBodypublic String helloWorld(){System.out.println("版本是1的接口");return "hello,world .version is 1";}
}

 

2、版本2的控制器:

/**
* 版本控制验证2
* @author lich
*
*/
@RestController
@ApiVersion(2)
@RequestMapping("/{version}/hello")
public class ApiTest2Controller {@RequestMapping("/world")@ResponseBody//注解也可以放在方法上@ApiVersion(3)public String helloWorld3(){System.out.println("版本是3的接口");return "hello,world .version is 3";}@RequestMapping("/world")@ResponseBodypublic String helloWorld(){System.out.println("版本是2的接口");return "hello,world .version is 2";}}

 

四、测试demo

 

1、测试版本1,:

测试url:http://localhost:8023/api/v1/hello/world

测试结果:

2、测试版本2,:

测试url:http://localhost:8023/api/v2/hello/world

测试结果:

3、测试版本3,:

测试url:http://localhost:8023/api/v3/hello/world

测试结果:

 

GitHub代码:https://github.com/yslyjbls/springboot.example.apiversion

 

这篇关于@RequestMapping版本控制和自定版本控制的区别以及实现的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/778615

相关文章

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

golang版本升级如何实现

《golang版本升级如何实现》:本文主要介绍golang版本升级如何实现问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录golanwww.chinasem.cng版本升级linux上golang版本升级删除golang旧版本安装golang最新版本总结gola

Go语言中make和new的区别及说明

《Go语言中make和new的区别及说明》:本文主要介绍Go语言中make和new的区别及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1 概述2 new 函数2.1 功能2.2 语法2.3 初始化案例3 make 函数3.1 功能3.2 语法3.3 初始化

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具

Mysql实现范围分区表(新增、删除、重组、查看)

《Mysql实现范围分区表(新增、删除、重组、查看)》MySQL分区表的四种类型(范围、哈希、列表、键值),主要介绍了范围分区的创建、查询、添加、删除及重组织操作,具有一定的参考价值,感兴趣的可以了解... 目录一、mysql分区表分类二、范围分区(Range Partitioning1、新建分区表:2、分

MySQL 定时新增分区的实现示例

《MySQL定时新增分区的实现示例》本文主要介绍了通过存储过程和定时任务实现MySQL分区的自动创建,解决大数据量下手动维护的繁琐问题,具有一定的参考价值,感兴趣的可以了解一下... mysql创建好分区之后,有时候会需要自动创建分区。比如,一些表数据量非常大,有些数据是热点数据,按照日期分区MululbU

MySQL中查找重复值的实现

《MySQL中查找重复值的实现》查找重复值是一项常见需求,比如在数据清理、数据分析、数据质量检查等场景下,我们常常需要找出表中某列或多列的重复值,具有一定的参考价值,感兴趣的可以了解一下... 目录技术背景实现步骤方法一:使用GROUP BY和HAVING子句方法二:仅返回重复值方法三:返回完整记录方法四:

IDEA中新建/切换Git分支的实现步骤

《IDEA中新建/切换Git分支的实现步骤》本文主要介绍了IDEA中新建/切换Git分支的实现步骤,通过菜单创建新分支并选择是否切换,创建后在Git详情或右键Checkout中切换分支,感兴趣的可以了... 前提:项目已被Git托管1、点击上方栏Git->NewBrancjsh...2、输入新的分支的