在 ASP.NET Core Web API 中使用异常筛选器捕获和统一处理异常

平安中华日

前言

在 ASP.NET Core Web API 中，异常筛选器（Exception Filter）是一种用于处理发生在 Web API 控制器或管道中的异常的机制。
异常筛选器可以捕获和处理应用程序中发生的异常，当系统中出现未经处理的异常的时候，异常筛选器就会执行，我们可以在异常筛选器中对异常进行处理，例如记录日志、返回自定义错误信息等。
需要注意的是，只有 ASP.NET Core 线程中的未处理异常才会被异常筛选器处理。
本文主要通过一个实例来讲述在 ASP.NET Core Web API 中如何使用异常筛选器。
Step By Step 步骤

• 创建一个ASP.NET Core webapi 项目
  
• 编写自定义的异常筛选器 MyExceptionFilter，实现 IAsyncExceptionFilter 接口（注意其中的注释）
  1. using Microsoft.AspNetCore.Mvc;
  2. using Microsoft.AspNetCore.Mvc.Filters;
  4. public class MyExceptionFilter : IAsyncExceptionFilter
  5. {
  6.         private readonly ILogger<MyExceptionFilter> logger;
  7.         private readonly IHostEnvironment env;
  9.         // 注入 ILogger 和 IHostEnvironment
  10.         // IHostEnvironment 用于判断环境类型
  11.         public MyExceptionFilter(
  12.                 ILogger<MyExceptionFilter> logger,
  13.                 IHostEnvironment env)
  14.         {
  15.                 this.logger = logger;
  16.                 this.env = env;
  17.         }
  19.         public Task OnExceptionAsync(ExceptionContext context)
  20.         {
  21.                 Exception exception = context.Exception;
  22.                 logger.LogError(exception, "UnhandledException occured");
  23.                 string message;
  24.                 if (env.IsDevelopment())
  25.                 {
  26.                         // 如果是开发环境，打印所有的异常堆栈信息
  27.                         message = exception.ToString();
  28.                 }
  29.                 else
  30.                 {
  31.                         // 否则只打印简单信息
  32.                         message = "程序中出现未处理异常";
  33.                 }
  35.                 // 设置响应报文的内容
  36.                 ObjectResult result = new ObjectResult(new { code = 500, message = message });
  37.                 result.StatusCode = 500;
  38.                 context.Result = result;
  40.                 // 设置context.ExceptionHandled的值为true，让ASP.NET Core不再执行默认的异常响应逻辑
  41.                 context.ExceptionHandled = true;
  42.                 return Task.CompletedTask;
  43.         }
  44. }

  复制代码
• 打开 Program.cs，设置全局的筛选器（注意其中的注释）
  1. using Microsoft.AspNetCore.Mvc;
  3. var builder = WebApplication.CreateBuilder(args);
  5. // Add services to the container.
  7. builder.Services.AddControllers();
  8. // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
  9. builder.Services.AddEndpointsApiExplorer();
  10. builder.Services.AddSwaggerGen();
  12. // 注册自定义异常过滤器服务
  13. // MvcOptions是ASP.NET Core项目的主要配置对象
  14. // 用于向Filters注册全局的筛选器
  15. builder.Services.Configure<MvcOptions>(opt => {
  16.         opt.Filters.Add<MyExceptionFilter>();
  17. });
  19. var app = builder.Build();
  21. // Configure the HTTP request pipeline.
  22. if (app.Environment.IsDevelopment())
  23. {
  24.         app.UseSwagger();
  25.         app.UseSwaggerUI();
  26. }
  28. app.UseHttpsRedirection();
  30. app.UseAuthorization();
  32. app.MapControllers();
  34. app.Run();

  复制代码
• 打开控制器，模拟错误进行测试
  1. using Microsoft.AspNetCore.Mvc;
  3. namespace 异常筛选器.Controllers
  4. {
  5.         [ApiController]
  6.         [Route("[controller]")]
  7.         public class WeatherForecastController : ControllerBase
  8.         {
  9.                 private readonly ILogger<WeatherForecastController> _logger;
  11.                 public WeatherForecastController(ILogger<WeatherForecastController> logger)
  12.                 {
  13.                         _logger = logger;
  14.                 }
  16.                 [HttpGet(Name = "GetWeatherForecast")]
  17.                 public string Get()
  18.                 {
  19.                         throw new Exception("xxx");
  20.                 }
  21.         }
  22. }

  复制代码

我是老杨，一个执着于编程乐趣、至今奋斗在一线的 10年+ 资深研发老鸟，是软件项目管理师，也是快乐的程序猿，持续免费分享全栈实用编程技巧、项目管理经验和职场成长心得！欢迎关注老杨的公众号（名称：代码掌控者），和你共同探索代码世界的奥秘！

来源:https://www.cnblogs.com/JackyGz/p/18422993
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！