ASP.NET Core MVC 設定全域路由前綴
前言
大家好，今天給大家介紹一個 ASP.NET Core MVC 的一個新特性，給全域路由加上統一前綴。嚴格說其實不算是新特性，不過是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
下面，我們就利用這個特性來實現我們今天的主題。謝謝你點的讚~ :)
加入全域路由統一前綴
沒有那麼多廢話了，直接上程式碼，要說的話全在程式碼裡：
//定义个类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));
}
}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();
}
}[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}";
}
}
