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

前言

大家好，今天給大家介紹一個(gè) ASP.NET Core MVC 的一個(gè)新特性，給全局路由添加統(tǒng)一前綴。嚴(yán)格說其實(shí)不算是新特性，不過是Core MVC特有的。

應(yīng)用背景

不知道大家在做 Web Api 應(yīng)用程序的時(shí)候，有沒有遇到過這種場景，就是所有的接口都是以 /api 開頭的，也就是我們的api 接口請求地址是像這樣的：

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

或者是這樣的需求

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

在以前，我們?nèi)绻獙?shí)現(xiàn)這種需求，可以在 Controller 中添加一個(gè) [Route("/api/order")] 這樣的特性路由 Attribute，然后MVC 框架就會掃描你的路由表從而可以匹配到 /api/order 這樣的請求。

但是第二個(gè)帶版本號的需求，原本 Controller 的 Route 定義是 [Route("/api/v1/order")]，現(xiàn)在要升級到v2，又有上百個(gè)接口，這就需要一個(gè)一個(gè)修改，可能就會懵逼了。

現(xiàn)在，有一種更加簡便優(yōu)雅的方式來做這個(gè)事情了，你可以統(tǒng)一的來添加一個(gè)全局的前綴路由標(biāo)記，下面就一起來看看吧。

IApplicationModelConvention 接口

首先，我們需要使用到 IApplicationModelConvention這個(gè)接口，位于 Microsoft.AspNetCore.Mvc.ApplicationModels 命名空間下，我們來看一下接口的定義。

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

我們知道，MVC 框架有一些約定俗成的東西，那么這個(gè)接口就是主要是用來自定義一些 MVC 約定的一些東西的，我們可以通過指定 ApplicationModel 對象來添加或者修改一些約定。可以看到接口提供了一個(gè) Apply的方法，這個(gè)方法有一個(gè)ApplicationModel對象，我們可以利用這個(gè)對象來修改我們需要的東西，MVC 框架本身在啟動的時(shí)候會注入這個(gè)接口到 Services 中，所以我們只需要實(shí)現(xiàn)這個(gè)接口，然后稍加配置即可。

那再讓我們看一下ApplicationModel 這個(gè)對象都有哪些東西：

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：主要是配置默認(rèn)MVC Api Explorer的一些東西，包括Api的描述信息，組信息，可見性等。 ControllerModel：主要是 Comtroller 默認(rèn)約定相關(guān)的了，這個(gè)里面東西就比較多了，就不一一介紹了，我們等下就要配置里面的一個(gè)東西。 IFilterMetadata ：空接口，主要起到標(biāo)記的作用。

還有一個(gè)地方需要告訴大家的是，可以看到上面的 Controllers 屬性它是一個(gè)IList<ControllerModel>，也就是說這個(gè)列表中記錄了你程序中的所有 Controller 的信息，你可以通過遍歷的方式針對某一部分或某個(gè) Controller 進(jìn)行設(shè)置，包括Controller中的Actions的信息都可以通過此種方式來設(shè)置，我們可以利用這個(gè)特性來非常靈活的對 MVC 框架進(jìn)行改造，是不是很炫酷。