asp.net core 自定義異常處理中介軟體
阿新 • • 發佈：2019-07-03
asp.net core 自定義異常處理中介軟體
Intro
在 asp.net core 中全域性異常處理，有時候可能不能滿足我們的需要，可能就需要自己自定義一箇中間件處理了，最近遇到一個問題，有一些異常，不希望記錄錯誤日誌，目前主要是使用者請求取消導致的 TaskCanceledException 和 OperationCanceledException 異常。因為我的 ERROR 級別的日誌會輸出到 Sentry，sentry的異常會自動發郵件提醒，如果是一些沒必要的錯誤，自然不需要記錄錯誤日誌，於是就想自定義一個異常處理中介軟體，自己處理異常，不將異常處理直接交給 asp.net core 的異常處理。
請求取消
請求取消導致的異常：
asp.net core 引入了 HttpContext.RequestAborted 來監聽使用者取消請求（實際測試下來，並不是每次都會觸發，還沒搞清楚怎麼100%的觸發），你可以使用 HttpContext.RequestAborted 來在使用者取消請求的時候中斷後臺邏輯的處理，避免處理一些不必要的業務，下面給出一個使用示例，示例原始碼
，更多詳細資訊可以參考 聖傑的這篇 中斷請求瞭解一下
[HttpGet] public async Task<IActionResult> GetAsync(string keyword, int pageNumber = 1, int pageSize = 10) { Expression<Func<Notice, bool>> predict = n => true; if (!string.IsNullOrWhiteSpace(keyword)) { predict = predict.And(n => n.NoticeTitle.Contains(keyword)); } var result = await _repository.GetPagedListResultAsync(x => new { x.NoticeTitle, x.NoticeVisitCount, x.NoticeCustomPath, x.NoticePublisher, x.NoticePublishTime, x.NoticeImagePath }, queryBuilder => queryBuilder .WithPredict(predict) .WithOrderBy(q => q.OrderByDescending(_ => _.NoticePublishTime)) , pageNumber, pageSize, HttpContext.RequestAborted); // 直接使用 HttpContext.RequestAborted return Ok(result); } // 在 Action 方法中宣告 CancellationToken，asp.net core 會自動將 `HttpContext.RequestAborted` 繫結到 CancellationToken 物件 [HttpGet] public async Task<IActionResult> GetAsync(CancellationToken cancellationToken) { var result = await _repository.GetResultAsync(p => new { p.PlaceName, p.PlaceIndex, p.PlaceId, p.MaxReservationPeriodNum }, builder => builder .WithPredict(x => x.IsActive) .WithOrderBy(x => x.OrderBy(_ => _.PlaceIndex).ThenBy(_ => _.UpdateTime)), cancellationToken); return Ok(result); }
異常處理中介軟體
異常處理中介軟體原始碼：
public class CustomExceptionHandlerMiddleware { private readonly RequestDelegate _next; private readonly CustomExceptionHandlerOptions _options; public CustomExceptionHandlerMiddleware(RequestDelegate next, IOptions<CustomExceptionHandlerOptions> options) { _next = next; _options = options.Value; } public async Task InvokeAsync(HttpContext context) { try { await _next(context); } catch (System.Exception ex) { var logger = context.RequestServices.GetRequiredService<ILoggerFactory>() .CreateLogger<CustomExceptionHandlerMiddleware>(); if (context.RequestAborted.IsCancellationRequested && (ex is TaskCanceledException || ex is OperationCanceledException)) { _options.OnRequestAborted?.Invoke(context, logger); } else { _options.OnException?.Invoke(context, logger, ex); } } } } public class CustomExceptionHandlerOptions { public Func<HttpContext, ILogger, Exception, Task> OnException { get; set; } = async (context, logger, exception) => logger.LogError(exception, $"Request exception, requestId: {context.TraceIdentifier}"); public Func<HttpContext, ILogger, Task> OnRequestAborted { get; set; } = async (context, logger) => logger.LogInformation($"Request aborted, requestId: {context.TraceIdentifier}"); }
可以通過配置 CustomExceptionHandlerOptions 來實現自定義的異常處理邏輯，預設請求取消會記錄一條 Information 級別的日誌，其他異常則會記錄一條 Error 級別的錯誤日誌
你可以通過下面的示例來配置遇到請求取消異常的時候什麼都不做
service.Config(options=>
{
options.OnRequestAborted = (context, logger) => Task.CompletedTask;
});Reference
- https://www.jianshu.com/p/9988f2a27f8d
- https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation.API/ReservationPlaceController.cs