對比：
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: /api
port: 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;
}
/**
* 將不同的篩選條件進行合併
*/
@Override
public ApiVersionCondition combine(ApiVersionCondition other) {
// 採用最後定義優先原則，則方法上的定義覆蓋類上面的定義
return new ApiVersionCondition(other.getApiVersion());
}
/**
* 版本比對，用於排序
*/
@Override
public int compareTo(ApiVersionCondition other, HttpServletRequest request) {
//優先匹配最新版本號
return other.getApiVersion() - this.apiVersion;
}
/**
* 根據request的url進行查找匹配的篩選條件
*/
@Override
public 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{
@Override
protected RequestCondition<?> getCustomTypeCondition(Class<?> handlerType) {
ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion.class);
return createCondition(apiVersion);
}
@Override
protected 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 {
/**
* 註冊請求的版本請求方法
*/
@Override
public 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")
@ResponseBody
public 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")
@ResponseBody
public 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