使用Map/MapWhen扩展方法

.NET Core中间件的注册和管道的构建（3） ---- 使用Map/MapWhen扩展方法

0x00 为什么需要Map（MapWhen）扩展

如果业务逻辑比较简单的话，一条主管道就够了，确实用不到Map。不过当业务逻辑比较复杂的时候，有时候我们可能希望根据情况的不同使用特殊的一组中间件来处理HttpContext。这种情况下如果只用一条管道，处理起来会非常麻烦和混乱。此时就可以使用Map/MapWhen建立一个分支管道，当条件符合我们的设定时，由这个分支管道来处理HttpContext。使用Map/MapWhen添加分支管道是很容易的，只要提供合适跳转到分支管道的判断逻辑，以及分支管道的构建方法就可以了。

0x01 Map扩展的原理

前一篇文章中我们说过，中间件的注册和管道的构建都是通过ApplicationBuilder进行的。因此要构建一个分支管道，需要一个新的ApplicationBuilder，并用它来注册中间件，构建管道。为了在分支管道中也能够共享我们在当前ApplicationBuilder中注册的服务（或是说共享依赖注入容器，当然共享的并不止这些），在创建新的ApplicationBuilder时并不是直接new一个全新的，而是调用当前ApplicationBuilder的New方法在当前的基础上创建新的，共享了当前ApplicationBuilder的Properties（其中包含了依赖注入容器）。

在使用Map注册中间件时我们会传入一个Action<IApplicationBuilder>参数，它的作用就是，当我们创建了新的ApplicationBuilder后，使用这个方法对其进行各种设置，最重要的就是在新的ApplicationBuilder上注册分支管道的中间件。配置完成后调用分支ApplicationBuilder的Builder方法构建管道，并把第一个中间件保存下来作为分支管道的入口。

在使用Map注册中间件时传入了一个PathString参数，PathString对象我们可以简单地认为是string。它用于记录HttpContext.HttpRequest.Path中要匹配的区段（Segment）。这个字符串参数结尾不能是“/”。如果匹配成功则进入分支管道，匹配失则败继续当前管道。

新构建的管道和用于匹配的字符串保存为MapOptions对象，保存了Map规则和分支管道的入口。之后构建MapMiddleware对象，并把它的Invoke方法包装为RequestDelegate，使用当前ApplicationBuilder的Use方法注册中间件。

下面是Map扩展方法：

下面是MapMiddleware的Invoke方法

0x02 MapWhen扩展的原理

Map主要通过URL中的Path来判断是否需要进入分支管道，但有时候我们很可能会有别的需求，例如我想对所有Method为DELETE的请求用特殊管道处理。这时候就需要用MapWhen了。MapWhen是一种通用的Map，可以由使用者来决定什么时候进入分支管道什么时候不进入。可以说Map是MapWhen的一种情况，因为这种情况太常见了，所以官方实现了一个。这样看来MapWhen就很简单了，在Map中我们传入参数PathString来进行HttpRequest.Path的匹配，在MapWhen中我们传入Func<HttpContext,bool>参数，有我们自行指定，当返回true时进入分支管道，返回false则继续当前管道。

下面是MapWhen扩展方法：

下面是MapWhenMiddleware的Invoke方法：

0x03 顺便提一下Run扩展

还有一个注册中间件的扩展方法是Run，因为非常简单，所以在最后提一下。Run就是用Use注册一个中间件，最后不调用下一个中间件直接返回。所以使用Run扩展方法注册中间件永远都是直接返回的，后面的中间件都不会被调用。

0x04 写在最后

Map/MapWhen和Run都很简单就不写测试了。到此为止中间件的注册和管道的构建主题就写完了。刚开始是出于对中间件有些地方的迷惑开始的，搞明白了后本想着写一篇博客分享下自己的心得，没想到越写越多，一篇分成两篇，到现在写了三篇。我这些也只是写了些大概，很多细节没写到，有兴趣的可以去github上看一下代码，管道和中间件相关的都在这个仓库：https://github.com/aspnet/HttpAbstractions。

0x05 相关文章

.NET Core中间件的注册和管道的构建（1）---- 注册和构建原理

.NET Core中间件的注册和管道的构建（2）---- 用UseMiddleware扩展方法注册中间件类

.NET Core中间件的注册和管道的构建（3） ---- 使用Map/MapWhen扩展方法

分类: .NET Core, ASP.NET