ASP.NET Core的路由[4]：来认识一下实现路由的RouterMiddleware中间件-低调大师

ASP.NET Core的路由[4]：来认识一下实现路由的RouterMiddleware中间件

2017-10-08 572

虽然ASP.NET Core应用的路由是通过RouterMiddleware这个中间件来完成的，但是具体的路由解析功能都落在指定的Router对象上，不过我们依然有必要以代码实现的角度来介绍一下这个中间件。在这之前，我们先来认识一个特殊的特性。[本文已经同步到《ASP.NET Core框架揭秘》之中]

让RouterMiddleware中间件委托Router完整整个路由工作之后，解析出来的路由参数会以一个RouteData对象的形式存储在RouteContext上下文中。但是RouteContext是为Router的执行建立的上下文，路由解析工作完成之后，这个上下文的生命周期也随着结束，既然整个RouteContext上下文都不存在了，请求处理的后续步骤如何获取这个RouteData对象呢？

通过《注册URL模式与HttpHandler的映射关系》的实例演示我们知道可以调用HttpContext的扩展方法GetRouteData来获取这个包含素所有路由参数的RouteData对象，这个意味着原本依附于RouteContext上下文的RouteData最终会被附加到代表当前请求上下文的HttpContext上，而具体承载这个RouteData的就是这个名为RoutingFeature的特性。RoutingFeature是我们对所有实现了IRoutingFeature接口的所有类型以及对应对象的统称。如下面的代码片段所示，这个接口通过属性RouteData来保存最终附加到HttpContext的RouteData。RoutingFeature类是这个接口的默认实现者，我们的RouterMiddleware默认情况下就是使用这个对象。

   1: public interface IRoutingFeature

   2: {

   3:     RouteData RouteData { get; set; }

   4: }

5:

   6: public class RoutingFeature : IRoutingFeature

   7: {

   8:     public RouteData RouteData { get; set; }

   9: }

如下所示的代码片段体现了RouterMiddleware处理请求的完整逻辑。我们在创建一个RouterMiddleware对象的时候需要指定一个Router对象，以及一个用来创建Logger的LoggerFactory。当这个中间件开始处理请求的时候，它会根据当前HttpContext创建一个RouteContext上下文对象，并将其作为参数调用Router的RotueAsync方法进行路由解析。如果在路由解析结束之后通过RouteContext的Handler属性返回的请求处理存在，意味着当前请求与注册的路由匹配，在此情况下它会将当前请求交给这个处理器做后续处理。在这之前它会从RouteContext上下文中提出出RouteData，然后据此创建一个RoutingFeature对象并附加到HttpContext上面。

   1: public class RouterMiddleware

   2: {

   3:     private ILogger             _logger;

   4:     private RequestDelegate     _next;

   5:     private IRouter             _router;

6:

   7:     public RouterMiddleware(RequestDelegate next, ILoggerFactory loggerFactory, IRouter router)

   8:     {

   9:         _next       = next;

  10:         _logger     = loggerFactory.CreateLogger<RouterMiddleware>();

  11:         _router     = router;

  12:     }

13:

  14:     public async Task Invoke(HttpContext context)

  15:     {

  16:         RouteContext routeContext = new RouteContext(context);

  17:         routeContext.RouteData.Routers.Add(_router);

  18:         await _router.RouteAsync(routeContext);

  19:         if (null == routeContext.Handler)

  20:         {

  21:             _logger.LogDebug(1, "Request did not match any routes.");

  22:             await _next(context);

  23:         }

  24:         else

  25:         {

  26:             context.Features.Set<IRoutingFeature>(new RoutingFeature {  RouteData = routeContext.RouteData})

  27:             await routeContext.Handler(context);

  28:         }

  29:     }

  30: }

我们除了可以调用HttpContext的扩展方法GetRouteData得到封装了路由参数的RouteData对象之前，我们还可以调用另一个名为GetRouteValue发的扩展方法直接获取某个路由参数的值。在如下所示的代码片段中，我们采用比较简单代码展示了这两个扩展放的实现。

   1: public static class RoutingHttpContextExtensions

   2: {

   3:     public static RouteData GetRouteData(this HttpContext context)

   4:     {

   5:         return context.Features.Get<IRoutingFeature>()?.RouteData;

   6:     }

7:

   8:     public static object GetRouteValue(this HttpContext context, string key)

   9:     {

  10:         return context.GetRouteData()?.Values[key];

  11:     }

  12: }

