.NET Core开发实战(第22课:异常处理中间件:区分真异常与逻辑异常)--学习笔记(下)...
接下來介紹使用代理方法的方式,也就是說把 ErrorController 整段邏輯直接定義在注冊(cè)的地方,使用一個(gè)匿名委托來處理,這里的邏輯與之前的邏輯是相同的
app.UseExceptionHandler(errApp => {errApp.Run(async context =>{// 在 Features 里面獲取異常var exceptionHandlerPathFeature = context.Features.Get<IExceptionHandlerPathFeature>();// 識(shí)別異常是否為 IKnownExceptionIKnownException knownException = exceptionHandlerPathFeature.Error as IKnownException;if (knownException == null){// 如果不是則記錄并且把錯(cuò)誤的響應(yīng)碼響應(yīng)成 Http 500var logger = context.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();logger.LogError(exceptionHandlerPathFeature.Error, exceptionHandlerPathFeature.Error.Message);knownException = KnownException.Unknown;context.Response.StatusCode = StatusCodes.Status500InternalServerError;}else{// 如果捕獲到的是一個(gè)業(yè)務(wù)邏輯的異常,Http 響應(yīng)碼應(yīng)該給是 200knownException = KnownException.FromKnownException(knownException);context.Response.StatusCode = StatusCodes.Status200OK;}// 然后再把響應(yīng)信息通過 json 的方式輸出出去var jsonOptions = context.RequestServices.GetService<IOptions<JsonOptions>>();context.Response.ContentType = "application/json; charset=utf-8";await context.Response.WriteAsync(System.Text.Json.JsonSerializer.Serialize(knownException, jsonOptions.Value.JsonSerializerOptions));}); });為什么對(duì)于未知的異常要輸出 Http 500,而對(duì)于業(yè)務(wù)邏輯的異常,建議輸出 Http 200?
因?yàn)楸O(jiān)控系統(tǒng)實(shí)際上會(huì)對(duì) Http 的響應(yīng)碼進(jìn)行識(shí)別,當(dāng)監(jiān)控系統(tǒng)識(shí)別到 Http 響應(yīng)是 500 的比例比較高的情況下,會(huì)認(rèn)為系統(tǒng)的可用性有問題,這個(gè)時(shí)候告警系統(tǒng)就會(huì)發(fā)出警告
對(duì)于已知的業(yè)務(wù)邏輯的這種正常的識(shí)別的話,用正常的 Http 200 來處理是一個(gè)正常的行為,這樣就可以讓監(jiān)控系統(tǒng)更好的工作,正確的識(shí)別出系統(tǒng)的一些未知的錯(cuò)誤信息,錯(cuò)誤的告警,讓告警系統(tǒng)更加的靈敏,也避免了業(yè)務(wù)邏輯的異常干擾告警系統(tǒng)
接下來看一下第三種,通過異常過濾器的方式
這種方式實(shí)際上是作用在 MVC 的整個(gè)框架的體系下面的,它并不是在中間件的最早期發(fā)生作用的,它是在 MVC 的整個(gè)生命周期里面發(fā)生作用,也就是說它只能工作在 MVC Web API 的請(qǐng)求周期里面
首先自定義一個(gè) MyExceptionFilter
namespace ExceptionDemo.Exceptions {public class MyExceptionFilter : IExceptionFilter{public void OnException(ExceptionContext context){IKnownException knownException = context.Exception as IKnownException;if (knownException == null){var logger = context.HttpContext.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();logger.LogError(context.Exception, context.Exception.Message);knownException = KnownException.Unknown;context.HttpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;}else{knownException = KnownException.FromKnownException(knownException);context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;}context.Result = new JsonResult(knownException){ContentType = "application/json; charset=utf-8"};}} }處理邏輯與之前的相同
接著注冊(cè) Filters
services.AddMvc(mvcOptions => {mvcOptions.Filters.Add<MyExceptionFilter>(); }).AddJsonOptions(jsonoptions => {jsonoptions.JsonSerializerOptions.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping; });啟動(dòng)程序,輸出如下:
{"message":"未知錯(cuò)誤","errorCode":9999,"errorData":null}輸出與之前的一致,因?yàn)檫@是在 Controller 里面輸出了錯(cuò)誤
如果在 MVC 的中間件之前輸出錯(cuò)誤的話,它是沒辦法處理的
這個(gè)場(chǎng)景一般情況下是指需要對(duì) Controller 進(jìn)行特殊的異常處理,而對(duì)于中間件整體來講的話,又要用另一種特殊的邏輯來處理的時(shí)候,可以用 ExceptionFilter 的方式處理
這種方式還可以通過 Attribute 的方式
自定義一個(gè) MyExceptionFilterAttribute
namespace ExceptionDemo.Exceptions {public class MyExceptionFilterAttribute : ExceptionFilterAttribute{public override void OnException(ExceptionContext context){IKnownException knownException = context.Exception as IKnownException;if (knownException == null){var logger = context.HttpContext.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();logger.LogError(context.Exception, context.Exception.Message);knownException = KnownException.Unknown;context.HttpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;}else{knownException = KnownException.FromKnownException(knownException);context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;}context.Result = new JsonResult(knownException){ContentType = "application/json; charset=utf-8"};}} }在 Controller 上面標(biāo)注 MyExceptionFilter
[MyExceptionFilter] public class WeatherForecastController : ControllerBase啟動(dòng)運(yùn)行之后效果相同
這兩種方式的效果是對(duì)等的,區(qū)別在于說可以更細(xì)粒度的對(duì)異常處理進(jìn)行控制,可以指定部分的 Controller 或者 Exception,來決定我們的異常處理,也可以在全局注冊(cè) ExceptionFilter
當(dāng)然因?yàn)?ExceptionFilterAttribute 也實(shí)現(xiàn)了 IExceptionFilter,所以它也可以注冊(cè)到全局,也可以把它當(dāng)作全局異常處理的過濾器來使用,Controller 上面也就不需要標(biāo)記了
注冊(cè) Filters
services.AddMvc(mvcOptions => {//mvcOptions.Filters.Add<MyExceptionFilter>();mvcOptions.Filters.Add<MyExceptionFilterAttribute>(); }).AddJsonOptions(jsonoptions => {jsonoptions.JsonSerializerOptions.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping; });在 Controller 上面取消標(biāo)注 MyExceptionFilter
//[MyExceptionFilter] public class WeatherForecastController : ControllerBase啟動(dòng)程序,輸出結(jié)果一致
這個(gè)場(chǎng)景對(duì)于我們定義一些 API,然后對(duì) API 進(jìn)行定義我們的異常處理的約定是很有幫助的
總結(jié)一下
首先我們需要定義特定的異常類或者接口,我們可以定義抽象類,也可以用接口的方式,例子中是通過接口的方式表示業(yè)務(wù)邏輯的異常
對(duì)于業(yè)務(wù)邏輯的異常,實(shí)際上需要定義全局的錯(cuò)誤碼
對(duì)于未知的異常,應(yīng)該輸出特定的輸出信息和錯(cuò)誤碼,然后記錄完整的日志,我們不應(yīng)該把系統(tǒng)內(nèi)部的一些比如說異常堆棧這些信息輸出給用戶
對(duì)于已知的業(yè)務(wù)邏輯的異常,用 Http 200 的方式,對(duì)于未知的異常,用 Http 500 的方式,這樣可以讓監(jiān)控系統(tǒng)更好的工作
另外一個(gè)建議就是盡量記錄所有的異常的詳細(xì)信息,以供后續(xù)對(duì)日志進(jìn)行分析,也供監(jiān)控系統(tǒng)做一些特定的監(jiān)控警告
總結(jié)
以上是生活随笔為你收集整理的.NET Core开发实战(第22课:异常处理中间件:区分真异常与逻辑异常)--学习笔记(下)...的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 重新定义代理的扩展性:WebAssemb
- 下一篇: 【朝夕技术专刊】Core3.1WebAp