自定义注解实现Restful接口版本管理

  在我们的日常开发中,需求总是变化的。对于某个接口,随着需求的升级,也面临里面逻辑的变化。例如,对于/v1/hello,/v2/hello 两个请求,若存在相应的映射,则对应入座。否则都映射到最新的接口上。则映射到最新的接口上。此时,我们又想保持以前的接口还保留,那么我们此时需要做的事,把对接口的请求都映射到最新的接口上,而原来的接口请求还是映射原来的接口上。我在这里介绍用自定义注解的形式,在@RequestMapping()的映射原理上做文章。
  1. 自定义注解
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ApiVersion {
    int value();
}

  就是定义一个简单的注解@ApiVersion,这个注解可以在类上和方法上都可以应用。

  1. 注解的识别
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.findAnnotation根据在方法上面的注解实例化一个注解类。然后构造RequestCondition。
AnnotationUtils.findAnnotation是用到Spring的工具类,根据标注的注解识别注解。很方便,比通过反射的方式来找到注解要方便。

  1. 自定义条件类
public class ApiVesrsionCondition implements RequestCondition<ApiVesrsionCondition> {
    // 路径中版本的前缀, 这里用 /v[1-9]/的形式
    private final static Pattern VERSION_PREFIX_PATTERN = Pattern.compile("v(\\d+)/");

    private int apiVersion;

    public ApiVesrsionCondition(int apiVersion){
        this.apiVersion = apiVersion;
    }
    //将不同的筛选条件合并,这里采用的覆盖,即后来的规则生效
    public ApiVesrsionCondition combine(ApiVesrsionCondition other) {
        return new ApiVesrsionCondition(other.getApiVersion());
    }
    //根据request查找匹配到的筛选条件
    public ApiVesrsionCondition getMatchingCondition(HttpServletRequest request) {
        System.out.println(request.getRequestURI());
        Matcher m = VERSION_PREFIX_PATTERN.matcher(request.getRequestURI());
        if(m.find()){
            Integer version = Integer.valueOf(m.group(1));
            if(version >= this.apiVersion) // 如果请求的版本号大于配置版本号, 则满足,即与请求的
                return this;
        }
        return null;
    }
    //实现不同条件类的比较,从而实现优先级排序
    public int compareTo(ApiVesrsionCondition other, HttpServletRequest request) {

        return other.getApiVersion() - this.apiVersion;
    }

    public int getApiVersion() {
        return apiVersion;
    }
}

  getMatchingCondition()利用正则表达式把请求路径中的/v1/hello中的1(版本号)找出来,然后返回与大于等于1的条件类。那么@RequestMapping则路由到产生该条件类的方法下。

  1. 测试
@RequestMapping("/{version}/")
@Controller
public class VersionController {
    @RequestMapping("hello")
    @ApiVersion(1)
    @ResponseBody
    public String hello(){
        System.out.println("haha1..........");

        return "hello version1";
    }

    @RequestMapping("hello")
    @ApiVersion(2)
    @ResponseBody
    public String hello2(){
        System.out.println("haha2.........");

        return "hello version2";
    }

    @RequestMapping("hello")
    @ResponseBody
    @ApiVersion(5)
    public String hello5(){
        System.out.println("haha5.........");
        return "hello version5";
    }

    @RequestMapping("test")
    @ResponseBody
    public String test(){
        return "test";
    }

}

  每个方法上都用 @ApiVersion()注解啦。当在浏览器输入http://localhost:8761/v2/hello 则跳到hello2()方法中执行。当在浏览器输入http://localhost:8761/v5/hello 则跳到hello5()中执行,因为比5大的都调到最新hello5()执行。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,743评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,296评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,285评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,485评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,581评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,821评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,960评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,719评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,186评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,516评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,650评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,329评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,936评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,757评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,991评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,370评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,527评论 2 349

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,633评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,773评论 6 342
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,780评论 25 707
  • Spring的模型-视图-控制器(MVC)框架是围绕一个DispatcherServlet来设计的,这个Servl...
    alexpdh阅读 2,641评论 0 3
  • 湖光山色瑞士游(伯尔尼、洛桑、蒙特勒) 酒店的早餐依然很简单,虽然没有国内酒店的早餐丰富,但是老公儿子早已很习惯...
    含月6666阅读 413评论 0 0