【ASP.NET Core 基础知识】--中间件--创建自定义中间件

喵叔哟2024-01-17 8:06

一、为什么需要自定义中间件

自定义中间件在ASP.NET Core中的应用主要有以下几个原因：

  1. 满足特定需求： 默认情况下，ASP.NET Core提供了许多内置的中间件来处理常见的任务，如身份验证、授权、静态文件服务等。然而，某些项目可能有特定的需求，需要定制化的处理流程，这时就需要创建自定义中间件以满足项目的特殊要求。
  2. 增加业务逻辑： 自定义中间件允许开发人员向请求处理流程中添加业务逻辑。这对于执行与应用程序的核心功能相关的任务非常有用，例如日志记录、性能监控、请求转换等。通过自定义中间件，开发人员可以灵活地将业务逻辑集成到请求处理管道中。
  3. 解耦和模块化： 自定义中间件有助于将应用程序的不同部分解耦，使代码更具模块化和可维护性。每个中间件可以专注于特定的任务，这样代码的组织结构更清晰，便于理解和维护。
  4. 性能优化： 自定义中间件可以用于执行性能优化任务，例如缓存、压缩、请求重定向等。通过在请求处理流程中插入自定义中间件，可以更好地控制和优化应用程序的性能。
  5. 适应特定场景： 不同的应用场景可能需要不同类型的中间件。通过创建自定义中间件，开发人员可以根据应用的特定需求，灵活地调整和配置中间件，以适应不同的使用场景。

自定义中间件为开发人员提供了更大的灵活性和控制权，使他们能够更好地定制和优化ASP.NET Core应用程序的请求处理流程，满足特定的业务和性能需求。

二、创建自定义中间件的基本步骤

创建自定义中间件涉及以下基本步骤：

  1. 创建一个类： 创建一个类来实现你的中间件。这个类通常需要包含一个构造函数以及一个名为Invoke、InvokeAsync等的方法，用于处理请求。

    csharp 复制代码 
    public class CustomMiddleware
{
    private readonly RequestDelegate _next;

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

    public async Task InvokeAsync(HttpContext context)
    {
        // 中间件逻辑处理
        await _next(context);
    }
}

  2. 添加中间件的基本结构： 在中间件类中，你需要编写逻辑来处理请求。可以在Invoke方法中执行你的自定义逻辑，然后通过_next字段调用下一个中间件。

  3. 注册中间件： 在Startup.cs文件的Configure方法中，使用UseMiddleware或Use方法将中间件添加到请求处理管道中。确保注册中间件的顺序正确，因为中间件的执行顺序很重要。

    csharp 复制代码 
    public void Configure(IApplicationBuilder app)
{
    // 其他中间件
    app.UseMiddleware<CustomMiddleware>();
    // 或者使用 app.Use<CustomMiddleware>();
    // 其他中间件
}

  4. 中间件的执行流程： 确保理解中间件的执行流程。当请求到达时，每个中间件按照注册的顺序依次执行，然后请求通过管道传递给下一个中间件，直到最终的处理程序。

  5. 配置中间件： 如果中间件需要配置选项，可以通过构造函数参数或其他方式将配置传递给中间件。这允许你在Startup.cs中配置中间件的行为。

    csharp 复制代码 
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    // 其他中间件
    app.UseMiddleware<CustomMiddleware>(/* configuration options */);
    // 其他中间件
}

  6. 测试中间件： 最后，确保测试你的中间件。创建单元测试和集成测试，验证中间件在不同场景下的正确性和可靠性。

三、中间件的参数和上下文对象

3.1 解释中间件的参数

ASP.NET Core 中间件的 Invoke 或 InvokeAsync 方法通常接受一个 HttpContext 参数，该参数提供了关于当前请求和响应的信息。此外，中间件的构造函数也可以接受其他服务或选项，以实现更多的定制和灵活性。

  1. HttpContext 参数：

    • HttpContext 包含了有关当前请求和响应的信息，如请求路径、请求方法、请求头、查询参数、响应状态等。
    • 可以使用 HttpContext 提供的方法来访问请求和响应的内容，以及执行与中间件逻辑相关的操作。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    // 使用 context 处理请求和响应
}

  2. 构造函数参数：

    • 构造函数可以接受其他服务作为参数，这些服务是通过 ASP.NET Core 依赖注入系统提供的。通过依赖注入，可以在中间件中使用其他组件，如数据库上下文、日志记录器等。
    csharp 复制代码 
    public class CustomMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<CustomMiddleware> _logger;

    public CustomMiddleware(RequestDelegate next, ILogger<CustomMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    // ...
}

  3. 配置选项：

    • 如果中间件需要配置选项，可以通过构造函数参数传递配置信息。这样，中间件的行为可以在 Startup.cs 中进行配置。
    csharp 复制代码 
    public class CustomMiddlewareOptions
{
    public string OptionValue { get; set; }
}

public class CustomMiddleware
{
    private readonly RequestDelegate _next;
    private readonly CustomMiddlewareOptions _options;

    public CustomMiddleware(RequestDelegate next, IOptions<CustomMiddlewareOptions> options)
    {
        _next = next;
        _options = options.Value;
    }

    // ...
}
3.2 上下文对象的作用和使用方法

