在 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 步骤

  1. 创建一个ASP.NET Core webapi 项目

  2. 编写自定义的异常筛选器 MyExceptionFilter,实现 IAsyncExceptionFilter 接口(注意其中的注释)

    c# 复制代码
    using Microsoft.AspNetCore.Mvc;
    using Microsoft.AspNetCore.Mvc.Filters;
    
    public class MyExceptionFilter : IAsyncExceptionFilter
    {
    	private readonly ILogger<MyExceptionFilter> logger;
    	private readonly IHostEnvironment env;
    
    	// 注入 ILogger 和 IHostEnvironment
    	// IHostEnvironment 用于判断环境类型
    	public MyExceptionFilter(
    		ILogger<MyExceptionFilter> logger,
    		IHostEnvironment env)
    	{
    		this.logger = logger;
    		this.env = env;
    	}
    
    	public Task OnExceptionAsync(ExceptionContext context)
    	{
    		Exception exception = context.Exception;
    		logger.LogError(exception, "UnhandledException occured");
    		string message;
    		if (env.IsDevelopment())
    		{
    			// 如果是开发环境,打印所有的异常堆栈信息
    			message = exception.ToString();
    		}
    		else
    		{
    			// 否则只打印简单信息
    			message = "程序中出现未处理异常";
    		}
    
    		// 设置响应报文的内容
    		ObjectResult result = new ObjectResult(new { code = 500, message = message });
    		result.StatusCode = 500;
    		context.Result = result;
    
    		// 设置context.ExceptionHandled的值为true,让ASP.NET Core不再执行默认的异常响应逻辑
    		context.ExceptionHandled = true;
    		return Task.CompletedTask;
    	}
    }
  3. 打开 Program.cs,设置全局的筛选器(注意其中的注释)

    c# 复制代码
    using Microsoft.AspNetCore.Mvc;
    
    var builder = WebApplication.CreateBuilder(args);
    
    // Add services to the container.
    
    builder.Services.AddControllers();
    // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen();
    
    // 注册自定义异常过滤器服务
    // MvcOptions是ASP.NET Core项目的主要配置对象
    // 用于向Filters注册全局的筛选器
    builder.Services.Configure<MvcOptions>(opt => { 
    	opt.Filters.Add<MyExceptionFilter>();
    });
    
    var app = builder.Build();
    
    // Configure the HTTP request pipeline.
    if (app.Environment.IsDevelopment())
    {
    	app.UseSwagger();
    	app.UseSwaggerUI();
    }
    
    app.UseHttpsRedirection();
    
    app.UseAuthorization();
    
    app.MapControllers();
    
    app.Run();
  4. 打开控制器,模拟错误进行测试

    c# 复制代码
    using Microsoft.AspNetCore.Mvc;
    
    namespace 异常筛选器.Controllers
    {
    	[ApiController]
    	[Route("[controller]")]
    	public class WeatherForecastController : ControllerBase
    	{
    		private readonly ILogger<WeatherForecastController> _logger;
    
    		public WeatherForecastController(ILogger<WeatherForecastController> logger)
    		{
    			_logger = logger;
    		}
    
    		[HttpGet(Name = "GetWeatherForecast")]
    		public string Get()
    		{
    			throw new Exception("xxx");
    		}
    	}
    }
相关推荐
芯片智造8 小时前
氢脆对NiFe镀层有什么影响?除氢工艺怎么做?
经验分享
大胖爱学习_MJ8 小时前
Agent 如何安全地拿数据库密码?基于 HashiCorp Vault 的动态凭证下发
经验分享·python
老花眼猫11 小时前
C语言绘图方法:(14)长方体旋转
c语言·经验分享·青少年编程·课程设计
数字生命卡兹克14 小时前
深度实测GPT-6.2 Astra,OpenAI在偏科的道路上越走越远了。
经验分享
德思特1 天前
德思特测试Q&A | 多通道射频测试,如何实现高效分配与自动化调度?
经验分享·多通道射频测试
爱分享的康康1 天前
高斯泼溅(3DGS)在 ADAS 仿真中的工程瓶颈与量产落地思路
经验分享
网安小学生(兼顾数据库版)1 天前
艾体宝Mend接入CI/CD:如何实现开发流水线的安全左移?
经验分享·艾体宝·艾体宝it·艾体宝mend
狮子座的男孩1 天前
html+css基础:31、响应式布局(媒体类型,媒体特性,运算符,常用阈值)
前端·css·经验分享·html·响应式布局·媒体类型/特性·常用阈值
狮子座的男孩1 天前
html+css基础:32、BFC(父子元素防止 margin 塌陷,父子元素清除浮动,兄弟元素两栏布局)
前端·css·经验分享·html·bfc·margin塌陷·清除浮动
zdr尽职尽责2 天前
UnityCli 兼容2022版本
ui·unity·ai·c#·游戏引擎