ASP.NET Core MVC 配置全局路由前缀
ASP.NETCoreMVC配置全局路由前缀
前言
大家好，今天给大家介绍一个ASP.NETCoreMVC的一个新特性，给全局路由添加统一前缀。严格说其实不算是新特性，不过是CoreMVC特有的。
应用背景
不知道大家在做WebApi应用程序的时候，有没有遇到过这种场景，就是所有的接口都是以/api开头的，也就是我们的api接口请求地址是像这样的：
http://www.example.com/api/order/333
或者是这样的需求
http://www.example.com/api/v2/order/333
在以前，我们如果要实现这种需求，可以在Controller中添加一个[Route("/api/order")]这样的特性路由Attribute，然后MVC框架就会扫描你的路由表从而可以匹配到/api/order这样的请求。
但是第二个带版本号的需求，原本Controller的Route定义是[Route("/api/v1/order")]，现在要升级到v2，又有上百个接口，这就需要一个一个修改，可能就会懵逼了。
现在，有一种更加简便优雅的方式来做这个事情了，你可以统一的来添加一个全局的前缀路由标记，下面就一起来看看吧。
IApplicationModelConvention接口
首先，我们需要使用到IApplicationModelConvention这个接口，位于Microsoft.AspNetCore.Mvc.ApplicationModels命名空间下，我们来看一下接口的定义。
publicinterfaceIApplicationModelConvention
{
voidApply(ApplicationModelapplication);
}
我们知道，MVC框架有一些约定俗成的东西，那么这个接口就是主要是用来自定义一些MVC约定的一些东西的，我们可以通过指定ApplicationModel对象来添加或者修改一些约定。可以看到接口提供了一个Apply的方法，这个方法有一个ApplicationModel对象，我们可以利用这个对象来修改我们需要的东西，MVC框架本身在启动的时候会注入这个接口到Services中，所以我们只需要实现这个接口，然后稍加配置即可。
那再让我们看一下ApplicationModel这个对象都有哪些东西：
publicclassApplicationModel:IPropertyModel,IFilterModel,IApiExplorerModel
{
publicApiExplorerModelApiExplorer{get;set;}
publicIList<ControllerModel>Controllers{get;}
publicIList<IFilterMetadata>Filters{get;}
publicIDictionary<object,object>Properties{get;}
}
可以看到有ApiExplorer,Controllers,Filters,Properties等属性。
- ApiExplorerModel：主要是配置默认MVCApiExplorer的一些东西，包括Api的描述信息，组信息，可见性等。
- ControllerModel：主要是Comtroller默认约定相关的了，这个里面东西就比较多了，就不一一介绍了，我们等下就要配置里面的一个东西。
- IFilterMetadata：空接口，主要起到标记的作用。
还有一个地方需要告诉大家的是，可以看到上面的Controllers属性它是一个IList<ControllerModel>，也就是说这个列表中记录了你程序中的所有Controller的信息，你可以通过遍历的方式针对某一部分或某个Controller进行设置，包括Controller中的Actions的信息都可以通过此种方式来设置，我们可以利用这个特性来非常灵活的对MVC框架进行改造，是不是很炫酷。
下面，我们就利用这个特性来实现我们今天的主题。谢谢你点的赞~:)
添加全局路由统一前缀
没有那么多废话了，直接上代码，要说的话全在代码里：
//定义个类RouteConvention，来实现IApplicationModelConvention接口
publicclassRouteConvention:IApplicationModelConvention
{
privatereadonlyAttributeRouteModel_centralPrefix;
publicRouteConvention(IRouteTemplateProviderrouteTemplateProvider)
{
_centralPrefix=newAttributeRouteModel(routeTemplateProvider);
}
//接口的Apply方法
publicvoidApply(ApplicationModelapplication)
{
//遍历所有的Controller
foreach(varcontrollerinapplication.Controllers)
{
//已经标记了RouteAttribute的Controller
varmatchedSelectors=controller.Selectors.Where(x=>x.AttributeRouteModel!=null).ToList();
if(matchedSelectors.Any())
{
foreach(varselectorModelinmatchedSelectors)
{
//在当前路由上再添加一个路由前缀
selectorModel.AttributeRouteModel=AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix,
selectorModel.AttributeRouteModel);
}
}
//没有标记RouteAttribute的Controller
varunmatchedSelectors=controller.Selectors.Where(x=>x.AttributeRouteModel==null).ToList();
if(unmatchedSelectors.Any())
{
foreach(varselectorModelinunmatchedSelectors)
{
//添加一个路由前缀
selectorModel.AttributeRouteModel=_centralPrefix;
}
}
}
}
}
然后，我们就可以开始使用我们自己定义的这个类了。
publicstaticclassMvcOptionsExtensions
{
publicstaticvoidUseCentralRoutePrefix(thisMvcOptionsopts,IRouteTemplateProviderrouteAttribute)
{
//添加我们自定义实现IApplicationModelConvention的RouteConvention
opts.Conventions.Insert(0,newRouteConvention(routeAttribute));
}
}
最后，在Startup.cs文件中，添加上面的扩展方法就可以了。
publicclassStartup
{
publicStartup(IHostingEnvironmentenv)
{
//...
}
publicvoidConfigureServices(IServiceCollectionservices)
{
//...
services.AddMvc(opt=>
{
//路由参数在此处仍然是有效的，比如添加一个版本号
opt.UseCentralRoutePrefix(newRouteAttribute("api/v{version}"));
});
}
publicvoidConfigure(IApplicationBuilderapp,IHostingEnvironmentenv,ILoggerFactoryloggerFactory)
{
//...
app.UseMvc();
}
}
其中，opt.UseCentralRoutePrefix就是上面定义的那个扩展方法，此处路由参数仍然是可以使用的，所以比如你可以给你的接口指定一个版本号之类的东西。这样之后，你的所有Controller的RoteAttribute都会添加上了这个前缀，这样就完美解决了最开始的那个版本号的需求。他们看起来大概是这样的：
[Route("order")]
publicclassOrderController:Controller
{
//路由地址:/api/v{version}/order/details/{id}
[Route("details/{id}")]
publicstringGetById(intid,intversion)
{
//上面是可以接收到版本号的，返回version和id
return$"otherresource:{id},version:{version}";
}
}
publicclassItemController:Controller
{
//路由地址：/api/v{version}/item/{id}
[Route("item/{id}")]
publicstringGetById(intid,intversion)
{
//上面是可以接收到版本号的，返回version和id
return$"item:{id},version:{version}";
}
}
总结
上面的黑体字，希望大家能够理解并运用，这个例子只是实际需求中的很小的一个场景，在具体的项目中会有各种各样正常或者非正常的需求，我们在做一个功能的时候要多多思考，其实MVC框架还有很多东西可以去学习，包括它的设计思想，扩展性等东西，都是需要慢慢领悟的。如果大家对ASP.NETCore感兴趣，可以关注我一下，我会定期在博客中分享我的一些学习成果吧。
通过此文希望能帮助大家，谢谢大家对本站的支持！