ASP.NET Core Web API异常处理

Question

public class ErrorHandlingFilter : ExceptionFilterAttribute
{
    public override void OnException(ExceptionContext context)
    {
        HandleExceptionAsync(context);
        context.ExceptionHandled = true;
    }

    private static void HandleExceptionAsync(ExceptionContext context)
    {
        var exception = context.Exception;

        if (exception is MyNotFoundException)
            SetExceptionResult(context, exception, HttpStatusCode.NotFound);
        else if (exception is MyUnauthorizedException)
            SetExceptionResult(context, exception, HttpStatusCode.Unauthorized);
        else if (exception is MyException)
            SetExceptionResult(context, exception, HttpStatusCode.BadRequest);
        else
            SetExceptionResult(context, exception, HttpStatusCode.InternalServerError);
    }

    private static void SetExceptionResult(
        ExceptionContext context, 
        Exception exception, 
        HttpStatusCode code)
    {
        context.Result = new JsonResult(new ApiResponse(exception))
        {
            StatusCode = (int)code
        };
    }
}

services.AddMvc(options =>
{
    options.Filters.Add(new AuthorizationFilter());
    options.Filters.Add(new ErrorHandlingFilter());
});

我遇到的问题是，当我的AuthorizationFilter中出现异常时，ErrorHandlingFilter没有处理异常。我希望它能在那里被捕获，就像它使用旧的ASP.NET Web API一样。

那么，如何捕获所有应用程序异常以及操作筛选器中的任何异常呢？

Answer 1

这两种方法都使用内置的异常处理中间件。在调用useMVC、userouting或useEndpoints之前添加此代码。它将处理来自在它之后注册的所有中间件的异常。

只需在ASP.NET路由到中间件注册之前添加此中间件。

app.UseExceptionHandler(c => c.Run(async context =>
{
    var exception = context.Features
        .Get<IExceptionHandlerPathFeature>()
        .Error;
    var response = new { error = exception.Message };
    await context.Response.WriteAsJsonAsync(response);
}));

注意：这仅适用于ASP.NET Core 5.0+。

// It should be one of your very first registrations
app.UseExceptionHandler("/error"); // Add this
app.UseEndpoints(endpoints => endpoints.MapControllers());

[AllowAnonymous]
[ApiExplorerSettings(IgnoreApi = true)]
public class ErrorsController : ControllerBase
{
    [Route("error")]
    public MyErrorResponse Error()
    {
        var context = HttpContext.Features.Get<IExceptionHandlerFeature>();
        var exception = context.Error; // Your exception
        var code = 500; // Internal Server Error by default

        if      (exception is MyNotFoundException) code = 404; // Not Found
        else if (exception is MyUnauthException)   code = 401; // Unauthorized
        else if (exception is MyException)         code = 400; // Bad Request

        Response.StatusCode = code; // You can use HttpStatusCode enum instead

        return new MyErrorResponse(exception); // Your error model
    }
}

一些重要的说明和意见：

• 您可以将依赖项注入到控制器的构造函数中。
需要
• [APIExplorerSettings(IgnoreApi=true)]。否则，它可能会打破你的虚张声势
• 同样，app.useExceptionHandler（“/error”）；必须是启动configure（...）方法中最重要的注册项之一。将其放在方法的顶部可能是安全的。
• app.useExceptionHandler（“/error”）和controller[route（“error”）]中的路径应该相同，以允许控制器处理从异常处理程序中间件重定向的异常。

这里是Microsoft官方文档的链接。

错误响应模型的一个例子（只是给你一些想法）：

public class MyErrorResponse
{
    public string Type { get; set; }
    public string Message { get; set; }
    public string StackTrace { get; set; }

    public MyErrorResponse(Exception ex)
    {
        Type = ex.GetType().Name;
        Message = ex.Message;
        StackTrace = ex.ToString();
    }
}

对于更简单的服务,您可能希望实现如下所示的http状态代码异常：

public class HttpStatusException : Exception
{
    public HttpStatusCode Status { get; private set; }

    public HttpStatusException(HttpStatusCode status, string msg) : base(msg)
    {
        Status = status;
    }
}

这可以从任何地方以这种方式抛出：

throw new HttpStatusCodeException(HttpStatusCode.NotFound, "User not found");

if (exception is HttpStatusException httpException)
{
    code = (int) httpException.Status;
}