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

應(yīng)用背景

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

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 框架就會(huì)掃描你的路由表從而可以匹配到 /api/order 這樣的請(qǐng)求。
但是第二個(gè)帶版本號(hào)的需求，原本 Controller 的 Route 定義是 [Route("/api/v1/order")]，現(xiàn)在要升級(jí)到v2，又有上百個(gè)接口，這就需要一個(gè)一個(gè)修改，可能就會(huì)懵逼了。

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

IApplicationModelConvention 接口

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

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

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

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

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>，也就是說(shuō)這個(gè)列表中記錄了你程序中的所有 Controller 的信息，你可以通過(guò)遍歷的方式針對(duì)某一部分或某個(gè) Controller 進(jìn)行設(shè)置，包括Controller中的Actions的信息都可以通過(guò)此種方式來(lái)設(shè)置，我們可以利用這個(gè)特性來(lái)非常靈活的對(duì) MVC 框架進(jìn)行改造，是不是很炫酷。

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

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

沒(méi)有那么多廢話了，直接上代碼，要說(shuō)的話全在代碼里：

//定義個(gè)類RouteConvention，來(lái)實(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)前路由上 再 添加一個(gè) 路由前綴
                    selectorModel.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix,
                        selectorModel.AttributeRouteModel);
                }
            }           // 沒(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;
                }
            }
        }
    }
}

然后，我們就可以開始使用我們自己定義的這個(gè)類了。

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ù)在此處仍然是有效的，比如添加一個(gè)版本號(hào)
            opt.UseCentralRoutePrefix(new RouteAttribute("api/v{version}"));
        });
    }    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)    {        //...
        
        app.UseMvc();
    }
}

其中，opt.UseCentralRoutePrefix 就是上面定義的那個(gè)擴(kuò)展方法，此處路由參數(shù)仍然是可以使用的，所以比如你可以給你的接口指定一個(gè)版本號(hào)之類的東西。這樣之后，你的所有 Controller 的 RoteAttribute 都會(huì)添加上了這個(gè)前綴，這樣就完美解決了最開始的那個(gè)版本號(hào)的需求。他們看起來(lái)大概是這樣的：

[Route("order")]public class OrderController : Controller{    // 路由地址 : /api/v{version}/order/details/{id}
    [Route("details/{id}")]    public string GetById(int id, int version)    {        //上面是可以接收到版本號(hào)的，返回 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)    {        //上面是可以接收到版本號(hào)的，返回 version 和 id
        return $"item: {id}, version: {version}";
    }
}