在 ASP.NET Core Web API 中使用异常筛选器捕获和统一处理异常

在 ASP.NET Core Web API 中，异常处理是一个非常重要的环节。通过捕获和处理异常，我们可以确保应用程序的健壮性，并向用户提供友好的错误响应。ASP.NET Core 提供了一种机制，即异常筛选器（Exception Filters），它允许我们在全局范围内捕获和处理异常。

一、异常筛选器的工作原理

异常筛选器是实现了 IExceptionFilter 接口的类。当 ASP.NET Core 管道中的中间件抛出异常时，异常筛选器会被触发。它允许我们在异常被发送到客户端之前，对异常进行处理，比如记录日志、修改异常消息等。

二、创建异常筛选器

要创建一个异常筛选器，你需要实现 IExceptionFilter 接口，并实现其中的 OnException 方法。

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
public classCustomExceptionFilter : IExceptionFilter
{
publicvoidOnException(ExceptionContext context)
{
// 在这里处理异常
// context.Exception 包含了抛出的异常信息
// 例如，我们可以记录异常信息
// LogException(context.Exception);
// 也可以修改响应内容
context.Result = new ObjectResult(new { error = "An error occurred" })
{
StatusCode = StatusCodes.Status500InternalServerError
};
// 还可以阻止异常继续向上层传播
// context.ExceptionHandled = true;
}
}




三、注册异常筛选器

异常筛选器可以在多个级别注册：全局、控制器或动作。

1. 全局注册 ：在 Startup.cs 的 ConfigureServices 方法中，使用 IMvcBuilder 的 AddFilters 方法注册。

publicvoidConfigureServices(IServiceCollection services)
{
services.AddControllers(options =>
{
options.Filters.Add<CustomExceptionFilter>(); // 全局注册异常筛选器
});
}


2. 控制器级别注册 ：在控制器类上应用 [ServiceFilter] 属性。

[ServiceFilter(typeof(CustomExceptionFilter))]
public classMyController : ControllerBase
{
// ...
}


3. 动作级别注册 ：在动作方法上应用 [ServiceFilter] 属性。

public classMyController : ControllerBase
{
[ServiceFilter(typeof(CustomExceptionFilter))]
public IActionResult MyAction()
{
// ...
}
}


四、注意事项

五、总结

通过实现和使用异常筛选器，你可以在 ASP.NET Core Web API 中全局地捕获和处理异常，从而提供一致和友好的错误响应给用户。同时，通过记录异常信息，你还可以帮助开发人员更好地了解应用程序的运行状况，并进行相应的调试和优化。