ASP.NET Core MVC 配置全域路由首碼

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<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}"; }}

總結

上面的黑體字，希望大家能夠理解並運用，這個例子只是實際需求中的很小的一個情境，在具體的項目中會有各種各樣正常或者非正常的需求，我們在做一個功能的時候要多多思考，其實 MVC 架構還有很多東西可以去學習，包括它的設計思想，擴充性等東西，都是需要慢慢領悟的。如果大家對 ASP.NET Core 感興趣，可以關注我一下，我會定期在部落格中分享我的一些學習成果吧。

通過此文希望能協助大家，謝謝大家對本站的支援！