@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

相关文章

Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

《Androidkotlin中Channel和Flow的区别和选择使用场景分析》Kotlin协程中,Flow是冷数据流,按需触发,适合响应式数据处理;Channel是热数据流,持续发送,支持... 目录一、基本概念界定FlowChannel二、核心特性对比数据生产触发条件生产与消费的关系背压处理机制生命周期

c++ 类成员变量默认初始值的实现

《c++类成员变量默认初始值的实现》本文主要介绍了c++类成员变量默认初始值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录C++类成员变量初始化c++类的变量的初始化在C++中,如果使用类成员变量时未给定其初始值,那么它将被

Javaee多线程之进程和线程之间的区别和联系(最新整理)

《Javaee多线程之进程和线程之间的区别和联系(最新整理)》进程是资源分配单位,线程是调度执行单位,共享资源更高效,创建线程五种方式:继承Thread、Runnable接口、匿名类、lambda,r... 目录进程和线程进程线程进程和线程的区别创建线程的五种写法继承Thread,重写run实现Runnab

C++中NULL与nullptr的区别小结

《C++中NULL与nullptr的区别小结》本文介绍了C++编程中NULL与nullptr的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编... 目录C++98空值——NULLC++11空值——nullptr区别对比示例 C++98空值——NUL

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

在Linux中改变echo输出颜色的实现方法

《在Linux中改变echo输出颜色的实现方法》在Linux系统的命令行环境下,为了使输出信息更加清晰、突出,便于用户快速识别和区分不同类型的信息,常常需要改变echo命令的输出颜色,所以本文给大家介... 目python录在linux中改变echo输出颜色的方法技术背景实现步骤使用ANSI转义码使用tpu

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

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