详解ASP.NET Core MVC 源码学习：Routing 路由 |
|
前言 最近打算抽时间看一下 ASP.NET Core MVC 的源码，特此把自己学习到的内容记录下来，也算是做个笔记吧 。 路由作为 MVC 的基本部分，所以在学习 MVC 的其他源码之前还是先学习一下路由系统，ASP.NET Core 的路由系统相对于以前的 Mvc 变化很大，它重新整合了 Web Api 和 MVC 。 路由源码地址 ：Routing-dev_jb51.rar 路由（Routing）功能介绍 路由是 MVC 的一个重要组成部分，它主要负责将接收到的 Http 请求映射到具体的一个路由处理程序上，在MVC 中也就是说路由到具体的某个 Controller 的 Action 上 。 路由的启动方式是在ASP.NET Core MVC 应用程序启动的时候作为一个中间件来启动的，详细信息会在下一篇的文章中给出 。 通俗的来说就是，路由从请求的 URL 地址中提取信息，然后根据这些信息进行匹配，从而映射到具体的处理程序上，因此路由是基于URL构建的一个中间件框架 。 路由中间件主要包含以下几个部分：
Getting Started ASP.NET Core Routing 主要分为两个项目，分别是 我们在阅读源码的过程中，我建议还是先大致浏览一下项目结构，然后找出关键类，再由入口程序进行阅读 。 Microsoft.AspNetCore.Routing.Abstractions 大致看完整个结构之后，我可能发现了几个关键的接口，理解了这几个接口的作用后能够帮助我们在后续的阅读中事半功倍 。 IRouter 在
public interface IRouter
{
Task RouteAsync(RouteContext context);
VirtualPathData GetVirtualPath(VirtualPathContext context);
}
这个接口主要干两件事情，第一件是根据路由上下文来进行路由处理，第二件是根据虚拟路径上下文获取 IRouteHandler 另外一个关键接口是
public interface IRouteHandler
{
RequestDelegate GetRequestHandler(HttpContext httpContext, RouteData routeData);
}
它返回一个 这个接口中
Values： 当前路由的路径下包含的键值 。 还有一个 IRoutingFeature 我根据这个接口的命名一眼就看出来了这个接口的用途，还记得我在之前博客中讲述Http管道流程中得时候提到过一个叫 工具箱 的东西么，这个
public interface IRoutingFeature
{
RouteData RouteData { get; set; }
}
原来他只是包装了 IRouteConstraint 这个接口我在阅读的时候看了一下注释，原来路由中的参数参数检查主要是靠这个接口来完成的 。 我们都知道在我们写一个 Route Url地址表达式的时候，有时候会这样写：
/// Defines the contract that a class must implement in order to check whether a URL parameter
/// value is valid for a constraint.
public interface IRouteConstraint
{
bool Match(
HttpContext httpContext,
IRouter route,
string routeKey,
RouteValueDictionary values,
RouteDirection routeDirection);
}
Microsoft.AspNetCore.Routing
public static IApplicationBuilder UseRouter(this IApplicationBuilder builder, Action<IRouteBuilder> action)
{
//...略
// 构造一个RouterBuilder 提供给action委托宫配置
var routeBuilder = new RouteBuilder(builder);
action(routeBuilder);
//调用下面的一个扩展方法，routeBuilder.Build() 见下文
return builder.UseRouter(routeBuilder.Build());
}
public static IApplicationBuilder UseRouter(this IApplicationBuilder builder, IRouter router)
{
//...略
return builder.UseMiddleware<RouterMiddleware>(router);
}
Routing 中间件的入口是 我们来看一下
public async Task Invoke(HttpContext httpContext)
{
var context = new RouteContext(httpContext);
context.RouteData.Routers.Add(_router);
await _router.RouteAsync(context);
if (context.Handler == null)
{
_logger.RequestDidNotMatchRoutes();
await _next.Invoke(httpContext);
}
else
{
httpContext.Features[typeof(IRoutingFeature)] = new RoutingFeature()
{
RouteData = context.RouteData,
};
await context.Handler(context.HttpContext);
}
}
首先，通过 httpContext 来初始化路由上下文（RouteContext），然后把用户配置的路由规则添加到路由上下文RouteData中的Routers中去 。 接下来 我们接着跟踪 我们看一下 RouteAsync 的流程：
public async virtual Task RouteAsync(RouteContext context)
{
var snapshot = context.RouteData.PushState(null, values: null, dataTokens: null);
for (var i = 0; i < Count; i++)
{
var route = this[i];
context.RouteData.Routers.Add(route);
try
{
await route.RouteAsync(context);
if (context.Handler != null)
{
break;
}
}
finally
{
if (context.Handler == null)
{
snapshot.Restore();
}
}
}
}
我觉得这个类，包括函数设计的很巧妙，如果是我的话，我不一定能够想的出来，所以我们通过看源码也能够学到很多新知识 。 为什么说设计的巧妙呢？ 1、为了提高性能，创建了一个RouteDataSnapshot 快照对象，RouteDataSnapshot是一个结构体，它存储了 Route 中的路由数据信息 。 2、循环当前 RouteCollection 中的 Router，添加到 RouterContext里的Routers中，然后把RouterContext交给Router来处理 。 3、当没有处理程序处理当前路由 接下来就要看具体的路由处理对象了，我们从 1、RouteBase 的构造函数会初始化 2、 3、使用路由参数匹配器 4、如果匹配成功，会触发 然后，我们再继续跟踪到
protected override Task OnRouteMatched(RouteContext context)
{
context.RouteData.Routers.Add(_target);
return _target.RouteAsync(context);
}
_target 值得当前路由的处理程序，那么具体是哪个路由处理程序呢？ 我们一起探索一下 。 我们知道，我们创建路由一共有
app.UseRouter(routes =>{
routes.DefaultHandler = new RouteHandler((httpContext) =>
{
var request = httpContext.Request;
return httpContext.Response.WriteAsync($"");
});
routes
.MapGet("api/get/{id}", (request, response, routeData) => {})
.MapMiddlewareRoute("api/middleware", (appBuilder) =>
appBuilder.Use((httpContext, next) => httpContext.Response.WriteAsync("Middleware!")
))
.MapRoute(
name: "AllVerbs",
template: "api/all/{name}/{lastName?}",
defaults: new { lastName = "Doe" },
constraints: new { lastName = new RegexRouteConstraint(new Regex("[a-zA-Z]{3}",RegexOptions.CultureInvariant, RegexMatchTimeout)) });
});
按照上面的示例解释一下，
这些所有的矛头都指向了 RouteHandler ， 我们来看看
public class RouteHandler : IRouteHandler, IRouter
{
// ...略
public Task RouteAsync(RouteContext context)
{
context.Handler = _requestDelegate;
return TaskCache.CompletedTask;
}
}
什么都没干，仅仅是将传入进来的 RequestDelegate 赋值给了 RouteContext 的处理程序 。 最后，代码会执行到 总结 我们来总结一下以上流程： 首先传入请求会到注册的 RouterMiddleware 中间件，然后它 RouteAsync 按顺序调用每个路由上的方法 。当一个请求到来的时候，IRouter实例选择是否处理已经设置到 关于路由模板和参数约束源码处理流程就不一一说了，有兴趣可以直接看下源码 。 以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家 。 |
