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

前言

大家好，今天给大家介绍一个 ASP.NET Core MVC 的一个新特性，给全局路由添加统一前缀。严格说其实不算是新特性，不过是Core MVC特有的。

应用背景

不知道大家在做 Web Api 应用程序的时候，有没有遇到过这种场景，就是所有的接口都是以 /api 开头的，也就是我们的api 接口请求地址是像这样的：

http://bineAttributeRouteModel(_centralPrefix, selectorModel.AttributeRouteModel); } } // 没有标记 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) { // 添加我们自定义 实现IApplicationModelConvention的RouteConvention opts.Conventions.Insert(0, new RouteConvention(routeAttribute)); }}

最后，在 Startup.cs 文件中，添加上面的扩展方法就可以了。

public class Startup{ public Startup(IHostingEnvironment env) { //... } public void ConfigureServices(IServiceCollection services) { //... services.AddMvc(opt => { // 路由参数在此处仍然是有效的，比如添加一个版本号 opt.UseCentralRoutePrefix(new RouteAttribute("api/v{version}")); }); } public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory) { //... app.UseMvc(); }}

其中，opt.UseCentralRoutePrefix 就是上面定义的那个扩展方法，此处路由参数仍然是可以使用的，所以比如你可以给你的接口指定一个版本号之类的东西。这样之后，你的所有 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}"; }}

总结

上面的黑体字，希望大家能够理解并运用，这个例子只是实际需求中的很小的一个场景，在具体的项目中会有各种各样正常或者非正常的需求，我们在做一个功能的时候要多多思考，其实 MVC 框架还有很多东西可以去学习，包括它的设计思想，扩展性等东西，都是需要慢慢领悟的。如果大家对 ASP.NET Core 感兴趣，可以关注我一下，我会定期在博客中分享我的一些学习成果吧。

通过此文希望能帮助大家，谢谢大家对本站的支持！