點(diǎn)擊下載
本文文檔

當(dāng)前位置：首頁 - 科技 - 知識百科 - 正文

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

來源：懂視網(wǎng) 責(zé)編：小采時間：2020-11-27 22:36:30

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

ASP.NET Core MVC 配置全局路由前綴:ASP.NET Core MVC 配置全局路由前綴前言大家好，今天給大家介紹一個 ASP.NET Core MVC 的一個新特性，給全局路由添加統(tǒng)一前綴。嚴(yán)格說其實(shí)不算是新特性，不過是Core MVC特有的。應(yīng)用背景不知道大家在做 Web Api 應(yīng)用程序的時候，有沒有遇到過這

推薦度：

點(diǎn)擊下載本文 文檔為doc格式

導(dǎo)讀ASP.NET Core MVC 配置全局路由前綴:ASP.NET Core MVC 配置全局路由前綴前言大家好，今天給大家介紹一個 ASP.NET Core MVC 的一個新特性，給全局路由添加統(tǒng)一前綴。嚴(yán)格說其實(shí)不算是新特性，不過是Core MVC特有的。應(yīng)用背景不知道大家在做 Web Api 應(yīng)用程序的時候，有沒有遇到過這

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

前言

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

應(yīng)用背景

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

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

或者是這樣的需求

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

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

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

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

IApplicationModelConvention 接口

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

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

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

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

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

下面，我們就利用這個特性來實(shí)現(xiàn)我們今天的主題。謝謝你點(diǎn)的贊~ :)

添加全局路由統(tǒng)一前綴

沒有那么多廢話了，直接上代碼，要說的話全在代碼里：

//定義個類RouteConvention，來實(shí)現(xiàn) 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)
 {
 // 已經(jīng)標(biāo)記了 RouteAttribute 的 Controller
 var matchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel != null).ToList();
 if (matchedSelectors.Any())
 {
 foreach (var selectorModel in matchedSelectors)
 {
 // 在 當(dāng)前路由上 再 添加一個 路由前綴
 selectorModel.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix,
 selectorModel.AttributeRouteModel);
 }
 }

 // 沒有標(biāo)記 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)
 {
 // 添加我們自定義 實(shí)現(xiàn)IApplicationModelConvention的RouteConvention
 opts.Conventions.Insert(0, new RouteConvention(routeAttribute));
 }
}

最后，在 Startup.cs 文件中，添加上面的擴(kuò)展方法就可以了。

public class Startup
{
 public Startup(IHostingEnvironment env)
 {
 //...
 }

 public void ConfigureServices(IServiceCollection services)
 {
 //...
 
 services.AddMvc(opt =>
 {
 // 路由參數(shù)在此處仍然是有效的，比如添加一個版本號
 opt.UseCentralRoutePrefix(new RouteAttribute("api/v{version}"));
 });
 }

 public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
 {
 //...
 
 app.UseMvc();
 }
}

其中，opt.UseCentralRoutePrefix 就是上面定義的那個擴(kuò)展方法，此處路由參數(shù)仍然是可以使用的，所以比如你可以給你的接口指定一個版本號之類的東西。這樣之后，你的所有 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}";
 }
}

總結(jié)

上面的黑體字，希望大家能夠理解并運(yùn)用，這個例子只是實(shí)際需求中的很小的一個場景，在具體的項目中會有各種各樣正常或者非正常的需求，我們在做一個功能的時候要多多思考，其實(shí) MVC 框架還有很多東西可以去學(xué)習(xí)，包括它的設(shè)計思想，擴(kuò)展性等東西，都是需要慢慢領(lǐng)悟的。如果大家對 ASP.NET Core 感興趣，可以關(guān)注我一下，我會定期在博客中分享我的一些學(xué)習(xí)成果吧。

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

聲明：本網(wǎng)頁內(nèi)容旨在傳播知識，若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com

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

推薦度：

點(diǎn)擊下載本文 文檔為doc格式

標(biāo)簽：全局配置路由

熱門焦點(diǎn)

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

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

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

最新推薦

猜你喜歡

熱門推薦