ASP.NET Core自定义中间件的方式详解

ASP.NET Core自定义中间件的方式详解

在ASP.NET Core中，中间件是一种非常强大的机制，可以在请求管道中执行自定义逻辑。本攻略将提供一些示例，演示如何在ASP.NET Core中创建自定义中间件。

步骤

步骤1：创建.NET Core Web API项目

首先，需要创建一个.NET Core Web API项目。可以使用以下命令在命令行中创建一个新的.NET Core Web API项目：

dotnet new webapi -n MyWebApi

在上面的命令中，使用 dotnet new 命令创建一个新的Web API项目。使用 -n 参数指定项目的名称为 MyWebApi。

步骤2：创建自定义中间件

接下来，需要创建自定义中间件。可以使用以下代码：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;

namespace MyWebApi
{
    public class MyMiddleware
    {
        private readonly RequestDelegate _next;

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

        public async Task InvokeAsync(HttpContext context)
        {
            // 在这里执行自定义逻辑
            await _next(context);
        }
    }

    public static class MyMiddlewareExtensions
    {
        public static IApplicationBuilder UseMyMiddleware(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<MyMiddleware>();
        }
    }
}

在上面的代码中，我们创建了一个名为 MyMiddleware 的自定义中间件。在 InvokeAsync 方法中，可以执行自定义逻辑。在 MyMiddlewareExtensions 类中，我们创建了一个扩展方法 UseMyMiddleware，用于将自定义中间件添加到请求管道中。

步骤3：使用自定义中间件

现在，需要在应用程序中使用自定义中间件。可以使用以下代码：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Hosting;

namespace MyWebApi
{
    public class Startup
    {
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseMyMiddleware();

            app.UseRouting();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapGet("/", async context =>
                {
                    await context.Response.WriteAsync("Hello World!");
                });
            });
        }
    }
}

在上面的代码中，我们在 Configure 方法中使用了自定义中间件。使用 app.UseMyMiddleware() 将自定义中间件添加到请求管道中。

示例说明

以下是两个示例说明，演示如何在ASP.NET Core中创建自定义中间件。

示例1：记录请求时间

以下是记录请求时间的步骤：

1. 创建一个新的.NET Core Web API项目。

dotnet new webapi -n MyWebApi

在上面的命令中，使用 dotnet new 命令创建一个新的Web API项目。使用 -n 参数指定项目的名称为 MyWebApi。

1. 创建自定义中间件。

在 MyMiddleware.cs 文件中添加以下代码：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using System.Diagnostics;
using System.Threading.Tasks;

namespace MyWebApi
{
    public class MyMiddleware
    {
        private readonly RequestDelegate _next;

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

        public async Task InvokeAsync(HttpContext context)
        {
            var stopwatch = new Stopwatch();
            stopwatch.Start();

            await _next(context);

            stopwatch.Stop();
            var elapsedMilliseconds = stopwatch.ElapsedMilliseconds;

            var message = $"Request took {elapsedMilliseconds} ms.";
            await context.Response.WriteAsync(message);
        }
    }

    public static class MyMiddlewareExtensions
    {
        public static IApplicationBuilder UseMyMiddleware(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<MyMiddleware>();
        }
    }
}

在上面的代码中，我们创建了一个名为 MyMiddleware 的自定义中间件。在 InvokeAsync 方法中，我们使用 Stopwatch 类记录请求的执行时间。在请求完成后，我们将执行时间写入响应中。

1. 使用自定义中间件。

在 Startup.cs 文件中添加以下代码：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Hosting;

namespace MyWebApi
{
    public class Startup
    {
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseMyMiddleware();

            app.UseRouting();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapGet("/", async context =>
                {
                    await context.Response.WriteAsync("Hello World!");
                });
            });
        }
    }
}

在上面的代码中，我们在 Configure 方法中使用了自定义中间件。使用 app.UseMyMiddleware() 将自定义中间件添加到请求管道中。

1. 运行应用程序并测试自定义中间件。

在Web浏览器中访问 http://localhost:5000/，以测试自定义中间件。应该可以看到以下响应：

Hello World!Request took [x] ms.

其中 [x] 是请求的执行时间。

示例2：记录请求方法和路径

以下是记录请求方法和路径的步骤：

1. 创建一个新的.NET Core Web API项目。

dotnet new webapi -n MyWebApi

在上面的命令中，使用 dotnet new 命令创建一个新的Web API项目。使用 -n 参数指定项目的名称为 MyWebApi。

1. 创建自定义中间件。

在 MyMiddleware.cs 文件中添加以下代码：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;

namespace MyWebApi
{
    public class MyMiddleware
    {
        private readonly RequestDelegate _next;

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

        public async Task InvokeAsync(HttpContext context)
        {
            var method = context.Request.Method;
            var path = context.Request.Path;

            var message = $"Request: {method} {path}";
            await context.Response.WriteAsync(message);

            await _next(context);
        }
    }

    public static class MyMiddlewareExtensions
    {
        public static IApplicationBuilder UseMyMiddleware(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<MyMiddleware>();
        }
    }
}

在上面的代码中，我们创建了一个名为 MyMiddleware 的自定义中间件。在 InvokeAsync 方法中，我们使用 HttpContext 对象获取请求的方法和路径。然后，我们将请求的方法和路径写入响应中。

1. 使用自定义中间件。

在 Startup.cs 文件中添加以下代码：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Hosting;

namespace MyWebApi
{
    public class Startup
    {
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseMyMiddleware();

            app.UseRouting();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapGet("/", async context =>
                {
                    await context.Response.WriteAsync("Hello World!");
                });
            });
        }
    }
}

在上面的代码中，我们在 Configure 方法中使用了自定义中间件。使用 app.UseMyMiddleware() 将自定义中间件添加到请求管道中。

1. 运行应用程序并测试自定义中间件。

在Web浏览器中访问 http://localhost:5000/，以测试自定义中间件。应该可以看到以下响应：

Request: GET /
Hello World!

其中 GET / 是请求的方法和路径。