一般来说我们倾向于调用ApplicationBuilder的扩展方法UseRouter来注册RouterMiddleware中间件。具体来说，我们可以选择如下两个UseRouter方法重载。如果调用第一个重载，我们需要为注册的RouterMiddleware中间件提供一个具体的Router对象。对于第二个重载来说，这个Router对象实际上是利用RouteBuilder创建的，我们在调用这个方法的时候需要以Action<IRouteBuilder>对象的形式利用这个RouteBuilder注册所需的路由。

   1: public static class RoutingBuilderExtensions

   2: {

   3:     public static IApplicationBuilder UseRouter(this IApplicationBuilder builder, IRouter router)

   4:     {

   5:         return builder.UseMiddleware<RouterMiddleware>(new object[] { router });

   6:     }

7:

   8:     public static IApplicationBuilder UseRouter(this IApplicationBuilder builder, Action<IRouteBuilder> action)

   9:     {

  10:         RouteBuilder routeBuilder = new RouteBuilder(builder);

  11:         action(routeBuilder);

  12:         return builder.UseRouter(routeBuilder.Build());

  13:     }

  14: }

ASP.NET Core的路由[1]：注册URL模式与HttpHandler的映射关系
ASP.NET Core的路由[2]：路由系统的核心对象——Router
ASP.NET Core的路由[3]：Router的创建者——RouteBuilder
ASP.NET Core的路由[4]：来认识一下实现路由的RouterMiddleware中间件
ASP.NET Core的路由[5]：内联路由约束的检验

作者：蒋金楠
微信公众账号：大内老A
微博： www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送，或者想看看个人推荐的技术资料，可以扫描左边二维码（或者长按识别二维码）关注个人公众号（原来公众帐号蒋金楠的自媒体将会停用）。
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

原文链接

微信关注我们

原文链接：https://yq.aliyun.com/articles/226287

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

ASP.NET Core的路由[5]：内联路由约束的检验

当某个请求能够被成功路由的前提是它满足某个Route对象设置的路由规则，具体来说，当前请求的URL不仅需要满足路由模板体现的路径模式，请求还需要满足Route对象的所有约束。路由系统采用IRouteConstraint接口来表示路由约束，所以我们在接下来的内容中将路由约束统称为RouteConstraint。在大部分情况下，约束都是针对路由模板中定义的某个路由参数，其目的在于验证URL携带的某部分的内容是否有效。不过也有一些约束与路由参数无关，这些约束规范往往是除URL之前的其他请求元素，比如前面提到的HttpMethodRouteConstraint检验的就是请求采用的方法。 [本文已经同步到《ASP.NET Core框架揭秘》之中] 1: publicinterface IRouteConstraint 2: { 3: bool Match(HttpContext httpContext, IRouter route, string routeKey, 4: RouteValueDictionary values, RouteDirection routeDirection); ...

2017-10-08

597

在《注册URL模式与HttpHandler的映射关系》演示的实例中，我们总是利用一个RouteBuilder对象来为RouterMiddleware中间件创建所需的Router对象，接下来我们就着重来介绍这个对象。RouteBuilder是我们对所有实现了IRouteBuilder接口的所有类型以及对应对象的统称。[本文已经同步到《ASP.NET Core框架揭秘》之中] 目录一、RouteBuilder 二、RouteCollection 三、多个Route共享同一个Handler 四、每个Route具有独立的Handler 五、扩展方法MapVerb 一、RouteBuilder 如下面的代码片段所示，RouteBuilder对Router对象的创建体现在它的Build方法上。除此之外，IRouteBuilder接口还定义了一系列属性，我们可以利用它们得到用来注册中间件的ApplicationBuilder和用来提供服务的ServiceProvider。我们可以将多个Router注册到RouteBuilder上，这些注册的Router保存在Routes（不是Routers）属性上...

2017-10-08

541

资源下载

更多资源

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。

WebStorm

WebStorm 是jetbrains公司旗下一款JavaScript 开发工具。目前已经被广大中国JS开发者誉为“Web前端开发神器”、“最强大的HTML5编辑器”、“最智能的JavaScript IDE”等。与IntelliJ IDEA同源，继承了IntelliJ IDEA强大的JS部分的功能。