NetCore——自定义全局异常处理

原创已于 2023-06-05 22:02:27 修改 · 1.2k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#开发语言 #ExceptionFilter #NetCore

于 2022-08-04 15:48:26 首次发布

ASP.NET Core 专栏收录该内容

81 篇文章

订阅专栏

这篇博客介绍了如何在应用程序中实现自定义异常处理，包括创建UserFriendlyException和BusinessException来封装友好的错误消息，使用AjaxResponse定义异常响应格式，通过StudentExceptionFilter自定义过滤器处理异常，并在Startup中配置自定义异常中间件。这些方法有助于提供更优雅的错误反馈和增强系统的异常处理能力。

一、UserFriendlyException自定义用户友好错误消息

  public class UserFriendlyException : BusinessException
    {
        public UserFriendlyException(
           string message,
           System.Exception innerException = null)
           //message传递给父类BusinessException
           : base(
                 message,
                 innerException)
        {
        }
    }

二、BusinessException

	//继承了系统异常
  public class BusinessException : System.Exception,
        IBusinessException
    {

        public LogLevel LogLevel { get; set; }

        public BusinessException(
            //UserFriendlyException（message）传递给Business的message
            string message = null,
            System.Exception innerException = null)
            //传递给系统异常的message（异常消息）
            : base(message, innerException)
        {
        }
    }

三、自定义异常消息格式AjaxResponse

public class AjaxResponse<TData>
    {
        /// <summary>
        /// 异常消息
        /// </summary>
        public string Message { get; set; }
        public AjaxResponse()
        {

        }

        public AjaxResponse(TData data)
        {
        }

        public AjaxResponse(string msg, bool success = false)
        {
            Message = msg;
        }

     

        public static AjaxResponse<TData> Result(bool isSuccess, int code, TData data, string message)
        {
            return new AjaxResponse<TData>
            {
                Message = message
            };
        }

四、StudentExceptionFilter自定义异常类

 public class StudentExceptionFilter:IExceptionFilter
    {
        /// <summary>
        /// 重写OnExceptionAsync方法，定义自己的处理逻辑
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public void OnException(ExceptionContext context)
        {
            //当使用UserFriendly后，自定义的异常消息，传入到了系统异常中
            var exception = context.Exception;  //获取异常消息的

            //自定义错误消息的格式
            var errorInfo = new AjaxResponse<object>("业务处理失败");
            //AjaxResponse中的message设置为，返回的异常消息的message
            errorInfo.Message = exception.Message;
            //设置返回结果为AjaxResponse格式的消息
            context.Result = new ObjectResult(errorInfo);

            //设置该异常已被处理，因为异常处理不是只有一处，设置处理，其他地方将不在处理
            context.ExceptionHandled = true; //Handled!
            //设置异常为空
            context.Exception = null; //Handled!
        }

    }

五、自定义异常注入到StartUp中

 services.AddControllersWithViews(
                options => {
                    options.Filters.Add(typeof（StudentExceptionFilter));
                        }
                )

六、自定义异常中间件

第一种当发生异常时，会进入到这里，处理异常信息，并返回

app.UseExceptionHandler(new ExceptionHandlerOptions{
    ExceptionHandler = async context=>
    {
        //包含错误的原始路径
        var exhandle = context.Features.Get<IExceptionHandlerFeature>();
        var ex = exhandle.Error;
        if(ex !=null)
        {
            context.Response.ContentType = "text/plain;charset=utf-8";
            await context.Response.WriteAsync(ex.ToString());
        }
    }
});

异常进来后，可以将错误转发到不同的异常处理，在program 中添加如下代码。

app.UseExceptionHandler(new ExceptionHandlerOptions
{
//将异常转到/error路径进行处理
    ExceptionHandlingPath = new PathString("/error")
});

/error路径错误处理逻辑

app.MapGet("/error",()=>{
    return "error1";
});