AspNetCore全局异常处理

news/2024/12/11 14:22:35/文章来源:https://www.cnblogs.com/netcore5/p/18599515

AspNetCore全局异常处理

在开发ASP.NET Core应用程序时，全局异常处理是一个重要的概念。它允许我们集中处理应用程序中未捕获的异常，确保应用程序的稳定性和用户体验。

1. 为什么需要全局异常处理

全局异常处理的目的是为了：

统一错误响应：确保所有错误都以统一的格式返回给客户端。
避免敏感信息泄露：防止将内部错误细节暴露给用户。
提高用户体验：通过友好的错误信息提升用户满意度。
日志记录：记录错误详情，便于后续的问题追踪和修复。

2. 异常过滤器与异常中间件

在ASP.NET Core MVC中，异常过滤器（Exception Filters）和异常中间件（Middleware）都可以用来处理异常，但它们在请求处理管道中的位置和用途有所不同。

图片引用自博客园：https://www.cnblogs.com/dotnet261010/p/13193124.html

下面分析一下两者的区别

2.1异常中间件

异常中间件是在请求处理管道中处理异常的组件。它可以捕获整个请求处理过程中抛出的异常，包括在中间件、控制器、动作方法或视图渲染过程中发生的异常。

实现方式

异常中间件通常通过实现IMiddleware接口或创建一个扩展方法来注册。如前文所述，可以创建一个自定义的异常处理中间件，并在Startup.cs中注册它。

特点

全局性：异常中间件可以捕获整个请求处理管道中的异常。
顺序性：需要在Startup.cs中正确配置中间件的顺序。
灵活性：可以自定义异常处理逻辑，包括错误日志记录、错误响应格式等。

使用

创建一个异常处理中间件。这个中间件会在请求处理管道中的其他中间件抛出异常时被调用。

public class ExceptionHandlingMiddleware
{private readonly RequestDelegate _next;public ExceptionHandlingMiddleware(RequestDelegate next){_next = next;}public async Task InvokeAsync(HttpContext context){try{await _next(context);}catch (Exception ex){await HandleExceptionAsync(context, ex);}}private Task HandleExceptionAsync(HttpContext context, Exception exception){context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;var result = JsonConvert.SerializeObject(new{Success = false,Message = "An error occurred while processing your request.",Error = exception.Message});context.Response.ContentType = "application/json";return context.Response.WriteAsync(result);}
}

注册中间件，在Startup.cs中注册这个中间件

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{// 其他中间件注册...app.UseMiddleware<ExceptionHandlingMiddleware>();// 其他中间件注册...
}

2.2MVC异常过滤器

MVC异常过滤器是专门用于ASP.NET Core MVC应用程序的异常处理机制。它们允许开发者针对特定的控制器或动作方法配置异常处理逻辑。

实现方式

异常过滤器可以通过实现IExceptionFilter、IAsyncExceptionFilter、IExceptionFilter或IAsyncExceptionFilter接口来创建。

public class CustomExceptionFilter : IExceptionFilter
{public void OnException(ExceptionContext context){// 处理异常context.Result = new ContentResult{Content = "An error occurred.",StatusCode = (int)HttpStatusCode.InternalServerError};context.ExceptionHandled = true;}
}

注册方式

异常过滤器可以在全局、控制器或动作方法级别注册。

全局注册：在Startup.cs中使用services.AddControllers(options => options.Filters.Add(new CustomExceptionFilter());。
控制器级别：通过在控制器类上使用[TypeFilter(typeof(CustomExceptionFilter))]属性。
动作方法级别：通过在动作方法上使用[ExceptionFilter(typeof(CustomExceptionFilter))]属性。