asp.net core 自定义异常处理中间件
2019-07-03 19:40
1521 查看
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
相关文章推荐
- ASP.NET Core应用错误处理之DeveloperExceptionPageMiddleware中间件呈现“开发者异常页面”
- ASP.NET CORE 学习之自定义异常处理
- ASP.NET CORE学习教程之自定义异常处理详解
- ASP.NET Core应用的错误处理[2]:DeveloperExceptionPageMiddleware中间件如何呈现“开发者异常页面”
- asp.net core 自定义中间件和service
- ASP.NET Core应用错误处理之ExceptionHandlerMiddleware中间件呈现“定制化错误页面”
- Asp.net Web Applicatoin实现自定义HttpModule拦截异常处理
- Asp.Net Core 通过自定义中间件防止图片盗链的实例(转)
- ASP.NET Core 1.0 静态文件、路由、自定义中间件、身份验证简介
- 【ASP.NET Core】处理异常
- 如何在ASP.NET Core自定义中间件中读取Request.Body和Response.Body的内容?
- 学习ASP.NET Core, 怎能不了解请求处理管道[5]: 中间件注册可以除了可以使用Startup之外,还可以选择StartupFilter
- ASP.NET Core应用针对静态文件请求的处理[5]: DefaultFilesMiddleware中间件如何显示默认页面
- [Asp.net core]自定义中间件
- 七天学会ASP.NET MVC (六)——线程问题、异常处理、自定义URL
- ASP.NET Core 1.1 静态文件、路由、自定义中间件、身份验证简介
- ASP.NET AJAX入门系列:自定义异常处理 (转)
- 七天学会ASP.NET MVC (六)——线程问题、异常处理、自定义URL
- ASP.NET Core应用的错误处理[4]:StatusCodePagesMiddleware中间件如何针对响应码呈现错误页面
- ASP.NET Core 1.0 静态文件、路由、自定义中间件、身份验证简介