WebApi 重写 DefaultHttpControllerSelector 实现路由重定向

背景：

本项目为后台项目

近期项目组内推行前后端分离架构。前端使用vue，后端使用webapi进行重构。

因原项目为mvc，所以重构对于后台接口变化不大。

新建webapi项目，log4net引入，swagger引入，全局异常处理，实现登陆登出功能，实现登陆过滤器，实现token安全机制，规范下接口返回模型等等。

前端使用vue后url路由由前端接管，后端只用实现功能需要的数据接口和一个返回前端初始化资源的初始页面暂定Web/Index。

通常实现是，登陆后重定向到Web/Index页面，Web/Index页面输出前端初始化资源，后续路由跳转由前端接管。

但因为是旧项目重构，只能一部分一部分切换为vue+webapi的新架构，需要和mvc的旧项目共用一段时间。通过菜单url的不同来确定跳转到新或者旧项目

这样就需要额外实现：新旧项目登陆/登出联动，并且保证新旧系统框架样式（菜单，头部，底部）保持一致。

还引发一个问题：从旧项目可以跳转到任意一个新项目功能页面，并且需要输出前端初始化资源，后续路由跳转就由前端接管了。

这样就需要很多路由规则都匹配到Web/Index，然后输出前端初始化资源

原实现方式：

using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Web.Http;

namespace AppApi.Controllers
{
    /// <summary>
    /// 
    /// </summary>
    public class WebController : ApiController
    {
        #region Public APIs

        /// <summary>
        /// Index
        /// </summary>
        /// <returns></returns>
        [Route("fe/dashboard")]
        [Route("fe/Product/Index")]
        [Route("fe/User/Index")]
        [Route("fe/Order/Index")]
        [Route("fe/System/Menu/Index")]
        [Route("fe/System/Config/Index")]
        [HttpGet]
        public HttpResponseMessage Index()
        {
            //前端资源
            string resourceHtml = "";
            var response = new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(resourceHtml) };
            response.Content.Headers.ContentType = new MediaTypeHeaderValue("text/html");
            return response;
        }
        #endregion
    }
}

这种方式需要定义大量的路由规则。

新的实现方式：

使用重写DefaultHttpControllerSelector（Controller选择器），ApiControllerActionSelector（Action选择器）实现

因前端路由都包含 /fe/ ，所以我们就拦截所有包含 /fe/ 的url

1，重写 DefaultHttpControllerSelector 的 GetControllerName 方法

新建文件：CustomControllerSelector.cs

using System.Net.Http;
using System.Web.Http;
using System.Web.Http.Dispatcher;

namespace AppApi.App_Start
{
    /// <summary>
    /// 自定义Controller选择
    /// </summary>
    public class CustomControllerSelector : DefaultHttpControllerSelector
    {
        /// <summary>
        /// 
        /// </summary>
        /// <param name="configuration"></param>
        public CustomControllerSelector(HttpConfiguration configuration) : base(configuration)
        {
        }

        /// <summary>
        /// 摘要:获取指定 System.Net.Http.HttpRequestMessage 的控制器的名称。
        /// </summary>
        /// <param name="request">参数:request:HTTP 请求消息。</param>
        /// <returns>返回结果:指定 System.Net.Http.HttpRequestMessage 的控制器的名称。</returns>
        public override string GetControllerName(HttpRequestMessage request)
        {
            //Index规则(/fe/)满足的话，返回Web/Index
            if (request.RequestUri.AbsoluteUri.Contains("/fe/"))
            {
                return "Web";
            }
            else
            {
                return base.GetControllerName(request);
            }
        }
    }
}

,2，重写 ApiControllerActionSelector 的 SelectAction 方法

新建文件：CustomActionSelector.cs

using System.Linq;
using System.Web.Http.Controllers;

namespace AppApi.App_Start
{
    /// <summary>
    /// 自定义Action选择
    /// </summary>
    public class CustomActionSelector : ApiControllerActionSelector
    {
        /// <summary>
        /// 
        /// </summary>
        /// <param name="controllerContext"></param>
        /// <returns></returns>
        public override HttpActionDescriptor SelectAction(HttpControllerContext controllerContext)
        {
            //Index规则(/fe/)满足的话，返回Web/Index
            if (controllerContext.Request.RequestUri.AbsoluteUri.Contains("/fe/"))
            {
                return base.GetActionMapping(controllerContext.ControllerDescriptor).FirstOrDefault(f => f.Key == "Index").FirstOrDefault(d => d.ActionName == "Index");
            }
            else
            {
                return base.SelectAction(controllerContext);
            }
        }
    }
}

3，然后添加路由规则

            // WebIndex路由，返回前端资源
            config.Routes.MapHttpRoute(
                name: "WebIndex",
                routeTemplate: "fe/{*.}",//catch-all
                defaults: new { controller = "Web", action = "Index" }
                );

注意：routeTemplate: "fe/{*.}",//catch-all

使用 fe/{*.} 不管路由由几级都可以匹配

4，使自定义ControllerSelector，ActionSelector生效

            // 使用自定义ControllerSelector，ActionSelector
            config.Services.Replace(typeof(IHttpControllerSelector), new CustomControllerSelector(config));
            config.Services.Replace(typeof(IHttpActionSelector), new CustomActionSelector());

修改文件：WebApiConfig.cs

using AppApi.App_Start;
using Newtonsoft.Json.Serialization;
using System.Web.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Dispatcher;

namespace AppApi
{
    /// <summary>
    /// webapi配置
    /// </summary>
    public static class WebApiConfig
    {
        /// <summary>
        /// webapi注册
        /// </summary>
        /// <param name="config"></param>
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务
            config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver(); //json格式化小驼峰
            config.Formatters.Remove(config.Formatters.XmlFormatter);// 取消XML返回格式

            // 使用自定义ControllerSelector，ActionSelector
            config.Services.Replace(typeof(IHttpControllerSelector), new CustomControllerSelector(config));
            config.Services.Replace(typeof(IHttpActionSelector), new CustomActionSelector());

            // 特性路由(RouteAttribute)
            config.MapHttpAttributeRoutes();

            // Action路由
            config.Routes.MapHttpRoute(
                name: "ActionApi",
                routeTemplate: "api/{controller}/{action}/{id}",
                defaults: new { controller = "Common", action = "GetHttpCode", id = RouteParameter.Optional }
                );

            // WebIndex路由，返回前端资源
            config.Routes.MapHttpRoute(
                name: "WebIndex",
                routeTemplate: "fe/{*.}",//catch-all
                defaults: new { controller = "Web", action = "Index" }
                );
        }
    }
}

这样只要请求URL中包含 /fe/ 都会返回Web/Index响应输出

参考

https://docs.microsoft.com/zh-cn/aspnet/core/mvc/controllers/routing?view=aspnetcore-2.2#multiple-routes

https://www.cnblogs.com/Code-life/p/7182558.html