.net 异常处理

使用开发者异常页面中间件

新建一个ASP.NET Core Web API项目

在Controller随便写一个Action来抛一个异常

[HttpGet]
public void ThrowError()
{
    throw new Exception("Error occurred");
}

运行项目，访问该Action即可看到如下页面

之所以能看到该页面，是因为新建的ASP.NET Core Web API项目已经默认使用了开发者异常页面中间件

如果使用的是.NET 5.0框架，可以在Startup.cs文件中看到app.UseDeveloperExceptionPage();

但在.NET 6.0框架中，相关代码被隐藏了
具体可参考https://zhuanlan.zhihu.com/p/439903310

开发者异常页面中间件只适合在开发环境使用，在生产环境下是不建议使用的，因为我们不希望用户（黑客）看到如此错误信息

使用异常处理中间件

我们可以自定义错误页，然后当错误发生时跳转到该页

实际上就是将请求的接口发生错误时，重置请求的路径为错误页的路径，这样用户就会看到我们自定义的错误页面了

具体做法是：
1.需要使用中间件，设置错误页面路径

app.UseExceptionHandler("/errorHandler");

2.然后在Controller中新建一个Action来返回一个自定义的错误信息或错误页，例如

[HttpGet("/errorHandler")]
public string ErrorHandler()
{
    return "Error";
}

或者说如果想在Action中获取异常对象，则可以使用以下方式

[HttpGet("/errorHandler")]
public object ErrorHandler()
{
    var exceptionHandlerPathFeture = HttpContext.Features.Get<IExceptionHandlerPathFeature>();

    Exception exception = exceptionHandlerPathFeture!.Error;
    
    return new
    {
        ErrorMessage = exception.Message,
        StackTrace = exception.StackTrace
    };
}

其实也可以不指定错误处理的路径，直接在使用ExceptionHandler中间件时就定义好错误处理的逻辑，例如：

//app.UseExceptionHandler("/errorHandler");
//改为
app.UseExceptionHandler(app =>
{
    app.Run(async context =>
    {
        var exceptionHandlerPathFeture = context.Features.Get<IExceptionHandlerPathFeature>();

        Exception exception = exceptionHandlerPathFeture!.Error;

        await context.Response.WriteAsJsonAsync(new
        {
            ErrorMessage = exception.Message,
            StackTrace = exception.StackTrace
        });
    });
});

使用ExceptionFilterAttribute

主要过程
1.新建一个类CustomExceptionFilterAttribute，继承ExceptionFilterAttribute
2.重写OnException方法
3.处理异常，context.Exception可以获取异常对象。
4.一般情况下处理完成后处理异常后需要给context.Result赋值，造成短路，这样可以直接返回结果，防止程序继续执行，例如context.Result = new JsonResult(“发生异常”); 或 context.Result = new OkObjectResult(“发生异常”); //一般情况下ajax返回JsonResult类型，如果需要跳转到错误页面则返回IActionResult类型

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;

namespace PureAPIProject
{
    public class CustomExceptionFilterAttribute : ExceptionFilterAttribute
    {
        public override void OnException(ExceptionContext context)
        {
            Console.WriteLine(context.Exception.Message);
            context.Result = new JsonResult("发生异常");
        }
    }
}

之后在需要指定哪些地方使用异常处理
例如在全局加，则需要在Startup.cs中配置

services.AddMvc(option =>
{
  option.Filters.Add<CustomExceptionFilterAttribute>();
});

如果需要在某个Controller加或某个Action加，只需要在Controller上或Action上加上自定义的特性即可
例如在某个Action上加

[HttpGet]
[CustomExceptionFilter]
public IActionResult Exception()
{
  int i = 0;
  int i2 = 1 / i;
  return Ok("ok");
}

如果需要在CustomExceptionFilterAttribute中注入了依赖，例如：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;

namespace PureAPIProject
{
    public class CustomExceptionFilterAttribute : ExceptionFilterAttribute
    {
        private readonly ILogger<CustomExceptionFilterAttribute> _logger;

        public CustomExceptionFilterAttribute(ILogger<CustomExceptionFilterAttribute> logger)
        {
            _logger = logger;
        }

        public override void OnException(ExceptionContext context)
        {
            _logger.LogError(context.Exception.Message);
            context.Result = new JsonResult("发生异常");
        }
    }
}

则在使用CustomExceptionFilterAttribute特性时，不能简单的使用

[CustomExceptionFilter]

而应改为：

[TypeFilter(typeof(CustomExceptionFilterAttribute))]