当前位置: 首页 > news >正文

Asp.Net Core 异常筛选器ExceptionFilter

文章目录

  • 前言
  • 一、异常筛选器的核心概念
    • 用途:
    • 实现接口:
    • 执行时机:
  • 二、使用步骤
    • 1.创建自定义异常筛选器
    • 2.注册异常筛选器
      • 全局注册(对所有 Controller 生效):
      • 局部注册(通过特性标记特定的 **Controller** 或 **Action**):
  • 三、异常筛选器与中间件异常处理的区别
  • 四、高级用法
  • 五、注意事项
  • 总结


前言

在 ASP.NET Core 中,异常筛选器(Exception Filters) 是 MVC 框架提供的一种机制,用于集中处理控制器(Controller)或 Action 方法中抛出的异常。它们允许你在异常发生时拦截并自定义处理逻辑,例如记录日志、返回特定格式的错误响应或执行恢复操作。


一、异常筛选器的核心概念

用途:

  1. 统一异常处理逻辑,避免重复的 try-catch 块。
  2. 根据异常类型返回不同的 HTTP 响应。
  3. 记录异常日志或触发监控告警。

实现接口:

  1. 同步筛选器:IExceptionFilter
  2. 异步筛选器:IAsyncExceptionFilter

执行时机:

  1. 控制器Action 方法抛出未处理的异常时触发。
  2. 不处理中间件或路由之外的异常(如身份验证中间件的异常需通过中间件处理)。

二、使用步骤

1.创建自定义异常筛选器

  1. 通过实现 IExceptionFilterIAsyncExceptionFilter 接口创建自定义筛选器::
    public class MyExceptionFilter : IAsyncExceptionFilter
    {private readonly IWebHostEnvironment hostEnv;public MyExceptionFilter(IWebHostEnvironment hostEnv){this.hostEnv = hostEnv;}public Task OnExceptionAsync(ExceptionContext context){string msg;if (hostEnv.IsDevelopment()){msg=context.Exception.ToString();}else{msg = "服务器端发生异常未处理。";}ObjectResult objectResult = new ObjectResult(new{Code = 500,Message = msg}){StatusCode = StatusCodes.Status500InternalServerError};//ObjectResult objectResult = new ObjectResult(new ProblemDetails//{//    Title = "服务器异常",//    Status = StatusCodes.Status500InternalServerError,//    Detail = msg//});context.Result = objectResult;context.ExceptionHandled = true;return Task.FromResult(objectResult);//return Task.CompletedTask;}
    }
    

2.注册异常筛选器

全局注册(对所有 Controller 生效):

  1. 在 Program.cs 中全局注册:
    //方式一:
    //builder.Services.AddControllers(opt =>
    //{
    //    opt.Filters.Add<MyExceptionFilter>();
    //    opt.Filters.Add<MyLogExceptionFilter>();
    //});
    //方式二:
    builder.Services.Configure<MvcOptions>(opt => {opt.Filters.Add<MyExceptionFilter>();opt.Filters.Add<MyLogExceptionFilter>();
    });
    

局部注册(通过特性标记特定的 ControllerAction):

  1. 在控制器或 Action 上使用 [TypeFilter] 或 [ServiceFilter]:
    [TypeFilter(typeof(MyExceptionFilter))]
    public class HomeController : Controller
    {// Action 方法
    }
    

三、异常筛选器与中间件异常处理的区别

特性异常筛选器中间件异常处理
作用范围仅处理 MVC 管道中的异常(控制器/Action)处理整个请求管道中的异常
上下文信息可访问 MVC 上下文(如 ActionContext)仅能访问 HttpContext
响应格式控制可返回 IActionResult(如 JSON/视图)需手动设置响应内容和类型
适用场景针对特定控制器或 Action 的精细化处理全局异常处理(如未捕获的中间件异常)

四、高级用法

  1. 处理特定异常类型:
    context.Result = new BadRequestObjectResult("Business rule violation.");
    
  2. 结合ProblemDetails(RFC 7807):
    context.Result = new ObjectResult(new ProblemDetails
    {Title = "Server Error",Status = StatusCodes.Status500InternalServerError,Detail = context.Exception.Message
    });

五、注意事项

  • 异常处理顺序:多个筛选器按注册顺序执行,可通过 Order 属性调整优先级。
  • 未处理的异常:若筛选器未标记 ExceptionHandled = true,异常会继续传播到中间件。
  • 性能:避免在筛选器中执行耗时操作(如数据库写入),建议异步处理。

总结

  • 通过合理使用异常筛选器,可以显著提升 ASP.NET Core 应用的健壮性和错误响应一致性。
  • 对于全局异常处理,建议结合中间件:
    UseExceptionHandlerapp.UseExceptionHandler(“/error”); (全局中间件)实现 更全面的覆盖。

相关文章:

  • 前端技术Ajax入门
  • 九、小白如何用Pygame制作一款跑酷类游戏(添加前进小动物作为动态障碍物)
  • WebUI可视化:第2章:技术基础准备
  • 阿里云基于本地知识库构建RAG应用 | 架构与场景
  • C++入侵检测与网络攻防之网络嗅探以及ARP攻击
  • 铃木一郎女儿是奥运会选手吗·棒球1号位
  • Ethan独立开发产品日报 | 2025-04-24
  • 1、RabbitMQ的概述笔记
  • 传统中台的重生——云原生如何重塑政务系统后端架构
  • 电子级甲基氯硅烷
  • [mysql]窗口函数
  • Java安全之URLDNS链分析
  • 论文阅读:2024 ACL ArtPrompt: ASCII Art-based Jailbreak Attacks against Aligned LLMs
  • 基于线性LDA算法对鸢尾花数据集进行分类
  • 【数据可视化艺术·应用篇】三维管线分析如何重构城市“生命线“管理?
  • BongoCat - 跨平台键盘猫动画工具
  • AI数据分析的利器:解锁BI工具的无限潜力
  • 大模型微调 - transformer架构
  • 全球碳化硅晶片市场深度解析:技术迭代、产业重构与未来赛道争夺战(2025-2031)
  • Linux部署ragflow,从安装docker开始~
  • 如何做大中国拳击产业的蛋糕?这项赛事给出办赛新思考
  • 云南舞蹈大家跳暨2025年牟定“三月会”昨天开幕
  • 合同约定拿850万保底利润?重庆市一中院:约定无效,发回重审
  • 唐仁健违规收受礼品、礼金被点名!十起违反中央八项规定精神典型问题被通报
  • 我国民营经济首季运行向新向好,对国民经济发展形成有力支撑
  • 2025年超长期特别国债24日首次发行