.Net Core 中间件Middleware介绍

323 次浏览次阅读

1.中间件介绍

中间件是一种装配到应用管道以处理请求和响应的软件。每个组件：

选择是否将请求传递到管道中的下一个组件。
可在管道中的下一个组件前后执行工作

.Net Core 中间件Middleware介绍 — .Net Core完整请求处理管道

2.中间件的用途

中间件的主要用途是在请求到处理请求间添处理逻辑，比如：

身份、权限验证
用户验证
请求参数校验
请求返回值日志记录

3.中间件的标准写法

中间件的定义有两种方法。内联方式，单独封装到类中。

内联方式

app.Use(async (context, next) =>
{
    var cultureQuery = context.Request.Query["culture"];
    if (!string.IsNullOrWhiteSpace(cultureQuery))
    {
        var culture = new CultureInfo(cultureQuery);

        CultureInfo.CurrentCulture = culture;
        CultureInfo.CurrentUICulture = culture;
    }

    // Call the next delegate/middleware in the pipeline.
    await next(context);
});

单独封装到类

中间件类中必须包括：

具有类型为 RequestDelegate 的参数的公共构造函数
名为 Invoke 或 InvokeAsync 的公共方法
此方法必须返回 Task
接受类型 HttpContext 的第一个参数
构造函数和 Invoke/InvokeAsync 的其他参数由依赖关系注入 (DI) 填充

using System.Globalization;

namespace Middleware.Example;

public class RequestCultureMiddleware
{
    private readonly RequestDelegate _next;

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

    public async Task InvokeAsync(HttpContext context)
    {
        // 请求时的处理逻辑
        var cultureQuery = context.Request.Query["culture"];
        if (!string.IsNullOrWhiteSpace(cultureQuery))
        {
            var culture = new CultureInfo(cultureQuery);

            CultureInfo.CurrentCulture = culture;
            CultureInfo.CurrentUICulture = culture;
        }

        // 调用管道中的下一个委托/中间件
        await _next(context);
        // 请求返回时的处理逻辑
    }
}

4.内置中间件

中间件	描述	顺序
身份验证	提供身份验证支持。	在需要 `HttpContext.User` 之前。 OAuth 回叫的终端。
授权	提供身份验证支持。	紧接在身份验证中间件之后。
Cookie 策略	跟踪用户是否同意存储个人信息，并强制实施 cookie 字段（如 `secure` 和 `SameSite`）的最低标准。	在发出 cookie 的中间件之前。示例：身份验证、会话、MVC (TempData)。
CORS	配置跨域资源共享。	在使用 CORS 的组件之前。由于此错误，`UseCors` 当前必须在 `UseResponseCaching` 之前运行。
DeveloperExceptionPage	生成一个页面，其中包含的错误信息仅适用于开发环境。	在生成错误的组件之前。对于开发环境，项目模板会自动将此中间件注册为管道中的第一个中间件。
诊断	提供新应用的开发人员异常页、异常处理、状态代码页和默认网页的几个单独的中间件。	在生成错误的组件之前。异常终端或为新应用提供默认网页的终端。
转接头	将代理标头转发到当前请求。	在使用已更新字段的组件之前。示例：方案、主机、客户端 IP、方法。
运行状况检查	检查 ASP.NET Core 应用及其依赖项的运行状况，如检查数据库可用性。	如果请求与运行状况检查终结点匹配，则为终端。
标头传播	将 HTTP 标头从传入的请求传播到传出的 HTTP 客户端请求中。
HTTP 日志记录	记录 HTTP 请求和响应。	中间件管道的开头。
HTTP 方法重写	允许传入 POST 请求重写方法。	在使用已更新方法的组件之前。
HTTPS 重定向	将所有 HTTP 请求重定向到 HTTPS。	在使用 URL 的组件之前。
HTTP 严格传输安全性 (HSTS)	添加特殊响应标头的安全增强中间件。	在发送响应之前，修改请求的组件之后。示例：转接头、URL 重写。
MVC	用 MVC/Razor Pages 处理请求。	如果请求与路由匹配，则为终端。
OWIN	与基于 OWIN 的应用、服务器和中间件进行互操作。	如果 OWIN 中间件处理完请求，则为终端。
输出缓存	基于配置提供对缓存响应的支持。	在需要缓存的组件之前。 `UseRouting` 必须在 `UseOutputCaching` 之前。 `UseCORS` 必须在 `UseOutputCaching` 之前。
响应缓存	提供对缓存响应的支持。这需要客户端参与才能正常工作。使用输出缓存实现完整的服务器控制。	在需要缓存的组件之前。 `UseCORS` 必须在 `UseResponseCaching` 之前。通过对 Razor Pages 等 UI 应用没有好处，因为浏览器通常会设置阻止缓存的请求头。输出缓存有利于 UI 应用。
请求解压缩	提供对解压缩请求的支持。	在读取请求正文的组件之前。
响应压缩	提供对压缩响应的支持。	在需要压缩的组件之前。
请求本地化	提供本地化支持。	在对本地化敏感的组件之前。使用 RouteDataRequestCultureProvider 时，必须在路由中间件之后显示。
终结点路由	定义和约束请求路由。	用于匹配路由的终端。
SPA	通过返回单页应用程序 (SPA) 的默认页面，在中间件链中处理来自这个点的所有请求	在链中处于靠后位置，因此其他服务于静态文件、MVC 操作等内容的中间件占据优先位置。
会话	提供对管理用户会话的支持。	在需要会话的组件之前。
静态文件	为提供静态文件和目录浏览提供支持。	如果请求与文件匹配，则为终端。
URL 重写	提供对重写 URL 和重定向请求的支持。	在使用 URL 的组件之前。
W3CLogging	以 W3C 扩展日志文件格式生成服务器访问日志。	中间件管道的开头。
WebSockets	启用 WebSockets 协议。	在接受 WebSocket 请求所需的组件之前。