详解ASP.NET Core MVC 源码学习:Routing 路由(2)

RoutingServiceCollectionExtensions 是一个扩展ASP.NET Core DI 的一个扩展类,在这个方法中用来进行 ConfigService,Routing 对外暴露了一个 IRoutingBuilder 接口用来让用户添加自己的路由规则,我们来看一下:

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); }

routeBuilder.Build() 构建了一个集合 RouteCollection,用来保存所有的 IRouter 处理程序信息,包括用户配置的Router。

RouteCollection 本身也实现了 IRouter , 所以它也具有路由处理的能力。

Routing 中间件的入口是 RouterMiddleware 这个类,通过这个中间件注册到 Http 的管道处理流程中, ASP.NET Core MVC 会把它默认的作为其配置项的一部分,当然你也可以把Routing单独拿出来使用。

我们来看一下 Invoke 方法里面做了什么,它位于RouterMiddleware.cs 文件中。

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中去。

接下来 await _router.RouteAsync(context) , 就是用到了 IRouter 接口中的 RouteAsync 方法了。

我们接着跟踪 RouteAsync 这个函数,看其内部都做了什么? 我们又跟踪到了RouteCollection.cs 这个类:

我们看一下 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(); } } } }

我觉得这个类,包括函数设计的很巧妙,如果是我的话,我不一定能够想的出来,所以我们通过看源码也能够学到很多新知识。

为什么说设计的巧妙呢? RouteCollection 继承了 IRouter 但是并没有具体的对路由进行处理,而是通过循环来重新将路由上下文分发的具体的路由处理程序上。我们来看一下他的流程:

1、为了提高性能,创建了一个RouteDataSnapshot 快照对象,RouteDataSnapshot是一个结构体,它存储了 Route 中的路由数据信息。

2、循环当前 RouteCollection 中的 Router,添加到 RouterContext里的Routers中,然后把RouterContext交给Router来处理。

3、当没有处理程序处理当前路由 snapshot.Restore() 重新初始化快照状态。

接下来就要看具体的路由处理对象了,我们从 RouteBase 开始。

1、RouteBase 的构造函数会初始化 RouteTemplate, Name, DataTokens, Defaults.
 Defaults 是默认配置的路由参数。

2、RouteAsync 中会进行一系列检查,如果没有匹配到URL对应的路由就会直接返回。

3、使用路由参数匹配器 RouteConstraintMatcher 进行匹配,如果没有匹配到,同样直接返回。

4、如果匹配成功,会触发 OnRouteMatched(RouteContext context)函数,它是一个抽象函数,具体实现位于 Route.cs 中。

然后,我们再继续跟踪到 Route.cs 中的 OnRouteMatch,一起来看一下:

protected override Task OnRouteMatched(RouteContext context) { context.RouteData.Routers.Add(_target); return _target.RouteAsync(context); }

_target 值得当前路由的处理程序,那么具体是哪个路由处理程序呢? 我们一起探索一下。

我们知道,我们创建路由一共有MapRoute,MapGet,MapPost,MapPut,MapDelete,MapVerb... 等等这写方式,我们分别对应说一下每一种它的路由处理程序是怎么样的,下面是一个示例:

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)) }); });

按照上面的示例解释一下,

MapRoute:使用这种方式的话,必须要给 DefaultHandler 赋值处理程序,否则会抛出异常,通常情况下我们会使用RouteHandler类。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wdpxfd.html