美文网首页
SpringMVC-Api接口版本控制

SpringMVC-Api接口版本控制

作者: 洛神灬殇 | 来源:发表于2020-08-19 13:32 被阅读0次

1. 问题

​       后端服务在提供api接口时,随着业务的变化,原有的接口很有可能不能满足现有的需求。在无法修改原有接口的情况下,只能提供一个新版本的接口来开放新的业务能力。

​      区分不同版本的api接口的方式有多种,其中一种简单通用的方式是在uri中添加版本的标识。

     /api/v1/user,api/v3/user。通过v+版本号来指定不同版本的api接口。在后端服务的代码中,可以将版本号直接写入代码中,例如,user接口提供两个入口方法,url mapping分别指定为/api/v1/user和/api/v2/user.

这种方式主要有几个缺陷:

       通常为了统一控制,调用方会使用统一一个版本来调用接口。如果后端服务在升级接口的版本时,实际只需要变更其中几个接口的逻辑,其余接口只能通过添加新的mapping来完成升级。

       接口的优先匹配,当调用高版本的api接口时,理论应该访问当前最高版本的接口,例如,如果当前整体api版本为4,但是实际上/user接口的mapping配置最高版本为v2,这时使用v4或者v2调用/user接口时,都应该返回/v2/user的结果

2. 解决方式

​ 为了较好地解决上面的问题,需要从SpringMVC对uri映射到接口的逻辑做一个扩展。

2.1 SpringMVC映射请求到处理方法的过程

​     SpringMVC处理请求分发的过程中主要的几个类为:

       HandlerMapping: 定义根据请求获取处理当期请求的HandlerChain的getHandler方法,其中包括实际处理逻辑的handler对象和拦截器

       AbstractHandlerMapping: 实现HandlerMapping接口的抽象类,在getHandler方法实现了拦截器的初始化和handler对象获取,其中获取handler对象的getHandlerInternal方法为抽象方法,

        由子类实现AbstractHandlerMethodMapping<T>: 继承AbstractHandlerMapping,定义了method handler映射关系,每一个method handler都一个唯一的T关联RequestMappingInfoHandlerMapping: 继承`AbstractHandlerMethodMapping`,定义了RequestMappingInfomethod handler的关联关系

       RequestMappingInfo: 包含各种匹配规则RequestCondition,请求到method的映射规则信息都包含在这个对象中,

       RequestMappingHandlerMapping: 继承RequestMappingInfoHandlerMapping,处理方法的@RequestMapping注解,将其与method handler与@RequestMapping注解构建的RequestMappingInfo关联

2.1.1 Spring初始化RequestMappingInfo与handler的关系

       ​ Spring在初始化RequestMappingHandlerMappingBean的时候,会初始化Controller的方法与RequestMappingInfo的映射关系并缓存,方便请求过来时,查询使用

​        RequestMappingHandlerMapping实现了InitializingBean接口(父类实现),接口说明如下:

2.1.2 Spring根据mapping关系查询处理请求的方法

       在步骤2中,会将缓存中的RequestMappingInfo查询出来,并对当前HttpServletRequest做一个匹配,主要逻辑是使用RequestMappingInfo中保存的各种RequestCondition匹配当前请求,也包括自定义的RequestCondition,返回匹配结果,主要的方法为RequestMappingInfogetMatchingCondition

        将请求分发到具体的Controller方法的逻辑主要是初始化过程中注册的Mapping缓存(RequestMappingInfo)查找与匹配的过程,RequestMappingInfo中包含各种RequestCondition,包括参数、HTTP方法、媒体类型等规则的匹配,同时还包含了一个自定义的RequestCondition的扩展,如果想要增加自定义的Request匹配规则,就可以从这里入手。

2.2 自定义RequestCondition实现版本控制

       因为默认RequestMappingHandlerMapping实现只有一个空的获取自定义RequestCondition的实现,所以需要继承实现:

​ 在SpringBoot项目中增加Config,注入自定义的ApiHandlerMapping:

自定义Contoller测试:

相关文章

  • SpringMVC-Api接口版本控制

    1. 问题 ​ 后端服务在提供api接口时,随着业务的变化,原有的接口很有可能不能满足现有的需求。在无法修改原...

  • 给移动端强制更新的接口

    app版本控制表 版本实体类 写给移动端的判断版本信息的接口 service接口 接口实现类 这里AppVersi...

  • restful 接口版本控制

    做RESTful开放平台,一方面其API变动越少,对API调用者越有利;另一方面,没有人可以预测未来,系统在发展的...

  • SpringBoot 优雅控制API版本

    在实际工作中,由于接口功能做了不兼容变更,因此需要在原接口基础上增加版本控制,以示区分。 何时进行版本控制?这里引...

  • SpringMVC Api接口版本控制

    SpringMVC Api接口版本控制 1. 问题 ​ 后端服务在提供api接口时,随着业务的变化,原有的接口...

  • 通过header控制接口版本

    自定义指定接口版本注解 继承RequestCondition实现自定义 继承 RequestMappingHand...

  • 上报用户行为埋点日志

    一、上报流程 二、技术应用 支持网络请求上报的压缩机制支持接口请求的版本控制,如根据App版本控制不同版本的配置获...

  • Versioning - Django REST framewo

    版本控制-Django REST框架 versioning.py 版本化 对接口进行版本化只是一种“礼貌”的方式来...

  • 服务端接口版本控制

    开发模式 现在不管是WEB项目还是APP项目,都是分离开发,服务端提供接口,前端调用,由于业务线不断发展,业务端多...

  • Linux TCP拥塞控制接口

    本文分析所采用的Linux版本为4.18 Linux系统中的TCP拥塞控制采用面向对象的设计思想,提供拥塞控制接口...

网友评论

      本文标题:SpringMVC-Api接口版本控制

      本文链接:https://www.haomeiwen.com/subject/yaskjktx.html