ASP.NET Core Middleware Pipeline

一、Middleware的本质？

在 ASP.NET Core 中，Middleware 是处理 HTTP 请求的核心组件，它们按照特定的顺序组成一个“管道”，每个 Middleware 都是对请求或响应的某种处理。

二、什么是 Middleware Pipeline？

Middleware Pipeline（中间件管道）是请求处理流程的序列，它决定了请求如何从客户端到达服务器并最终返回响应。每个中间件在此管道中都可以执行以下操作：

 

• 拦截请求：在请求到达处理逻辑（如控制器）之前修改请求。

 

• 处理请求：执行一些业务逻辑（例如认证、授权、日志记录等）。

• 拦截响应：在响应返回客户端之前，修改响应内容。

三、创建和配置 Middleware Pipeline　

using Middleware.Test.Api.Middleware;

namespace Middleware.Test.Api
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var builder = WebApplication.CreateBuilder(args);

            // Add services to the container.

            builder.Services.AddControllers();
            // Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
            builder.Services.AddOpenApi();

            var app = builder.Build();

            // Configure the HTTP request pipeline.
            if (app.Environment.IsDevelopment())
            {
                app.MapOpenApi();
            }

            app.UseHttpsRedirection();

            app.UseAuthorization();

            //Map 会在原始管道的基础上增加分支管道，只有路径匹配时才会进入该分支管道。
            //原来的管道也会执行
            app.Map("/map1/seg1", HandleMultiSeg);


            //自定义中间件1
            app.Use(async (context, next) =>
            {
                Console.WriteLine("Request started");
                await next();
                Console.WriteLine("Request completed");
            });

            //自定义中间件引入，可以重复引入不报错，都会执行
            app.UseMiddleware<TestMiddleware>();
            app.UseTestMiddleware();
            app.UseMiddleware<TestMiddleware>();

            //短路，请求进来，执行到Run就会返回，不会在执行下去
            //下面的MapConteroller就不会被执行，所以，控制器中的APi请求都是返回 Hello world!
            app.Run(async context =>
            {
                Console.WriteLine("Hello world! Request started");
                await context.Response.WriteAsync("Hello world!");
            });

            app.MapControllers();

            app.Run();
        }
        public static void HandleMultiSeg(IApplicationBuilder app)
        {
            app.UseTestMiddleware();
            app.Run(async context =>
            {
                Console.WriteLine("Map Test 1 started");
                await context.Response.WriteAsync("Map Test 1");
                Console.WriteLine("Map Test 1 Completed");
            });
        }
    }
}

四、中间件的执行顺序

• 请求阶段：请求从客户端到达服务器时，管道中的每个中间件按顺序依次执行。每个中间件有机会处理请求。

• 响应阶段：当请求经过所有中间件后，响应返回时，管道中的中间件会倒序执行。每个中间件可以修改响应内容。

五、创建自定义 Middleware

namespace Middleware.Test.Api.Middleware
{
    public class TestMiddleware
    {
        private readonly RequestDelegate _next;

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

        public async Task Invoke(HttpContext context)
        {
            // 在请求处理前做一些事情（例如日志记录、身份验证等）
            Console.WriteLine("TestCustom Request started at: " + DateTime.Now);

            await _next(context);

            // 在响应返回前做一些事情（例如修改响应、记录日志等）
            Console.WriteLine("TestCustom Response sent at: " + DateTime.Now);
        }

    }

    /// <summary>
    /// 提供扩展方法注入中间件
    /// 也可以在Program中直接app.UseMiddleware<TestMiddleware>();
    /// </summary>
    public static class TestMiddlewareExtensions
    {
        public static IApplicationBuilder UseTestMiddleware(this IApplicationBuilder app)
        {
            return app.UseMiddleware<TestMiddleware>();
        }
    }
}