ASP.NET CORE学习教程之自定义异常处理详解

时间:2021-05-28

为什么异常处理选择中间件?

传统的ASP.NET可以采用异常过滤器的方式处理异常,在ASP.NET CORE中,是以多个中间件连接而成的管道形式处理请求的,不过常用的五大过滤器得以保留,同样可以采用异常过滤器处理异常,但是异常过滤器不能处理MVC中间件以外的异常,为了全局统一考虑,采用中间件处理异常更为合适

为什么选择自定义异常中间件?

先来看看ASP.NET CORE 内置的三个异常处理中间件 DeveloperExceptionPageMiddleware, ExceptionHandlerMiddleware,StatusCodePagesMiddleware

1.DeveloperExceptionPageMiddleware

能给出详细的请求/返回/错误信息,因为包含敏感信息,所以仅适合开发环境

2.ExceptionHandlerMiddleware(蒋神博客:https://parison.CurrentCultureIgnoreCase)) > 0 ? CustomExceptionHandleType.JsonHandle : CustomExceptionHandleType.PageHandle; } if (handleType == CustomExceptionHandleType.JsonHandle) await JsonHandle(context, exception); else await PageHandle(context, exception, _option.ErrorHandingPath); } } } /// <summary> /// 统一格式响应类 /// </summary> /// <param name="ex"></param> /// <returns></returns> private ApiResponse GetApiResponse(Exception ex) { return new ApiResponse() { IsSuccess = false, Message = ex.Message }; } /// <summary> /// 处理方式:返回Json格式 /// </summary> /// <param name="context"></param> /// <param name="ex"></param> /// <returns></returns> private async Task JsonHandle(HttpContext context, Exception ex) { var apiResponse = GetApiResponse(ex); var serialzeStr = JsonConvert.SerializeObject(apiResponse); context.Response.ContentType = "application/json"; await context.Response.WriteAsync(serialzeStr, Encoding.UTF8); } /// <summary> /// 处理方式:跳转网页 /// </summary> /// <param name="context"></param> /// <param name="ex"></param> /// <param name="path"></param> /// <returns></returns> private async Task PageHandle(HttpContext context, Exception ex, PathString path) { context.Items.Add("Exception", ex); var originPath = context.Request.Path; context.Request.Path = path; //设置请求页面为错误跳转页面 try { await _next(context); } catch { } finally { context.Request.Path = originPath; //恢复原始请求页面 } }

使用扩展类进行中间件注册

public static class CustomExceptionMiddleWareExtensions { public static IApplicationBuilder UseCustomException(this IApplicationBuilder app, CustomExceptionMiddleWareOption option) { return app.UseMiddleware<CustomExceptionMiddleWare>(option); } }

在Startup.cs的Configuref方法中注册异常中间件

app.UseCustomException(new CustomExceptionMiddleWareOption( handleType: CustomExceptionHandleType.Both, //根据url关键字决定处理方式 jsonHandleUrlKeys: new PathString[] { "/api" }, errorHandingPath: "/home/error"));

接下来我们来进行测试,首先模拟一个将会进行页面跳转的未经捕获的异常

访问/home/about的结果

访问/home/test的结果 (该地址不存在)

OK异常跳转页面的方式测试完成,接下来我们测试返回统一格式(json)的异常处理,同样先模拟一个未经捕获的异常

访问/api/token/gettesterror的结果

访问/api/token/test的结果 (该地址不存在)

访问/api/token/getvalue的结果 (该接口需要身份验证)

测试完成,页面跳转和统一格式返回都没有问题,自定义异常中间件已按预期工作

需要注意的是,自定义中间件会响应每个HTTP请求,所以处理逻辑一定要精简,防止发生不必要的性能问题

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。

声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。

相关文章