ASP.NET Core 2.0系列学习笔记-Middleware中间件

最新推荐文章于 2025-05-06 12:48:27 发布

原创最新推荐文章于 2025-05-06 12:48:27 发布 · 2.3k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Middleware中间件

ASP.NET Core 2.0系列学习笔记专栏收录该内容

12 篇文章

订阅专栏

本文介绍如何在ASP.NET Core应用中创建自定义中间件以记录客户端IP地址。通过逐步指南展示了中间件的实现过程，包括项目搭建、依赖项添加、中间件类设计及配置。

中间件（Middleware）：用于组成应用程序管道处理请求和响应的组件。管道内的每一个组件都可以选择是否将请求交给下一个组件，并在管道中调用下一个组件之前和之后执行某些操作。请求委托被用来建立请求管道，请求委托处理每一个HTTP请求。

请求委托通过使用IApplicationBuilder类型的Run、Map和Use扩展方法来配置，并在Startup类中传给Configure方法。

ASP.NET请求管道由一系列的请求委托所构成，依次调用，处理模型如下：

中间件的执行跟调用的顺序有关，然后在响应时则与相反的顺序返回。每一个委托在下一个委托之前或之后都有机会执行操作，任何委托都能选择停止传递到下一个委托，转而自己处理该请求，这就是请求短路。

•Use：进入中间件http管道模式

•Map：映射分支

•Run：执行处理，并返回Response

项目实战：自定义中间件，实现IP记录；

1.新建一个ASP.NET Core Web Application项目，选择空模版。

2.在新建好的项目中，使用NuGet包添加一个Microsoft.Extensions.Logging.Console; （执行命令：Install-Package Microsoft.Extensions.Logging.Console ）如下所示：

3.新建一个类 ReauestIPMiddleware.cs：

/// <summary>
/// 请求IP中间件
/// </summary>
public class RequestIPMiddlewre
{
    private readonly RequestDelegate _next; //定义请求委托
    private readonly ILogger _logger; //定义日志

    public RequestIPMiddlewre(RequestDelegate next,ILoggerFactory loggerFactory)
    {
       _next = next;
       _logger = loggerFactory.CreateLogger<RequestIPMiddlewre>();
    }

   /// <summary>
   /// 中间件核心功能
   /// 做什么功能，都在该方法中处理
   /// </summary>
   /// <param name="context"></param>
   /// <returns>Task(void)</returns>
   public async Task Invoke(HttpContext context)
   {
        string ip = context.Connection.RemoteIpAddress.ToString();
        _logger.LogInformation($"User IP：{ip}");
        await _next.Invoke(context);
        //await context.Response.WriteAsync($"Hello World!User IP：{ip}");
   }

}

4.再新建一个RequestIPExtensions.cs：

/// <summary>
/// 请求IP扩展类
/// </summary>
public static class RequestIPExtensions
{
    /// <summary>
    /// 引入请求IP中间件
    /// </summary>
    /// <param name="builder">扩展类型</param>
    /// <returns>IApplicationBuilder</returns>
    public static IApplicationBuilder UseRequestIP(this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<RequestIPMiddlewre>();
    }
}

5.使用RequestIPMiddleware(自定义请求IP中间件)：在Satrtup.cs 类Configure方法中添加 app.UseRequestIP();

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
   //if (env.IsDevelopment())
   //{
   //    app.UseDeveloperExceptionPage();
   //}

   //app.Run(async (context) =>
   //{
   //    await context.Response.WriteAsync("Hello World!");
   //});

   loggerFactory.AddConsole(minLevel: LogLevel.Information);
   app.UseRequestIP(); //使用中间件
   app.Run(async (context) =>
   {
        await context.Response.WriteAsync("Hello World!");
   });

}

注：在头文件中导入using Microsoft.Extensions.Logging;