第十一节：WebApi的版本管理的几种方式

一. 背景和方案

1. 多版本管理的概念

　　Android 、IOS等 App 存在着多版本客户端共存的问题：App 最新版已经升级到了5.0 了，但是有的用户手机上还运行着 4.8、3.9 甚至2.2 版本的 App，由于早期没有内置升级机制、用户不会升级、用户拒绝升级等原因，造成这些旧版本 App 也在运行。开发新版本 App 的时候，要给接口增加新的功能或者修改以前接口的规范，会造成旧版本App 无法使用，因此在一定情况下会“保留旧接口的运行、新功能用新接口”，这样就会存在多版本接口共存的问题。

　　通常的做法是：旧版接口做一个代码分支，除了进行 bug 修改外，旧版本接口不再做改动，新接口代码继续演化升级。在客户端请求的时候带着要请求的接口版本号，在服务器端选择合适的版本代码进行处理。

2. 解决方案

(1). 不同的版本使用不同的域名：v1.api.ypf.com、v2.api.ypf.com、v3……  （最佳方案）

(2). 在Url，报文头等中带不同的版本信息，用Nginx等做反向代理服务，然后将 http://api.ypf.com/api/v1/User/1和http://api.ypf.com/api/v2/User/1 转到不同的服务器处理。

(3). 多个版本的 Controller共处在一个项目中，然 后使 用 [RoutePrefix] 特性来进行区分，这种方案Controller的名字不能一样，如下：

 

(4). 如果我想在Controller文件夹中新建多个版本文件夹，如：v1、v2、v3，每个文件夹中存放的控制器名称相同，比如都叫PersonController，不同文件夹下代表不同版本，这个时候会有一个很尴尬的问题，没法请求，识别不了，这个时候就需要重写系统默认的机制，IHttpControllerSelector 根据 “报文头”或者“请求路径”等选择不同的 Controller 执行。

（该方案的实现，详见下面的实战测试）

 

二. 实战测试

 1. 在Controller文件下新建v1和v2文件夹，分别存放不同版本的Person控制器，每个Person控制器新建一个GetName方法，如下图：

 

 2. 重写系统默认的控制器选择机制，可以直接实现IHttpControllerSelector接口，也可以继承DefaultHttpControllerSelector类，从而间接实现IHttpControllerSelector接口，在重写的SelectController方法中，实现了两种区分机制，分别是根据请求路径区分 和 根据报文头中的ApiVersion参数区分。

    /// <summary>
    /// 自己实现IHttpControllerSelector接口来替换系统默认的IHttpControllerSelector
    /// </summary>
    public class VersionConstrollerSelector : DefaultHttpControllerSelector
    {

        private HttpConfiguration _config;
        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="config"></param>
        public VersionConstrollerSelector(HttpConfiguration config) : base(config)
        {
            _config = config;
        }


        /// <summary>
        /// 获取所有的Controller
        /// </summary>
        /// <returns></returns>
        public override IDictionary<string, HttpControllerDescriptor> GetControllerMapping()
        {
            Dictionary<string, HttpControllerDescriptor> dict = new Dictionary<string, HttpControllerDescriptor>();
            //循环所有的程序集
            foreach (var asm in _config.Services.GetAssembliesResolver().GetAssemblies())
            {
                //获取所有继承ApiController的非抽象类
                var controllerTypes = asm.GetTypes().Where(t => !t.IsAbstract && typeof(ApiController).IsAssignableFrom(t)).ToArray();
                //循环上述获取的非抽象类
                foreach (var ctrlType in controllerTypes)
                {
                    //从namespace中提取版本号
                    var match = Regex.Match(ctrlType.Namespace, @"_05_WebApiExtend.Controllers.v(d+)");
                    if (match.Success)
                    {
                        //获取版本号
                        string verNum = match.Groups[1].Value;
                        //获取控制器名称（eg：PersonController中获取Person）
                        string controllerName = Regex.Match(ctrlType.Name, "(.+)Controller").Groups[1].Value;
                        //声明集合中的键(形式：Personv1 、Personv2)
                        string key = controllerName + "v" + verNum;
                        dict[key] = new HttpControllerDescriptor(_config, controllerName, ctrlType);
                    }

                }

            }
            return dict;
        }

        /// <summary>
        /// 进行Controller的匹配
        /// </summary>
        /// <param name="request"></param>
        /// <returns>匹配成功返回控制器信息，匹配失败返回null</returns>

        public override HttpControllerDescriptor SelectController(HttpRequestMessage request)
        {
            //获取所有的controller键值集合
            var controllers = GetControllerMapping();
            //获取路由数据
            var routeData = request.GetRouteData();
            //从路由中获取当前controller的名称
            var controllerName = (string)routeData.Values["controller"];

            //下面是两种方式获取版本号
            string verNum = "";
            try
            {
                //从报文头中获取版本号（当没有这个参数的时候走catch）
                verNum = request.Headers.GetValues("ApiVersion").Single();
            }
            catch (Exception)
            {
                //从url中获取版本号
                verNum = Regex.Match(request.RequestUri.PathAndQuery, @"api/v(d+)").Groups[1].Value;
            }
            //拼接key值
            string key = controllerName + "v" + verNum;
            if (controllers.ContainsKey(key))
            {
                return controllers[key];
            }
            else
            {
                return null;
            }
        }
    }

3.  在WebConfig.cs类中，加上 config.Services.Replace(typeof(IHttpControllerSelector), new VersionConstrollerSelector(config)); ，即用重写IHttpControllerSelector的替换原先的IHttpControllerSelector，如下图：

 

4.  注释掉原先的路由请求模式，新增下面两个路由规则

 public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务
            //用重写IHttpControllerSelector的替换原先的IHttpControllerSelector
            config.Services.Replace(typeof(IHttpControllerSelector), new VersionConstrollerSelector(config));
            // Web API 路由
            config.MapHttpAttributeRoutes();
            //config.Routes.MapHttpRoute(
            //    name: "DefaultApi",
            //    routeTemplate: "api/{controller}/{action}/{id}",
            //    defaults: new { id = RouteParameter.Optional }
            //);

            //多版本控制的路由改造
            config.Routes.MapHttpRoute(
              name: "DefaultApiV1",
              routeTemplate: "api/v1/{controller}/{action}/{id}",
              defaults: new { id = RouteParameter.Optional }
             );

            config.Routes.MapHttpRoute(
             name: "DefaultApiV2",
             routeTemplate: "api/v2/{controller}/{action}/{id}",
             defaults: new { id = RouteParameter.Optional }
            );
        }
    }

5. 用PostMan测试

(1). 分别请求 http://localhost:2182/api/v1/Person/GetName?Name=2   和 http://localhost:2182/api/v2/Person/GetName?Name=2， 返回不同的版本的信息，证明可以根据Url中的v1和v2进行版本区分。

(2). 请求 http://localhost:2182/api/v1/Person/GetName?Name=2 地址两次 ，表头中分别带有ApiVersion=1 和 ApiVersion=2，返回不同版本的信息，证明可以报文头中的参数进行版本区分。

 

 

!

• 作       者 : Yaopengfei(姚鹏飞)
• 博客地址 : http://www.cnblogs.com/yaopengfei/
• 声     明1 : 本人才疏学浅，用郭德纲的话说“我是一个小学生”，如有错误，欢迎讨论，请勿谩骂^_^。
• 声     明2 : 原创博客请在转载时保留原文链接或在文章开头加上本人博客地址，否则保留追究法律责任的权利。