ASP.NET Core MVC 设置全局路由前缀【C#.Net教程】,ASP.NET Core MVC 配置全局路由前缀

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

媒介

人人好，本日给人人引见一个 ASP.NET Core MVC 的一个新特征，给全局路由增加一致前缀。严厉说实在不算是新特征，不过是Core MVC特有的。

应用背景

不晓得人人在做 Web Api 应用顺序的时刻，有无遇到过这类场景，就是一切的接口都是以 /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 定名空间下，我们来看一下接口的定义。

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

我们晓得，MVC 框架有一些商定俗成的东西，那末这个接口就是主如果用来自定义一些 MVC 商定的一些东西的，我们可以经由过程指定 ApplicationModel 对象来增加或许修正一些商定。可以看到接口供应了一个 Apply的要领，这个要领有一个ApplicationModel对象，我们可以应用这个对象来修正我们须要的东西，MVC 框架本身在启动的时刻会注入这个接口到 Services 中，所以我们只须要完成这个接口，然后略加设置即可。

那再让我们看一下ApplicationModel 这个对象都有哪些东西：

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：主如果设置默许MVC Api Explorer的一些东西，包含Api的形貌信息，组信息，可见性等。

ControllerModel：主如果 Comtroller 默许商定相干的了，这个内里东西就比较多了，就不逐一引见了，我们等下就要设置内里的一个东西。

IFilterMetadata ：空接口，重要起到标记的作用。

另有一个处所须要通知人人的是，可以看到上面的 Controllers 属性它是一个IList<ControllerModel>，也就是说这个列表中记录了你顺序中的一切 Controller 的信息，你可以经由过程遍历的体式格局针对某一部份或某个 Controller 举行设置，包含Controller中的Actions的信息都可以经由过程此种体式格局来设置，我们可以应用这个特征来异常天真的对 MVC 框架举行革新，是否是很炫酷。

下面，我们就应用这个特征来完成我们本日的主题。感谢你点的赞~ :)

增加全局路由一致前缀

没有那末多空话了，直接上代码，要说的话全在代码里：

//定义个类RouteConvention，来完成 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)
  {
   // 已标记了 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);
    }
   }
 
   // 没有标记 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 感兴趣，可以关注我一下，我会按期在博客中分享我的一些进修效果吧。

经由过程此文愿望能协助人人，感谢人人对本站的支撑！

更多ASP.NET Core MVC 设置全局路由前缀相干文章请关注ki4网！