ASP.NET Core MVC 配置全局路由前缀

应用背景

不知道大家在做 Web Api 应用程序的时候，有没有遇到过这种场景，就是所有的接口都是以 /api 开头的，也就是我们的api 接口请求地址是像这样的：

http://www.example.com/api/order/333

或者是这样的需求

http://www.example.com/api/v2/order/333

在以前，我们如果要实现这种需求，可以在 Controller 中添加一个 [Route("/api/order")] 这样的特性路由 Attribute，然后MVC 框架就会扫描你的路由表从而可以匹配到 /api/order 这样的请求。
但是第二个带版本号的需求，原本 Controller 的 Route 定义是 [Route("/api/v1/order")]，现在要升级到v2，又有上百个接口，这就需要一个一个修改，可能就会懵逼了。

现在，有一种更加简便优雅的方式来做这个事情了，你可以统一的来添加一个全局的前缀路由标记，下面就一起来看看吧。

IApplicationModelConvention 接口

首先，我们需要使用到 IApplicationModelConvention这个接口，位于 Microsoft.AspNetCore.Mvc.ApplicationModels 命名空间下，我们来看一下接口的定义。

public interface IApplicationModelConvention{    void Apply(ApplicationModel application);
}

我们知道，MVC 框架有一些约定俗成的东西，那么这个接口就是主要是用来自定义一些 MVC 约定的一些东西的，我们可以通过指定 ApplicationModel 对象来添加或者修改一些约定。可以看到接口提供了一个 Apply的方法，这个方法有一个ApplicationModel对象，我们可以利用这个对象来修改我们需要的东西，MVC 框架本身在启动的时候会注入这个接口到 Services 中，所以我们只需要实现这个接口，然后稍加配置即可。

那再让我们看一下ApplicationModel 这个对象都有哪些东西：

public class ApplicationModel : IPropertyModel, IFilterModel, IApiExplorerModel{    public ApiExplorerModel ApiExplorer { get; set; }    public IList<ControllerModel> Controllers { get; }    public IList<IFilterMetadata> Filters { get; }    public IDictionary<object, object> Properties { get; }
}

可以看到有 ApiExplorer,Controllers,Filters,Properties 等属性。

• ApiExplorerModel：主要是配置默认MVC Api Explorer的一些东西，包括Api的描述信息，组信息，可见性等。

• ControllerModel：主要是 Comtroller 默认约定相关的了，这个里面东西就比较多了，就不一一介绍了，我们等下就要配置里面的一个东西。

• IFilterMetadata ：空接口，主要起到标记的作用。

还有一个地方需要告诉大家的是，可以看到上面的 Controllers 属性它是一个IList<ControllerModel>，也就是说这个列表中记录了你程序中的所有 Controller 的信息，你可以通过遍历的方式针对某一部分或某个 Controller 进行设置，包括Controller中的Actions的信息都可以通过此种方式来设置，我们可以利用这个特性来非常灵活的对 MVC 框架进行改造，是不是很炫酷。

下面，我们就利用这个特性来实现我们今天的主题。谢谢你点的赞~ :)

添加全局路由统一前缀

没有那么多废话了，直接上代码，要说的话全在代码里：

//定义个类RouteConvention，来实现 IApplicationModelConvention 接口public class RouteConvention : IApplicationModelConvention{    private readonly AttributeRouteModel _centralPrefix;    public RouteConvention(IRouteTemplateProvider routeTemplateProvider)    {
        _centralPrefix = new AttributeRouteModel(routeTemplateProvider);
    }    //接口的Apply方法
    public void Apply(ApplicationModel application)    {        //遍历所有的 Controller
        foreach (var controller in application.Controllers)
        {            // 已经标记了 RouteAttribute 的 Controller
            var matchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel != null).ToList();            if (matchedSelectors.Any())
            {                foreach (var selectorModel in matchedSelectors)
                {                    // 在 当前路由上 再 添加一个 路由前缀
                    selectorModel.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix,
                        selectorModel.AttributeRouteModel);
                }
            }           // 没有标记 RouteAttribute 的 Controller
            var unmatchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel == null).ToList();            if (unmatchedSelectors.Any())
            {                foreach (var selectorModel in unmatchedSelectors)
                {                    // 添加一个 路由前缀
                    selectorModel.AttributeRouteModel = _centralPrefix;
                }
            }
        }
    }
}

然后，我们就可以开始使用我们自己定义的这个类了。

public static class MvcOptionsExtensions{    public static void UseCentralRoutePrefix(this MvcOptions opts, IRouteTemplateProvider routeAttribute)    {        // 添加我们自定义 实现IApplicationModelConvention的RouteConvention
        opts.Conventions.Insert(0, new RouteConvention(routeAttribute));
    }
}

最后，在 Startup.cs 文件中，添加上面的扩展方法就可以了。

public class Startup{    public Startup(IHostingEnvironment env)    {        //...
    }    public void ConfigureServices(IServiceCollection services)    {        //...
        
        services.AddMvc(opt =>
        {            // 路由参数在此处仍然是有效的，比如添加一个版本号
            opt.UseCentralRoutePrefix(new RouteAttribute("api/v{version}"));
        });
    }    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)    {        //...
        
        app.UseMvc();
    }
}

其中，opt.UseCentralRoutePrefix 就是上面定义的那个扩展方法，此处路由参数仍然是可以使用的，所以比如你可以给你的接口指定一个版本号之类的东西。这样之后，你的所有 Controller 的 RoteAttribute 都会添加上了这个前缀，这样就完美解决了最开始的那个版本号的需求。他们看起来大概是这样的：

[Route("order")]public class OrderController : Controller{    // 路由地址 : /api/v{version}/order/details/{id}
    [Route("details/{id}")]    public string GetById(int id, int version)    {        //上面是可以接收到版本号的，返回 version 和 id
        return $"other resource: {id}, version: {version}";
    }
}public class ItemController : Controller{    // 路由地址： /api/v{version}/item/{id}
    [Route("item/{id}")]    public string GetById(int id, int version)    {        //上面是可以接收到版本号的，返回 version 和 id
        return $"item: {id}, version: {version}";
    }
}