详解在ASP.NET Core中如何编写合格的中间件

175 阅读 0 评论 116 点赞

我是靠谱客的博主乐观衬衫，最近开发中收集的这篇文章主要介绍详解在ASP.NET Core中如何编写合格的中间件，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

这篇文章探讨了让不同的请求去使用不同的中间件，那么我们应该如何配置ASP.NET Core中间件？其实中间件只是在ASP.NET Core中处理Web请求的管道。所有ASP.NET Core应用程序至少需要一个中间件来响应请求，并且您的应用程序实际上只是中间件的集合。当然MVC管道本身就是中间件，早在WebForm时代就出现过HttpModules、HttpHandler、那个时候悠然记得我通过它们来组织我的广告系统，不闲扯我们继续。

每个中间件组件都有一个带有HttpContext参数的Invoke方法。您可以使用这个参数来处理方法。

public async Task Invoke(HttpContext context)
{
 if (context.Request.Path...)
 {
  await context.Response.WriteAsync("writing text...");
 }
}

应用程序中最顶层的中间件将始终针对每个请求被调用。这是由.NET框架自动完成的。中间件可以向客户端发送响应，也可以调用下一个中间件。对于后一种选择，它当然需要访问下一个中间件组件。这就是为什么大多数中间件组件都是使用带有RequestDelegate参数的构造函数定义的。总之，RequestDelegate会自动填充，您无需在意。

中间件在Startup.cs的Configure方法中注册。Configure方法具有IApplicationBuilder参数，该参数提供了所有类型的中间件注册所需的方法，我们试着去编写一个中间件。

public class MyCustomMiddleware
 {
  private readonly RequestDelegate _next;
  public MyCustomMiddleware(RequestDelegate next)
  {
   _next = next;
  }
  public async Task Invoke(HttpContext context, IWebHostEnvironment env)
  {
   context.Response.Headers["app-name"] = env.ApplicationName+"Zaranet";
   context.Response.Headers["env-name"] = env.EnvironmentName+ "Zaranet";
   await _next(context);
  }
 }

随后我们在Startup.cs的Configure方法中通过 use 来注册自定义中间件。

public void Configure(IApplicationBuilder app, ...)
{
 app.UseMyCustomMiddleware();
}

启动程序我们发现一些正常，我们得到了我们想要的效果。

但实际上，您很少需要直接调用UseMiddleware，因为中间件作者的标准方法是编写特定于所注册中间件的扩展方法：

using MiddlerWareSolucation.MiddlerWare;
using Microsoft.AspNetCore.Builder;

namespace MiddlerWareSolucation.MiddlerWare_Extensions
{
 public static class MyCustomMiddlewareExtensions
 {
  public static IApplicationBuilder UseMyCustomMiddleware(this IApplicationBuilder app)
  {
   app.UseMiddleware<MyCustomMiddleware>();

   return app;
  }
 }
}

随后直接调用Extensions扩展方法，效果还是一样的。

public void Configure(IApplicationBuilder app, ...)
{
 app.UseMyCustomMiddleware();
}

部分时候我们想要通过客户端请求的路径来对我们的中间件进行启动，当然 MapWhen 允许您通过指定谓词将中间件管道分成两个完全独立的分支：

app.UseMiddlewareOne();

app.MapWhen(context => context.Request.Path.StartsWithSegments("/api"), appBuilder =>
{
  appBuilder.UseMiddlewareTwo();
});

app.UseMiddlewareThree();

在此示例中，中间件One将始终执行，如果请求路径以“ / api”开头，则将执行中间件Two。否则，将执行中间件Three。使用这种配置，中间件2和中间件3都无法针对单个请求执行。

我想说的是最后一种情况是，您希望大多数中间件针对所有请求运行，但是您有一些条件件-特定中间件仅应针对某些请求运行。

这可以通过UseWhen轻松实现，UseWhen还使用谓词来确定中间件是否应该运行：

app.UseWhen(context => context.Request.Path.StartsWithSegments("/api"), appBuilder =>
{
 appBuilder.UseStatusCodePagesWithReExecute("/apierror/{0}");

 appBuilder.UseExceptionHandler("/apierror/500");
});

这样就可以通过选择注册方式来自己控制中间件。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持靠谱客。