自定义注解实现Restful接口版本管理
在我们的日常开发中,需求总是变化的。对于某个接口,随着需求的升级,也面临里面逻辑的变化。例如,对于/v1/hello,/v2/hello 两个请求,若存在相应的映射,则对应入座。否则都映射到最新的接口上。则映射到最新的接口上。此时,我们又想保持以前的接口还保留,那么我们此时需要做的事,把对接口的请求都映射到最新的接口上,而原来的接口请求还是映射原来的接口上。我在这里介绍用自定义注解的形式,在@RequestMapping()的映射原理上做文章。
1.定义版本注解
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ApiVersion {
int value();
}
2.自定义HandlerMapping
public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
@Override // ①
protected RequestCondition<ApiVesrsionCondition> getCustomTypeCondition(Class<?> handlerType) {
ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion.class);
return createCondition(apiVersion);
}
@Override //②
protected RequestCondition<ApiVesrsionCondition> getCustomMethodCondition(Method method) {
ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion.class);
return createCondition(apiVersion);
}
//③ 实例化RequestCondition
private RequestCondition<ApiVesrsionCondition> createCondition(ApiVersion apiVersion) {
return apiVersion == null ? null : new ApiVesrsionCondition(apiVersion.value());
}
}
我们知道,光定义注解是没什么用的,重要的是我们识别到注解,做相应的事。RequestMappingHandlerMapping
类是与 @RequestMapping
相关的,它定义映射的规则。即满足怎样的条件则映射到那个接口上。
①处构建类级的映射要求,AnnotationUtils.findAnnotation
根据在类上面的注解实例化一个注解类。然后构造RequestCondition
。
②处构建类级的映射要求,AnnotationUtils.findAnnotatio
n根据在方法上面的注解实例化一个注解类。然后构造RequestCondition。
AnnotationUtils.findAnnotation
是用到Spring的工具类,根据标注的注解识别注解。很方便,比通过反射的方式来找到注解要方便。
3.自定义条件匹配
public class ApiVersionCondition implements RequestCondition<ApiVersionCondition> {
// 路径中版本的前缀, 这里用 /v[1-9]/的形式
private final static Pattern VERSION_PREFIX_PATTERN = Pattern.compile("v(\\d+)/");
private int apiVersion;
public ApiVersionCondition(int apiVersion) {
this.apiVersion = apiVersion;
}
@Override
public ApiVersionCondition combine(ApiVersionCondition other) {
// 采用最后定义优先原则,则方法上的定义覆盖类上面的定义
return new ApiVersionCondition(other.getApiVersion());
}
@Override
@Nullable
public ApiVersionCondition getMatchingCondition(HttpServletRequest request) {
Matcher m = VERSION_PREFIX_PATTERN.matcher(request.getRequestURI());
if(m.find()){
int version = Integer.parseInt(m.group(1));
if(version >= this.apiVersion)
{
return this;
}
}
return null;
}
@Override
public int compareTo(ApiVersionCondition other, HttpServletRequest request) {
// 优先匹配最新的版本号
return other.getApiVersion() - this.apiVersion;
}
public int getApiVersion() {
return apiVersion;
}
}
getMatchingCondition()利用正则表达式把请求路径中的/v1/hello中的1(版本号)找出来,然后返回与大于等于1的条件类。那么@RequestMapping则路由到产生该条件类的方法下。
4.自定义条件匹配
最后则是需要将我们的 HandlerMapping 注册到 Spring MVC 容器,在这里我们借助WebMvcConfigurationSupport来手动注册,如下:
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
@Override
@Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping() {
RequestMappingHandlerMapping handlerMapping = new CustomRequestMappingHandlerMapping();
handlerMapping.setOrder(0);
handlerMapping.setInterceptors(getInterceptors());
return handlerMapping;
}
}
测试
定义几个接口,用于区分不同的版本,如下:
@ApiVersion(1)
@GetMapping("{version}/test")
public String test1(){
log.info("版本控制测试!");
return "V1测试成功";
}
@ApiVersion(2)
@GetMapping("{version}/test")
public String test2(){
log.info("版本控制测试!");
return "V2测试成功";
}
启动服务,在浏览器请求localhost:8080/v1/test
, 则test1方法执行。
标签: SpringBoot