前言:之前文章中有提到过在Winform中处理全局异常(未捕获的异常),由于现在都是前后端分离,所以后端肯定也要做类似的异常处理,此文中后端采用的是.Net 6 WebApi,所以介绍下在此框架中如何进行全局的异常捕获以及记录,方便问题的排查等。.
-
使用异常过滤器来实现,新建一个类继承自
IAsyncExceptionFilter
,并在其中实现以下代码
public class ExceptionFilter : IAsyncExceptionFilter
{
Action<string, string, Exception>? _action;
public ExceptionFilter(Action<string,string,Exception> action)
{
_action=action;
}
public ExceptionFilter()
{
}
public Task OnExceptionAsync(ExceptionContext context)
{
// 如果异常没有被处理则进行处理
if (context.ExceptionHandled == false)
{
if (_action != null)
{
_action(((ControllerActionDescriptor)context.ActionDescriptor).ControllerName, ((ControllerActionDescriptor)context.ActionDescriptor).ActionName, context.Exception);
}
if (App.Environment.IsDevelopment())
{
context.Result = new ApiJsonResult(ApiResult.Error, "系统异常:" + context.Exception.Message);
}
else
{
context.Result = new ApiJsonResult(ApiResult.Error, "系统异常:请联系管理员或稍后再试");
}
}
// 设置为true,表示异常已经被处理了
context.ExceptionHandled = true;
return Task.CompletedTask;
}
}
-
以上代码中可以看到首先定义了一个三个参数的Action,这个Action主要就是用来处理捕捉到的信息的,参数分别是异常的控制器名称、函数名称以及异常的信息;为什么要这么做?因为为了高可用性,我是把
ExceptionFilter
放到了一个公共类库中,如果有其他项目需要的话,可以直接拿dll过去使用,不需要重复定义。所以这个Action的自定义程度就比较高,拿到异常的信息后,就可以根据自己需要存储本地文件、数据库等。
-
然后就是一个异常抛出的信息,理论上,只有在开发环境中,我们可以展示出来具体的异常信息;生产环境的话,我们就需要根据时间等条件自己去查日志了,所以这里是对环境做了判断
App.Environment.IsDevelopment()
-
builder.Services.AddControllers(options =>
{
options.Filters.Add(new ExceptionFilter((controller, action, exception) =>
{
//异常日志记录
ITSysExceptionlogServices exceptionlogServices = builder.Services.BuildServiceProvider().GetService<ITSysExceptionlogServices>();
exceptionlogServices.Insert(new TSysExceptionlog { Controller = controller, Action = action, Msg = exception.Message });
}));
});
-
在调用这里,我是使用了
SqlSugar
仓储模式把异常记录到数据库中的。也可以使用Log4Net
等进行文件方式的记录。