在.NET Core开发中，Middleware（中间件）是一个非常重要的概念。它允许开发者在请求处理管道中插入自定义逻辑，从而实现各种功能，如身份验证、日志记录、异常处理等。本文将深入探讨.NET Core中Middleware的实践，包括其基本概念、工作原理、常见使用场景以及如何自定义Middleware。
Middleware是.NET Core中处理HTTP请求和响应的组件。它位于请求处理管道的中间位置，可以在请求到达控制器之前或响应返回客户端之前执行一些操作。Middleware可以看作是一个链式结构，每个Middleware都可以处理请求并将其传递给下一个Middleware，或者直接返回响应。
Middleware的主要作用包括：
在.NET Core中，请求处理管道是一个由多个Middleware组成的链式结构。每个Middleware都可以处理请求并将其传递给下一个Middleware，或者直接返回响应。请求处理管道的入口是Startup类中的Configure方法。
计算
安全
数据库
网络和加速
企业服务
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
在上面的代码中，app.UseDeveloperExceptionPage()、app.UseExceptionHandler()、app.UseHttpsRedirection()等都是Middleware。它们按照顺序依次处理请求，并将请求传递给下一个Middleware。
Middleware的执行顺序非常重要，因为它决定了请求和响应的处理流程。通常情况下，Middleware的执行顺序与它们在Configure方法中的添加顺序一致。例如，在上面的代码中，app.UseDeveloperExceptionPage()会首先执行，然后是app.UseHttpsRedirection()，依此类推。
在某些情况下，Middleware可以选择不将请求传递给下一个Middleware，而是直接返回响应。这种行为称为“短路”。例如，身份验证Middleware可能会在用户未通过身份验证时直接返回401 Unauthorized响应，而不会将请求传递给下一个Middleware。
身份验证和授权是Web应用程序中常见的需求。在.NET Core中，可以使用UseAuthentication和UseAuthorizationMiddleware来实现身份验证和授权。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
日志记录是应用程序中非常重要的功能，它可以帮助开发者诊断和解决问题。在.NET Core中，可以使用UseMiddleware方法将自定义的日志记录Middleware添加到请求处理管道中。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseMiddleware<LoggingMiddleware>();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
异常处理是确保应用程序稳定性的重要手段。在.NET Core中，可以使用UseExceptionHandlerMiddleware来捕获和处理请求处理过程中发生的异常。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
}
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
静态文件处理是Web应用程序中常见的需求。在.NET Core中，可以使用UseStaticFilesMiddleware来处理静态文件请求。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseStaticFiles();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
路由是将请求映射到控制器的过程。在.NET Core中，可以使用UseRouting和UseEndpointsMiddleware来实现路由。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseRouting();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
在.NET Core中，可以通过创建一个类来实现自定义Middleware。这个类需要有一个Invoke或InvokeAsync方法，该方法接收一个HttpContext参数，并返回一个Task。
public class CustomMiddleware
{
private readonly RequestDelegate _next;
public CustomMiddleware(RequestDelegate next)
{
_next = next;
}
public async Task InvokeAsync(HttpContext context)
{
// 在请求处理之前执行的逻辑
await context.Response.WriteAsync("Before Request\n");
// 调用下一个Middleware
await _next(context);
// 在请求处理之后执行的逻辑
await context.Response.WriteAsync("After Request\n");
}
}
在Startup类的Configure方法中，可以使用UseMiddleware方法将自定义Middleware添加到请求处理管道中。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseMiddleware<CustomMiddleware>();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
在某些情况下，可能需要为Middleware配置一些选项。可以通过创建一个选项类，并在ConfigureServices方法中配置这些选项。
public class CustomMiddlewareOptions
{
public string Option1 { get; set; }
public int Option2 { get; set; }
}
在Startup类的ConfigureServices方法中，可以使用Configure方法配置这些选项。
public void ConfigureServices(IServiceCollection services)
{
services.Configure<CustomMiddlewareOptions>(options =>
{
options.Option1 = "Value1";
options.Option2 = 123;
});
services.AddControllersWithViews();
}
在自定义Middleware中，可以通过构造函数注入这些选项。
public class CustomMiddleware
{
private readonly RequestDelegate _next;
private readonly CustomMiddlewareOptions _options;
public CustomMiddleware(RequestDelegate next, IOptions<CustomMiddlewareOptions> options)
{
_next = next;
_options = options.Value;
}
public async Task InvokeAsync(HttpContext context)
{
// 使用配置的选项
await context.Response.WriteAsync($"Option1: {_options.Option1}\n");
await context.Response.WriteAsync($"Option2: {_options.Option2}\n");
await _next(context);
}
}
每个Middleware应该只负责一个特定的功能。这样可以提高Middleware的可维护性和可重用性。例如，一个Middleware只负责身份验证，另一个Middleware只负责日志记录。
Middleware的主要作用是处理请求和响应，而不是执行复杂的业务逻辑。复杂的业务逻辑应该放在控制器或服务层中。
在Middleware中，应该尽量使用依赖注入来获取所需的依赖项。这样可以提高Middleware的可测试性和可维护性。
在Middleware中，应该捕获和处理可能发生的异常，并返回适当的响应。这样可以确保应用程序的稳定性。
在Middleware中，应该尽量使用异步方法来处理请求和响应。这样可以提高应用程序的性能和响应速度。
Middleware是.NET Core中处理HTTP请求和响应的重要组件。通过合理使用Middleware，可以实现各种功能，如身份验证、日志记录、异常处理等。在开发过程中，应该遵循最佳实践，保持Middleware的单一职责，避免复杂的业务逻辑，使用依赖注入，处理异常，并使用异步方法。通过深入理解和实践Middleware，可以构建出高效、稳定、可维护的.NET Core应用程序。
亿速云「云服务器」，即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘，价格低至29元/月。点击查看>>
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
原文链接：https://my.oschina.net/u/3772973/blog/4585864
