随着应用程序变得越来越复杂和相互关联,高效和有弹性地处理故障的需求变得至关重要。考虑到这一点,.NET 8 引入了一个强大的工具,用于以更精细和自定义的方式处理异常:IExceptionHandler。
IExceptionHandler 是一个接口,允许开发人员在其应用程序中自定义异常处理。它提供了一种机制来拦截应用程序不同部分中未处理的异常,并采取特定措施来处理它们。可以实现此接口,以将异常定向到日志、错误报告、用户通知或适合应用程序上下文的任何其他操作。
在这篇文章中,我们将探讨 IExceptionHandler、如何实现它,以及它为应用程序的弹性带来的好处。
Visual Studio 2022 (.NET 8.0)Visual Studio 2022 (.NET 8.0)
第一步是创建一个实现 IExceptionHandler 接口的类,如下面的示例所示:
public class ErrorHandlingMiddleware : Microsoft.AspNetCore.Diagnostics.IExceptionHandler
{
public async ValueTask<bool> TryHandleAsync(HttpContext httpContext, Exception exception, CancellationToken cancellationToken)
{
using var property = LogContext.PushProperty("UserName", httpContext.User?.Identity?.Name ?? "anonymous");
Log.Error(exception, "Error");
var result = JsonSerializer.Serialize(new { error = exception?.Message });
httpContext.Response.ContentType = "application/json";
httpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
await httpContext.Response.WriteAsync(result, cancellationToken: cancellationToken);
return true;
}
}
接下来,让我们配置 Program.cs 类:
try
{
var builder = WebApplication.CreateBuilder(args);
builder.AddSerilogApi(builder.Configuration);
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddExceptionHandler<ErrorHandlingMiddleware>();
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler(opt => { });
app.UseAuthorization();
app.MapControllers();
app.Run();
}
catch (Exception ex)
{
Log.Fatal(ex, "Host terminated unexpectedly");
}
finally
{
Log.Information("Server Shutting down...");
Log.CloseAndFlush();
}
每当我们的应用程序出现异常时,都会自动调用 ErrorHandlingMiddleware。API 还将生成 ProblemDetails。最后,中间件向 UseExceptionHandler 注册。这样,我们就可以更好地控制拦截、处理和格式化错误响应的方式。
IExceptionHandler 是一个强大的工具,用于增强 .NET 8 应用程序的复原能力和可靠性,提供一种灵活且自定义的方法来处理未处理的异常。通过实现此接口并将其集成到我们的应用程序中,我们可以显着改善用户体验和软件质量,确保它能够有效地处理意外的错误情况。