了解 ASP.NET Core 中的中间件

技术分享 1年前 (2025-01-12) 0 999+

在 .NET Core 中，中间件（Middleware） 是处理 HTTP 请求和响应的核心组件。它们被组织成一个请求处理管道，每个中间件都可以在请求到达最终处理程序之前或之后执行操作。中间件可以用于实现各种功能，如身份验证、路由、日志记录、异常处理、静态文件服务等。

什么是中间件？

中间件是 HTTP 请求管道中的一个处理单元，负责处理传入的 HTTP 请求和返回的 HTTP 响应。每个中间件都有以下职责：

处理请求：可以对请求进行预处理（如修改请求内容、验证身份等）。
决定是否继续传递请求：可以选择将请求传递给下一个中间件，或者直接返回响应（短路请求管道）。
处理响应：可以在响应返回给客户端之前进行后处理（如添加响应头、记录日志等）。

中间件的工作原理

中间件的工作原理可以概括为以下几个步骤：

请求进入管道：
- 当一个 HTTP 请求进入应用程序时，它首先通过一系列的中间件组件。
- 每个中间件都有机会处理请求，并决定是否将请求传递给下一个中间件。
中间件的执行顺序：
- 中间件是按照添加的顺序依次执行的。
- 例如，身份验证中间件通常应该在路由中间件之前执行，以确保在路由处理请求之前已经进行了身份验证。
中间件的组成：
- 每个中间件通常是一个 Func<RequestDelegate, RequestDelegate> 委托，或者是一个实现了 IMiddleware 接口的类。
- RequestDelegate 是一个表示处理 HTTP 请求的委托，它接收一个 HttpContext 对象并返回一个 Task。
中间件的执行流程：
- 当请求进入中间件时，中间件可以选择：
  - 处理请求并直接返回响应（短路请求管道）。
  - 将请求传递给下一个中间件（调用 next(context)）。
- 如果中间件调用了 next(context)，那么请求将继续传递到下一个中间件。
- 当请求通过所有中间件后，最终的处理程序（如控制器）将处理请求并生成响应。
- 响应会按照相反的顺序通过中间件管道返回给客户端。

常见的中间件及其工作原理

以下是一些常见的中间件及其工作原理：

1. 身份验证中间件（Authentication Middleware）

作用：用于处理用户身份验证。
工作原理：
- 在请求到达控制器之前，身份验证中间件会检查请求中是否包含有效的身份验证信息（如 JWT 令牌、Cookie 等）。
- 如果身份验证成功，中间件会将用户信息存储在 HttpContext.User 中。
- 如果身份验证失败，中间件可以重定向到登录页面或返回 401 未授权响应。

示例：

public void Configure(IApplicationBuilder app) {     app.UseAuthentication(); // 启用身份验证     app.UseAuthorization();  // 启用授权 }

2. 路由中间件（Routing Middleware）

作用：用于将请求路由到相应的处理程序（如控制器）。
工作原理：
- 路由中间件会解析请求的 URL 和 HTTP 方法，并根据配置的路由规则将请求映射到相应的处理程序。
- 路由规则可以通过 UseRouting 和 UseEndpoints 配置。

示例：

public void Configure(IApplicationBuilder app) {     app.UseRouting(); // 启用路由解析     app.UseEndpoints(endpoints =>                      {                          endpoints.MapControllerRoute(                              name: "default",                              pattern: "{controller=Home}/{action=Index}/{id?}");                      }); }

3. 静态文件中间件（Static Files Middleware）

作用：用于提供静态文件（如 HTML、CSS、JavaScript 文件）。
工作原理：
- 静态文件中间件会检查请求的 URL，如果请求的是静态文件（如 wwwroot 目录下的文件），则直接返回文件内容。
- 如果请求的不是静态文件，则将请求传递给下一个中间件。

示例：

public void Configure(IApplicationBuilder app) {     app.UseStaticFiles(); // 启用静态文件服务 }

4. 异常处理中间件（Exception Handling Middleware）

作用：用于捕获和处理应用程序中的异常。
工作原理：
- 异常处理中间件会捕获管道中抛出的异常，并根据配置返回友好的错误页面或 JSON 响应。
- 通常用于开发环境和生产环境。

示例：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env) {     if (env.IsDevelopment())     {         app.UseDeveloperExceptionPage(); // 开发环境：显示详细错误页面     }     else     {         app.UseExceptionHandler("/Home/Error"); // 生产环境：重定向到错误页面     } }

5. 日志记录中间件（Logging Middleware）

作用：用于记录请求和响应的日志信息。
工作原理：
- 日志记录中间件可以在请求进入和离开管道时记录日志。
- 通常通过第三方库（如 Serilog）或内置的日志记录系统实现。

示例：

public class LoggingMiddleware {     private readonly RequestDelegate _next;     private readonly ILogger<LoggingMiddleware> _logger;      public LoggingMiddleware(RequestDelegate next, ILogger<LoggingMiddleware> logger)     {         _next = next;         _logger = logger;     }      public async Task InvokeAsync(HttpContext context)     {         _logger.LogInformation($"Request: {context.Request.Method} {context.Request.Path}");         await _next(context);         _logger.LogInformation($"Response: {context.Response.StatusCode}");     } }

自定义中间件

你可以创建自定义中间件来处理特定的需求。自定义中间件通常是一个类，它包含一个 Invoke 或 InvokeAsync 方法，该方法接收 HttpContext 和一个 RequestDelegate 参数。

示例：

public class CustomMiddleware {     private readonly RequestDelegate _next;      public CustomMiddleware(RequestDelegate next)     {         _next = next;     }      public async Task InvokeAsync(HttpContext context)     {         // 在调用下一个中间件之前执行的操作         await context.Response.WriteAsync("Custom Middleware: Beforen");          // 调用下一个中间件         await _next(context);          // 在调用下一个中间件之后执行的操作         await context.Response.WriteAsync("Custom Middleware: Aftern");     } }

然后在 Startup.cs 中使用这个中间件：

public void Configure(IApplicationBuilder app) {     app.UseMiddleware<CustomMiddleware>();      // 其他中间件     app.UseRouting();     app.UseEndpoints(endpoints =>                      {                          endpoints.MapGet("/", async context =>                          {                              await context.Response.WriteAsync("Hello World!");                          });                      }); }