asp.net core webapi項目配置全局路由

0、目錄

 整體架構目錄：

ASP.NET Core分布式項目實戰-目錄

一、前言

 在開發項目的過程中，我新建立了一個controller，發現vs會給我們直接在controller頭添加字首，比如[Route("api/[controller]")],即在通路接口的時候會變成http://localhost:8000/api/values，但是如果控制器有很多個，或者要進行版本疊代時，我們會發現痛苦的時刻降臨了，要一個一個的修改。

如果在這個時候可以進行全局配置字首那真是福利呀，修改一處即可。為了能達到此目的我們就來運用一下吧。

二、配置

 0、在配置前我們先來看看接口的字首吧。立圖為證 

用swagger打開

1、我們需要用到 IApplicationModelConvention  這個接口，它是位于 Microsoft.AspNetCore.Mvc.ApplicationModels 指令空間下面。

MVC架構有一些約定俗成的東西，這個接口主就是用來定義一些MVC約定的東西。我們就可以通過 Apply方法中的 ApplicationModel  來修改或者添加一些約定，而且MV架構本身在啟動的時候會把此接口注入，以便于我們使用。

不過我們還是要來看一下這個ApplicationModel  對象裡面有什麼我們可以用到的地方，我們繼續深入：

看到這是不是很爽，我們可以看一下 每個屬性的給出的解釋

ApiExplorerModel:包括描述資訊，群組資訊，可見性等。

ControllerModel：主要是 Comtroller 預設約定相關的了，這個裡面東西就比較多了，有 控制器名稱、路由值、Actions等，我們接下去的配置也将會在此展開

IFilterMetadata ：空接口，主要起到标記的作用。

2、配置

第一步：先定義一個類，用來實作IApplicationModelConvention  接口。

/// <summary>
    /// 全局路由字首配置
    /// </summary>
    public class RouteConvention : IApplicationModelConvention
    {
        /// <summary>
        /// 定義一個路由字首變量
        /// </summary>
        private readonly AttributeRouteModel _centralPrefix;
        /// <summary>
        /// 調用時傳入指定的路由字首
        /// </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、已經标記了 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);
                    }
                }

                //2、 沒有标記 RouteAttribute 的 Controller
                var unmatchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel == null).ToList();
                if (unmatchedSelectors.Any())
                {
                    foreach (var selectorModel in unmatchedSelectors)
                    {
                        // 添加一個 路由字首
                        selectorModel.AttributeRouteModel = _centralPrefix;
                    }
                }
            }
        }
    }      

此處代碼需要注意下，上面代碼分為兩部分，一部分是控制器有路由配置，一部分是沒有路由配置。是以需要根據具體的情況來選擇使用。

第二步：添加上面後，我們就定義一個類來插入我們的路由吧。

定義MvcOptionsExtensions.cs，此方法主要是擴充了MVCoptions類

public static class MvcOptionsExtensions
    {
        /// <summary>
        /// 擴充方法
        /// </summary>
        /// <param name="opts"></param>
        /// <param name="routeAttribute"></param>
        public static void UseCentralRoutePrefix(this MvcOptions opts, IRouteTemplateProvider routeAttribute)
        {
            // 添加我們自定義 實作IApplicationModelConvention的RouteConvention
            opts.Conventions.Insert(0, new RouteConvention(routeAttribute));
        }
    }      

說明：routeAttribute 為我們自定的字首内容。

第三步：在startup.cs 裡面ConfigureServices 方法添加配置資訊

#region 配置全局路由
            //在各個控制器添加字首（沒有特定的路由前面添加字首）
            services.AddMvc(opt =>
            {
                opt.UseCentralRoutePrefix(new RouteAttribute("lg/v1/[action]"));
                //opt.UseCentralRoutePrefix(new RouteAttribute("api/[controller]/[action]"));

            });
            #endregion      

說明：上面的方括号在這邊是有效的。其中内容可以自定義。

第四步：運作

1、原先控制器路由字首保留

2、把原先的路由字首去除

三、總結

 至此，已很好的實作全局路由配置字首啦。可以開心的玩耍啦。

 github代碼位址：

github

asp.net Core 交流群：787464275 歡迎加群交流

如果您認為這篇文章還不錯或者有所收獲，您可以點選右下角的【推薦】按鈕精神支援，因為這種支援是我繼續寫作，分享的最大動力！

作者：

LouieGuo

微信公衆号：歡迎關注                                                 QQ技術交流群： 歡迎加群