asp.net core webapi项目配置全局路由
一、前言
?在開(kāi)發(fā)項(xiàng)目的過(guò)程中，我新創(chuàng)建了一個(gè)controller，發(fā)現(xiàn)vs會(huì)給我們直接在controller頭添加前綴，比如[Route("api/[controller]")],即在訪問(wèn)接口的時(shí)候會(huì)變成http://localhost:8000/api/values，但是如果控制器有很多個(gè)，或者要進(jìn)行版本迭代時(shí)，我們會(huì)發(fā)現(xiàn)痛苦的時(shí)刻降臨了，要一個(gè)一個(gè)的修改。
如果在這個(gè)時(shí)候可以進(jìn)行全局配置前綴那真是福利呀，修改一處即可。為了能達(dá)到此目的我們就來(lái)運(yùn)用一下吧。
?
二、配置
?0、在配置前我們先來(lái)看看接口的前綴吧。立圖為證?
用swagger打開(kāi)
?
1、我們需要用到?IApplicationModelConvention ?這個(gè)接口，它是位于?Microsoft.AspNetCore.Mvc.ApplicationModels 命令空間下面。
?
MVC框架有一些約定俗成的東西，這個(gè)接口主就是用來(lái)定義一些MVC約定的東西。我們就可以通過(guò) Apply方法中的 ApplicationModel? 來(lái)修改或者添加一些約定，而且MV框架本身在啟動(dòng)的時(shí)候會(huì)把此接口注入，以便于我們使用。
不過(guò)我們還是要來(lái)看一下這個(gè)ApplicationModel??對(duì)象里面有什么我們可以用到的地方，我們繼續(xù)深入：
?
看到這是不是很爽，我們可以看一下 每個(gè)屬性的給出的解釋
ApiExplorerModel:包括描述信息，群組信息，可見(jiàn)性等。
ControllerModel：主要是 Comtroller 默認(rèn)約定相關(guān)的了，這個(gè)里面東西就比較多了，有 控制器名稱(chēng)、路由值、Actions等，我們接下去的配置也將會(huì)在此展開(kāi)
IFilterMetadata ：空接口，主要起到標(biāo)記的作用。
?
2、配置
第一步：先定義一個(gè)類(lèi)，用來(lái)實(shí)現(xiàn)IApplicationModelConvention? 接口。
/// <summary>
? ? /// 全局路由前綴配置
? ? /// </summary>
? ? public class RouteConvention : IApplicationModelConvention
? ? {
? ? ? ? /// <summary>
? ? ? ? /// 定義一個(gè)路由前綴變量
? ? ? ? /// </summary>
? ? ? ? private readonly AttributeRouteModel _centralPrefix;
? ? ? ? /// <summary>
? ? ? ? /// 調(diào)用時(shí)傳入指定的路由前綴
? ? ? ? /// </summary>
? ? ? ? /// <param name="routeTemplateProvider"></param>
? ? ? ? public RouteConvention(IRouteTemplateProvider routeTemplateProvider)
? ? ? ? {
? ? ? ? ? ? _centralPrefix = new AttributeRouteModel(routeTemplateProvider);
? ? ? ? }
? ? ? ? //接口的Apply方法
? ? ? ? public void Apply(ApplicationModel application)
? ? ? ? {
? ? ? ? ? ? //遍歷所有的 Controller
? ? ? ? ? ? foreach (var controller in application.Controllers)
? ? ? ? ? ? {
? ? ? ? ? ? ? ? // 1、已經(jīng)標(biāo)記了 RouteAttribute 的 Controller
? //這一塊需要注意，如果在控制器中已經(jīng)標(biāo)注有路由了，則會(huì)在路由的前面再添加指定的路由內(nèi)容。
? ? ? ? ? ? ? ? var matchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel != null).ToList();
? ? ? ? ? ? ? ? if (matchedSelectors.Any())
? ? ? ? ? ? ? ? {
? ? ? ? ? ? ? ? ? ? foreach (var selectorModel in matchedSelectors)
? ? ? ? ? ? ? ? ? ? {
? ? ? ? ? ? ? ? ? ? ? ? // 在 當(dāng)前路由上 再 添加一個(gè) 路由前綴
? ? ? ? ? ? ? ? ? ? ? ? selectorModel.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix,
? ? ? ? ? ? ? ? ? ? ? ? ? ? selectorModel.AttributeRouteModel);
? ? ? ? ? ? ? ? ? ? }
? ? ? ? ? ? ? ? }
? ? ? ? ? ? ? ? //2、 沒(méi)有標(biāo)記 RouteAttribute 的 Controller
? ? ? ? ? ? ? ? var unmatchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel == null).ToList();
? ? ? ? ? ? ? ? if (unmatchedSelectors.Any())
? ? ? ? ? ? ? ? {
? ? ? ? ? ? ? ? ? ? foreach (var selectorModel in unmatchedSelectors)
? ? ? ? ? ? ? ? ? ? {
? ? ? ? ? ? ? ? ? ? ? ? // 添加一個(gè) 路由前綴
? ? ? ? ? ? ? ? ? ? ? ? selectorModel.AttributeRouteModel = _centralPrefix;
? ? ? ? ? ? ? ? ? ? }
? ? ? ? ? ? ? ? }
? ? ? ? ? ? }
? ? ? ? }
? ? }
此處代碼需要注意下，上面代碼分為兩部分，一部分是控制器有路由配置，一部分是沒(méi)有路由配置。因此需要根據(jù)具體的情況來(lái)選擇使用。
?
第二步：添加上面后，我們就定義一個(gè)類(lèi)來(lái)插入我們的路由吧。
定義MvcOptionsExtensions.cs，此方法主要是擴(kuò)展了MVCoptions類(lèi)
說(shuō)明：routeAttribute 為我們自定的前綴內(nèi)容。?
第三步：在startup.cs 里面ConfigureServices 方法添加配置信息
說(shuō)明：上面的方括號(hào)在這邊是有效的。其中內(nèi)容可以自定義。
?
第四步：運(yùn)行
1、原先控制器路由前綴保留
?
?
2、把原先的路由前綴去除
?
三、總結(jié)
?至此，已很好的實(shí)現(xiàn)全局路由配置前綴啦。可以開(kāi)心的玩耍啦。https://github.com/LouieGuo/GlobalRoutingPrefix
原文地址:https://www.cnblogs.com/guolianyu/p/9680899.html
.NET社區(qū)新聞，深度好文，歡迎訪問(wèn)公眾號(hào)文章匯總 http://www.csharpkit.com
總結(jié)
以上是生活随笔為你收集整理的asp.net core webapi项目配置全局路由的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇： C# 8中的Async Streams
- 下一篇： IdentityServer4实战 -