HttpContext 是 ASP.NET Core 中间件中的关键对象，它提供了有关当前请求和响应的信息，允许中间件与请求处理流程进行交互。以下是 HttpContext 的主要作用和使用方法：

  1. 请求信息的获取：

    • 通过 HttpContext.Request 属性，可以获取有关当前请求的详细信息，如路径、方法、协议、头部、查询参数等。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    string path = context.Request.Path;
    string method = context.Request.Method;
    // 其他请求信息的获取
}

  2. 响应信息的设置：

    • 通过 HttpContext.Response 属性，可以设置有关响应的信息，如状态码、头部、内容类型等。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    context.Response.StatusCode = 200;
    context.Response.ContentType = "text/plain";
    // 其他响应信息的设置
}

  3. 处理请求和响应内容：

    • 通过 HttpContext.Request.Body 和 HttpContext.Response.Body 属性，可以访问请求和响应的主体内容，允许中间件对其进行读取或写入。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    using (StreamReader reader = new StreamReader(context.Request.Body))
    {
        string requestBody = await reader.ReadToEnd();
        // 处理请求主体内容
    }

    // 处理响应主体内容
    await context.Response.WriteAsync("Hello, World!");
}

  4. 用户认证和授权信息：

    • HttpContext.User 属性包含有关用户的认证和授权信息，允许中间件根据用户的角色和声明执行相应的逻辑。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    ClaimsPrincipal user = context.User;
    // 处理用户认证和授权信息
}

  5. 重定向和路由：

    • 通过 HttpContext.Response.Redirect 方法，可以执行重定向操作。而通过 HttpContext.GetRouteData 方法，可以获取有关当前路由的信息。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    // 执行重定向
    context.Response.Redirect("/newpath");

    // 获取路由信息
    RouteData routeData = context.GetRouteData();
    // 处理路由信息
}

  6. 上下文的传递：

    • HttpContext.Items 属性允许中间件在请求处理流程中传递数据。这对于在中间件之间共享信息非常有用。
    csharp 复制代码 
    public async Task InvokeAsync(HttpContext context)
{
    context.Items["Key"] = "Value";
    // 在中间件之间传递数据
}

通过充分利用 HttpContext 对象的这些功能，中间件可以与请求处理管道中的其他组件进行交互，执行特定的逻辑，并对请求和响应进行处理。

四、示例：记录请求日志的中间件

以下是一个简单的示例，展示如何创建一个记录请求日志的自定义中间件。该中间件将请求的路径和时间戳记录到控制台，并继续将请求传递给下一个中间件或处理程序。

csharp 复制代码 
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using System.Threading.Tasks;

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 logged: {context.Request.Path} at {DateTime.Now}");

        // 将请求传递给下一个中间件或处理程序
        await _next(context);
    }
}

然后，在 Startup.cs 文件的 Configure 方法中，注册这个中间件：

csharp 复制代码 
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILogger<Startup> logger)
{
    // 其他中间件

    // 注册日志中间件
    app.UseMiddleware<LoggingMiddleware>();

    // 其他中间件

    // 配置异常处理中间件等
}

在这个示例中，LoggingMiddleware 类接受 RequestDelegate 和 ILogger 作为构造函数参数，分别表示请求处理管道的下一个组件和日志记录器。在 InvokeAsync 方法中，记录请求的路径和时间戳，然后调用 _next(context) 将请求传递给下一个中间件或处理程序。

这个中间件可以用于记录每个请求的基本信息，对于调试和监视应用程序的运行非常有用。

五、总结

ASP.NET Core 中间件是请求处理管道中的可插拔组件，通过自定义中间件，开发人员能够灵活处理请求和响应。创建自定义中间件的基本步骤包括编写类、注册和配置中间件，同时理解中间件的参数和上下文对象的使用。自定义中间件的需求源自对特定业务逻辑、性能优化和模块化的需求。

相关推荐
凡人的AI工具箱10 分钟前
每天40分玩转Django：实操图片分享社区
数据库·人工智能·后端·python·django
Q_19284999061 小时前
基于Spring Boot的个人健康管理系统
java·spring boot·后端
liutaiyi81 小时前
Redis可视化工具 RDM mac安装使用
redis·后端·macos
Q_19284999061 小时前
基于Springcloud的智能社区服务系统
后端·spring·spring cloud
xiaocaibao7771 小时前
Java语言的网络编程
开发语言·后端·golang
政采云技术1 小时前
Java反应式编程概述
后端
hanbarger2 小时前
分布式通信，微服务协调组件，zookeeper
分布式·zookeeper·中间件
会说法语的猪2 小时前
springboot实现图片上传、下载功能
java·spring boot·后端
凡人的AI工具箱2 小时前
每天40分玩转Django：实操多语言博客
人工智能·后端·python·django·sqlite
Cachel wood3 小时前
Django REST framework (DRF)中的api_view和APIView权限控制
javascript·vue.js·后端·python·ui·django·前端框架
热门推荐
0119个Web前端交互式3D JavaScript框架和库02ARM学习（31）编译器对overlay方式的支持03玄机平台应急响应—webshell查杀04RAG 实践- Ollama+RagFlow 部署本地知识库05【一文读懂】NTN（非地面网络）技术介绍06(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明07ZZ038 物联网应用与服务赛题第J套08组基轨迹建模 GBTM的介绍与实现（Stata 或 R）09Docker 夺命连环 15 问10VSCode插件 —— Cody AI （免费AI助手！）