悠悠楠杉
网站页面
ASP.NETCore中间件创建方式汇总
06/19
ASP.NET Core 中间件创建方式汇总
在 ASP.NET Core 中，中间件（Middleware）是一个处理 HTTP 请求和响应的组件，它可以检查、修改或直接调用下一个中间件。在开发过程中，正确使用中间件可以极大地提升应用的灵活性和效率。本文将详细介绍在 ASP.NET Core 中创建和使用中间件的几种方式，包括通过实现 Startup.cs 配置、使用中间件工厂、以及创建自定义中间件等。
1. 通过 Startup.cs 配置中间件
在 ASP.NET Core 项目中，中间件通常在 Startup.cs 文件的 Configure 方法中配置。这种方法是最常见的中间件添加方式，适用于大多数常规场景。
示例：
csharp
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// 配置应用服务
app.UseDeveloperExceptionPage(); // 开发环境下的异常页面
app.Use(async (context, next) =>
{
// 自定义日志或预处理逻辑
await next(); // 调用下一个中间件
// 自定义后处理逻辑
});
app.UseRouting(); // 使用路由中间件
app.UseAuthorization(); // 使用授权中间件
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers(); // 映射控制器路由
});
}
2. 使用中间件工厂（Middleware Factory）
在某些情况下，当中间件的逻辑需要基于不同的条件或参数进行动态配置时，可以使用中间件工厂。这种方式使得中间件的创建更加灵活和可重用。
示例：
csharp
public class MyMiddlewareFactory : IMiddlewareFactory<MyMiddlewareOptions>
{
public IMiddleware Create(MyMiddlewareOptions options)
{
return new MyMiddleware(options);
}
}
在 Startup.cs 中配置：
csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddSingleton<MyMiddlewareOptions>(); // 注册选项服务
services.AddTransient<IMiddlewareFactory<MyMiddlewareOptions>, MyMiddlewareFactory>(); // 注册工厂服务
}
在 Configure 方法中添加：
csharp
app.UseMiddleware<MyMiddleware>(); // 通过工厂创建中间件实例并配置选项
3. 创建自定义中间件（C# 类）
对于更复杂的逻辑或特殊需求，可以通过创建一个 C# 类来定义自己的中间件。这种方式提供了最大的灵活性和控制能力。
示例：
```csharp
public class CustomMiddleware : IMiddleware
{
private readonly RequestDelegate next; // 下一个中间件引用，需要显式传递到构造器中
public CustomMiddleware(RequestDelegate next) => _next = next; // 构造函数中接收并保存下一个中间件的引用
public async Task InvokeAsync(HttpContext context, RequestDelegate next) // 实现 IMiddleware 的 InvokeAsync 方法来处理请求和响应的逻辑和调用下一个中间件
{
// 在这里执行预处理逻辑，如日志、身份验证等... 也可以访问 context 的信息如 Request, Response 等。
await _next(context); // 调用下一个中间件以继续请求的传递和处理。这里，next 是之前在构造函数中保存的引用。继续传递请求到链中的下一个组件。 不能修改 context 的状态和结果；它们是只读的。如果需要修改响应或结果，请使用 context 提供的接口（如 context.Response）。因此，我们可以在此之前执行诸如修改头部、添加响应内容等操作。,。但请注意不要在此处直接写 response 输出，因为这将导致后面的中间件和任何最终响应处理程序（如 Mvc 或 Razor Pages）无法正常工作。,而是应当通过 context.Response 进行修改以避免潜在冲突和问题。如果需要写入内容到响应，请确保使用适当的上下文接口（如 context.Response）。,）） 接着执行后处理逻辑，如统计、清理等... 并在这里结束方法以返回控制权给 ASP.NET Core 的请求管道。 // 任何设置好的 context 或修改过的状态都将在这一步之后被其他组件所使用或反映到最终响应中。 } } 接着是其他自定义逻辑和代码实现... 如添加自定义头部、设置状态码等。最后别忘了添加 RequestDelegate 的引用并调用它（_next(context)），以继续传递请求至管道中的下一个组件或最终响应处理程序！这就是自定义中间件的创建和配置方式！记得在 Startup.cs 的 Configure 方法中注册你的自定义中间件： app.UseMiddleware
