问题

如何创建一个最简单的ASP.NET Core中间件？

答案

使用VS创建一个ASP.NET Core 2.0的空项目，注意Startup.cs中的Configure()方法：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.Run(async (context) =>
  {
    await context.Response.WriteAsync("Hello World! (Run)");
  });
}

比较好的创建请求管道的方法是使用IApplicationBuilder上的扩展方法：

public static void RunHelloWorld(this IApplicationBuilder app)
{
  app.Run(async (context) =>
  {
    await context.Response.WriteAsync("Hello World! (Run)");
  });
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.RunHelloWorld();
}

运行，此时页面显示：

上面我们使用IApplicationBuilder.Run()来配置中间件，另外一种方法是IApplicationBuilder.Use()：

public static void UseHelloWorld(this IApplicationBuilder app)
{
  app.Use(async (context, next) =>
  {
    await context.Response.WriteAsync("Hello World! (Use)\n");
    await next();
  });
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.UseHelloWorld();
  app.RunHelloWorld();
}

运行，此时页面显示：

将中间件作为单独的类定义是更好的实践方法：

public class HelloWorldMiddleware
{
  private readonly RequestDelegate _next;

  public HelloWorldMiddleware(RequestDelegate next)
  {
    _next = next;
  }

  public async Task Invoke(HttpContext context)
  {
    await context.Response.WriteAsync("Hello World! (Use in Class)\n");
    await _next(context);
  }
}


public static class UseHelloWorldInClassExtensions
{
  public static IApplicationBuilder UseHelloWorldInClass(this IApplicationBuilder app)
  {
    return app.UseMiddleware();
  }
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.UseHelloWorld();
  app.UseHelloWorldInClass();
  app.RunHelloWorld();
}

运行，此时页面显示：

讨论

中间件是一个拦截HTTP请求和响应消息的组件。我们通过创建这些组件链，来为我们的应用程序创建一个请求管道。

我们通过Configure()方法的IApplicationBuilder参数来创建这个请求管道，IApplicationBuilder参数有如下方法：

1. Run()：添加中间件并终止请求管道（也就是说不再调用下一个中间件）。

2. Use()：添加中间件，使用lambda表达式或者一个具体的类。

3. Map()：根据请求路径添加中间件。

Run

这个方法接受RequestDelegate委托作为参数，当委托方法被调用时接受HttpContext参数。这个委托方法返回void，因为它会终止请求管道。

Use

这个方法接受Func委托作为参数，此委托方法有两个参数，分别是HttpContext和指向下一个中间件的next，返回空（Task）。如果没有调用下一个中间件，就会终止请求管道（和Run效果一样）。

UserMiddleware

当通过单独类创建中间件时，我们使用UseMiddleware方法，并将具体的实现类型作为泛型参数。

在中间件类中，有两个部分很重要：

1. 构造函数接受RequestDelegate。当调用此委托时会将当前请求传入下一个中间件。

2. 它拥有一个Invoke方法，接收HttpContext参数并返回空（Task）。当需要用到中间件时，框架会主动调用这个方法。

注：在单独类中实现中间件，并用UseMiddleware封装起来是最佳实践。

扩展方法

需要注意扩展方法的不同之处，RunXXX不会返回值，而UseXXX会返回值（IApplicationBuilder）。这是因为Run()终止请求管道，而Use()可能会链接到其他的中间件。

顺序

中间件按照它们在Configure()方法出现的顺序依次被调用。而返回到客户端的响应也会经历相同的中间件管道。