ASP.NET Core 全局异常处理库的精髓所在

项目简介

GlobalExceptionHandler.NET 是一个专为 ASP.NET Core 设计的全局异常处理库，它让你可以在应用层面上统一配置错误处理策略，避免在每个控制器动作中重复编写 try-catch 语句。这个中间件特别适用于隐藏错误代码，即使对于 API 消费者也是如此，确保返回500状态码以表示服务器端错误。

技术剖析

GlobalExceptionHandler.NET 将异常处理集中化，与 ASP.NET Core 的管道集成，并可选择性地依赖 MVC 框架进行内容协商。此库建立在 app.UseExceptionHandler() 中间件之上，但提供了更高级的配置方式，允许你定义不同的错误响应策略。

主要特性

• 集中的错误处理位置
• 减少控制器中的样板代码
• 跨越框架捕捉和适当地处理异常
• 隐藏错误信息，防止暴露给消费者

应用场景

这个库非常适合用于构建 RESTful API 和 Web 应用程序，能确保任何未预期的异常都能被优雅地处理，同时保持你的代码简洁且易于维护。无论是在 WebAPI 控制器还是复杂的服务层，GlobalExceptionHandler.NET 都可以提供一致的错误处理体验。

安装与基本设置

你可以通过 NuGet 管理器或 .NET Core CLI 快速安装：

Install-Package GlobalExceptionHandler

dotnet add package GlobalExceptionHandler

初始化配置仅需几行代码：

// Startup.cs

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseGlobalExceptionHandler(x => {
        x.ContentType = "application/json";
        x.ResponseBody(s => JsonConvert.SerializeObject(new
        {
            Message = "An error occurred whilst processing your request"
        }));
    });
    
    app.Map("/error", x => x.Run(y => throw new Exception()));
}

这样，当你的应用抛出异常时，将返回以下 JSON 格式的错误信息：

HTTP/1.1 500 Internal Server Error
Content-Type: application/json
...

{
  "Message": "An error occurred whilst processing your request"
}

处理特定异常

针对不同类型的异常，你可以自定义返回的状态码和响应体：

app.UseGlobalExceptionHandler(x => {
    x.ContentType = "application/json";
    ...

    x.Map<RecordNotFoundException>().ToStatusCode(StatusCodes.Status404NotFound)
        .WithBody((ex, context) => JsonConvert.SerializeObject(new {
            Message = "Resource could not be found"
        }));
});

这会将记录未找到异常映射到 404 状态码并返回指定的错误信息。

内容协商与日志记录

GlobalExceptionHandler.NET 还支持 ASP.NET Core MVC 的内容协商功能，允许客户端指定期望的内容类型。此外，通过 OnError 方法，你可以在捕获异常时执行自定义的日志记录操作。

结论

GlobalExceptionHandler.NET 提供了一种强大的工具来优化 ASP.NET Core 应用的错误管理，使你能够专注于核心业务逻辑，而无需担心错误处理的细节。其灵活的配置选项和对多种异常的处理能力使其成为开发者的首选解决方案。现在就加入使用，让您的应用程序更加健壮和专业吧！