asp.net core 自定义异常处理中间件

原文:asp.net core 自定义异常处理中间件

asp.net core 自定义异常处理中间件

Intro

在 asp.net core 中全局异常处理,有时候可能不能满足我们的需要,可能就需要自己自定义一个中间件处理了,最近遇到一个问题,有一些异常,不希望记录错误日志,目前主要是用户请求取消导致的 TaskCanceledExceptionOperationCanceledException 异常。因为我的 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.Configure(options=>
{
    options.OnRequestAborted = (context, logger) => Task.CompletedTask;
});

Reference

原文地址:https://www.cnblogs.com/lonelyxmas/p/11386795.html

时间: 2024-10-09 13:13:10

asp.net core 自定义异常处理中间件的相关文章

asp.net core 系列 15 中间件

原文:asp.net core 系列 15 中间件 一.概述 中间件(也叫中间件组件)是一种装配到应用管道以处理请求和响应的软件. 每个组件:(1)选择是否将请求传递到管道中的下一个组件;(2)可以在管道中的下一个组件之前和之后执行工作. 请求委托用于生成请求管道. 请求委托会处理每个 HTTP 请求.使用以下方法配置请求委托:Run,  Map, Use扩展方法.可以将单个请求委托作为匿名方法(称为内联中间件in-line middleware) 或者可以在可重用类中定义.这些可重用的类和内联

asp.net core 自定义认证方式--请求头认证

原文:asp.net core 自定义认证方式--请求头认证 asp.net core 自定义认证方式--请求头认证 Intro 最近开始真正的实践了一些网关的东西,最近写几篇文章分享一下我的实践以及遇到的问题. 本文主要介绍网关后面的服务如何进行认证. 解决思路 网关可以做一部分的认证和授权,服务内部有时候也会需要用户的信息,这时该怎么办呢,我们使用的是 JWT 认证,有一个 identity server去颁发,验证 token,一种简单方式可以把 token 直接往后传,传递给后面的具体某

ASP.NET Core 中的中间件

ASP.NET Core 中的中间件(Middleware) 在这个节中,我们将了解,ASP.NET Core 中的中间件是 什么?中间件很重要,尤其是在你想当架构师这一条路上. ASP.NET Core 中的中间件是 什么? 在 ASP.NET Core 中,中间件(Middleware)是一个可以处理 HTTP 请求或响应的软件管道. ASP.NET Core 中给中间件组件的定位是具有非常特定的用途.例如,我们可能有需要一个中间件组件验证用户,另一个中间件来处理错误,另一个中间件来提供静态

[Asp.net core]自定义中间件

我们知道在asp.net中每次请求,都要经过请求管道,依次触发管道中的一系列事件.那么我们可以这么理解,中间件是请求管道中的一个组件,可以用来拦截请求,以方便我们进行请求和响应处理,中间件可以定义多个,每一个中间件都可以对管道中的请求进行拦截,它可以决定是否将请求转移给下一个中间件. 中间件如何工作? 默认情况下,中间件的执行顺序根据Startup.cs文件中,在public void Configure(IApplicationBuilder app){} 方法中注册的先后顺序执行.大概有3种

ASP.NET Core 自定义视图路径及主题切换

原文地址:https://www.cnblogs.com/ElderJames/p/Customized-View-Path-And-Theme-Switching-In-AspNetCore.html <ASP.NET Core 中的SEO优化(1):中间件实现服务端静态化缓存> <ASP.NET Core 中的SEO优化(2):中间件中渲染Razor视图> <ASP.NET Core 中的SEO优化(3):自定义路由匹配和生成> 0|1背景 切换主题,是博客.CMS

在Asp.Net Core中使用中间件保护非公开文件

在企业开发中,我们经常会遇到由用户上传文件的场景,比如某OA系统中,由用户填写某表单并上传身份证,由身份管理员审查,超级管理员可以查看. 就这样一个场景,用户上传的文件只能有三种人看得见(能够访问) 上传文件的人 身份审查人员 超级管理员 那么,这篇博客中我们将一起学习如何设计并实现一款文件授权中间件 问题分析 如何判断文件属于谁 要想文件能够被授权,文件的命名就要有规律,我们可以从文件命名中确定文件是属于谁的,例如本文例可以设计文件名为这样 工号-GUID-[Front/Back] 例如: 1

ASP.NET MVC自定义异常处理

1.自定义异常处理过滤器类文件 新建MyExceptionAttribute.cs异常处理类文件 MyExceptionAttribute.cs代码如下: using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; namespace WebApp.Models { public class MyExceptionAttribute : Han

asp.net core 自定义中间件和service

首先新建项目看下main方法: public static void Main(string[] args) { var host = new WebHostBuilder() .UseKestrel() .UseContentRoot(Directory.GetCurrentDirectory()) .UseIISIntegration() .UseStartup<Startup>() .Build(); host.Run(); } main方法 其中,UseStartup<Start

Asp.Net Core 通过自定义中间件防止图片盗链的实例(转)

一.原理 要实现防盗链,我们就必须先理解盗链的实现原理,提到防盗链的实现原理就不得不从HTTP协议说起,在HTTP协议中,有一个表头字段叫referer,采用URL的格式来表示从哪儿链接到当前的网页或文件.换句话说,通过referer,网站可以检测目标网页访问的来源网页,如果是资源文件,则可以跟踪到显示它的网页地址.有了referer跟踪来源就好办了,这时就可以通过技术手段来进行处理,一旦检测到来源不是本站即进行阻止或者返回指定的页面.如果想对自己的网站进行防盗链保护,则需要针对不同的情况进行区