springboot2.0以上搭建接口版本控制环境。

这里只介绍修改url方式,其它方式自行绕路。
springMVC已经提供了完善的映射框架,我们只需要搬过来简单修改一下,就可以达到映射效果,所以我们需要自定义一个注解,用于随机获取路径的版本号。
1,自定义注解。

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ApiVersion {
    int value()  default 1;
}

2,自定义实现类实现RequestCondition接口,该接口以正则表达式获得需要匹配的版本号。

public class ApiVersionCondition implements RequestCondition<ApiVersionCondition> {
    private static final Pattern VERSION_PREFIX_PATTERN = Pattern.compile("v(\\+b)");
    private int version;

    private int getVersion() {
        return version;
    }

    ApiVersionCondition(int version) {
        this.version = version;
    }

    @Override
    public ApiVersionCondition combine(ApiVersionCondition apiVersionCondition) {
        return new ApiVersionCondition(this.version);
    }

    @Override
    public ApiVersionCondition getMatchingCondition(HttpServletRequest httpServletRequest) {
        Matcher matcher = VERSION_PREFIX_PATTERN.matcher(httpServletRequest.getRequestURI());
        if (matcher.find()) {
            int version = Integer.parseInt(matcher.group(1));
            if (version >= this.getVersion()) {
                return this;
            }
        }
        return null;
    }

    @Override
    public int compareTo(ApiVersionCondition apiVersionCondition, HttpServletRequest httpServletRequest) {
        return apiVersionCondition.getVersion() - this.version;
    }
}

3,自定义类继承RequestMappingHandlerMapping,该类会获得注解标注的接口路径,并返回自定义的实现类。

public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {

    @Override
    protected RequestCondition<ApiVersionCondition> getCustomTypeCondition(Class<?> handlerType) {
        ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion.class);
        return this.createCondition(apiVersion);
    }

    @Override
    protected RequestCondition<ApiVersionCondition> getCustomMethodCondition(Method method) {
        ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion.class);
        return this.createCondition(apiVersion);
    }

    private RequestCondition<ApiVersionCondition> createCondition(ApiVersion apiVersion){
       return apiVersion == null ? null : new ApiVersionCondition(apiVersion.value());
    }
}

4,自定义配置类实现WebMvcRegistrations接口,将自定义的RequestMappingHandlerMapping类返回给框架内部处理。

@SpringBootConfiguration
public class WebMvcRegistrationsConfig implements WebMvcRegistrations {
    @Override
    public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
        return new CustomRequestMappingHandlerMapping();
    }
}

测试

@RestController
@RequestMapping("/find")
public class VersionController {

    @ApiVersion
    @GetMapping("/{version}/find1")
    public void find1(){
        System.out.println("1");
    }
    @ApiVersion(2)
    @GetMapping("/{version}/find1")
    public void find2(){
        System.out.println("2");
    }
}

参照链接:https://blog.csdn.net/u010782227/article/details/74905404

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值