聊聊.NET Core处理全局异常有那些方法

简述

处理全局异常的方法有IExceptionFilter（异常处理），使用中间件异常处理，使用框架自带异常中间件等。

考点

考察对异常处理方式的熟悉程度和广度，以及对中间件、过滤器熟练程度。

下面分别具体介绍三种处理异常的方法
1、异常处理 IExceptionFilter
开发过ASP.NET程序的人都知道：IExceptionFilter。这个过滤器同样在AspNetCore中也可以用来捕获异常。不过，对于使用IExceptionFilter，更建议使用它的异步版本：IAsyncExceptionFilter。那么该如何使用过滤器呢？下面以IAsyncExceptionFilter为例，对于同步版本其实也是一样的。

我们在项目中添加一个Model文件夹，存放返回结果实体类，这里定义一个泛型类：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;namespace ExceptionDemo.Model
{public class ResultModel<T>{/// <summary>/// 返回结果编码 0：失败 1：成功/// </summary>public int ResultCode { get; set; }/// <summary>/// 返回结果内容 成功：Success  失败：异常内容/// </summary>public string ResultMsg { get; set; }/// <summary>/// 返回结果 成功：返回T类型数据 失败：默认null/// </summary>public T ResultData { get; set; }}
}

我们在项目中添加一个Filter文件夹，所有的过滤器都放在该文件夹下面。然后添加一个类：CustomerExceptionFilter，并使该类继承自IAsyncExceptionFilter。代码如下：

using ExceptionDemo.Model;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Newtonsoft.Json;
using System.Threading.Tasks;namespace ExceptionDemo.Filter
{/// <summary>/// 自定义异常过滤器/// </summary>public class CustomerExceptionFilter : IAsyncExceptionFilter{/// <summary>/// 重写OnExceptionAsync方法，定义自己的处理逻辑/// </summary>/// <param name="context"></param>/// <returns></returns>private readonly ILogger<CustomerExceptionFilter> _logger;public CustomerExceptionFilter(ILogger<CustomerExceptionFilter> logger){_logger = logger;}public Task OnExceptionAsync(ExceptionContext context){// 如果异常没有被处理则进行处理if(context.ExceptionHandled==false){// 定义返回类型var result = new ResultModel<string>{ResultCode = 0,ResultMsg = context.Exception.Message};_logger.LogInformation("502 Bad Gateway: ");context.Result = new ContentResult{// 返回状态码设置为200，表示成功StatusCode = StatusCodes.Status200OK,// 设置返回格式ContentType="application/json;charset=utf-8",Content=JsonConvert.SerializeObject(result)};}// 设置为true，表示异常已经被处理了context.ExceptionHandled = true;return Task.CompletedTask;}}
}

上面的代码很简单，我们新建了一个自定义的异常过滤器，然后在OnExceptionAsync方法中定义自己的处理逻辑，报错之后依然让http返回状态码为200，并且将错误信息返回到客户端。

然后添加一个控制器，命名为ExceptionFilter，在控制器中模拟发生异常的情况：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using ExceptionDemo.Model;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;namespace ExceptionDemo.Controllers
{[Route("api/[controller]")][ApiController]public class ExceptionFilterController : ControllerBase{[HttpGet]public async Task<ResultModel<int>> Get(){int i = 0;int k = 10;// 这里会发生异常int j = await Task.Run<int>(() => {return k / i;});return new ResultModel<int>(){ResultCode=1,ResultMsg="Success",ResultData=j};}}
}

最后我们需要把自定义的异常过滤器进行注入，这里选择使用全局注入的方式，在Startup类的ConfigureServices方法中进行注入：

builder.Services.AddLogging(logging =>
{logging.AddConsole(); // 向控制台输出日志// 你可以根据需要添加其他日志提供程序，比如文件日志、事件日志等
});
services.AddControllers(options => 
{   //因为CustomerExceptionFilter构造函数中使用了ILogger 所以必须现在前面注入AddLoggingoptions.Filters.Add<CustomerExceptionFilter>();
});

然后运行程序，查看结果：
在这里插入图片描述
如何我们没有使用过滤器捕获和处理异常，我们将得到Http状态码为500的内部错误，这种错误不方便定位问题，而且给客户端返回的信息也不够友好。使用了过滤器处理异常，进行特殊处理之后就会显得很友好了。

在上面自定义过滤器的代码中，有下面的一行代码：

context.ExceptionHandled = true;
注意：这句代码很关键，当你处理完异常之后，一定要将此属性更改为true，表示异常已经处理过了，这样其他地方就不会在处理这个异常了。
2、使用中间件处理异常
我们知道，AspNetCore的管道模型具有层层传递的特点，那么我们就可以在管道中实现全局异常捕获。我们新创建一个自定义的异常中间件：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Text.Json;
using System.Threading.Tasks;namespace ExceptionDemo.Middleware
{/// <summary>/// 自定义异常中间件/// </summary>public class CustomerExceptionMiddleware{/// <summary>/// 委托/// </summary>private readonly RequestDelegate _next;public CustomerExceptionMiddleware(RequestDelegate next){_next = next;}public async Task Invoke(HttpContext context){try{await _next(context);}catch (Exception ex){context.Response.ContentType = "application/problem+json";var title = "An error occured: " + ex.Message;var details = ex.ToString();var problem = new ProblemDetails{Status = 200,Title = title,Detail = details};var stream = context.Response.Body;await JsonSerializer.SerializeAsync(stream, problem);}}}
}

然后在新建一个扩展方法：

using Microsoft.AspNetCore.Builder;namespace ExceptionDemo.Middleware
{/// <summary>/// 静态类/// </summary>public static class ExceptionMiddlewareExtension{/// <summary>/// 静态方法/// </summary>/// <param name="app">要进行扩展的类型</param>public static void UseExceptionMiddleware(this IApplicationBuilder app){app.UseMiddleware(typeof(CustomerExceptionMiddleware));}}
}

最后在Startup类的Configure方法中使用自定义的异常中间件：

app.UseExceptionMiddleware();
然后我们注释掉上面注册的异常过滤器，运行程序进行访问：
在这里插入图片描述
这样也可以捕获到异常。
3、使用框架自带异常中间件

if (env.IsDevelopment())
{app.UseDeveloperExceptionPage();
}

这段代码在我们使用AspNetCore创建一个WebApi项目时就会看到，如果是创建的MVC项目，是下面一段代码：

if (env.IsDevelopment())
{app.UseDeveloperExceptionPage();
}
else
{app.UseExceptionHandler("/Error");
}

这两段代码的作用就是捕获和处理异常，是第一个被添加到管道中的中间件。

UseDeveloperExceptionPage的意思很好理解：对于开发模式，一旦报错就跳转到错误堆栈页面。而第二个UseExceptionHandler也很有意思，从它的名字中我们大致可以猜出它肯定是个错误拦截程序。那么它和上面自定义的异常处理中间件有什么区别呢？

UseExceptionHandler其实就是默认的错误处理。它其实也是一个中间件，它的原名叫做ExceptionHandlerMiddleware。在使用UseExceptionHandler方法时，我们可以选填各种参数。比如上面的第二段代码，填入了“/Error”参数，表示当产生异常的时候，将定位到对应的路径，这里定位的页面就是“http://localhost:5001/Error”。这是MVC中自带的一个错误页面，当然，你也可以指定自己定义的一个页面。

UseExceptionHandler还有一个指定ExceptionHandlerOptions参数的扩展方法，该参数是ExceptionHandlerMiddleware中间件的重要参数：

参数名 说明
ExceptionHandlingPath 重定向的路径，比如刚才的 “”/Error"" 实际上就是指定的该参数
ExceptionHandler 错误拦截处理程序
ExceptionHandler允许我们在ExceptionHandlerMiddleware内部指定咱们自己的异常处理逻辑。而该参数的类型为RequestDelegate类型的委托。因此，UseExceptionHandler提供了一个简便的写法，可以让我们在ExceptionHandlerMiddleware中新建自定义的错误拦截管道来处理异常：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using System.Threading.Tasks;
using ExceptionDemo.Filter;
using ExceptionDemo.Middleware;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;namespace ExceptionDemo
{public class Startup{public Startup(IConfiguration configuration){Configuration = configuration;}public IConfiguration Configuration { get; }// This method gets called by the runtime. Use this method to add services to the container.public void ConfigureServices(IServiceCollection services){#region 注册全局异常过滤器//services.AddControllers(options => //{//    options.Filters.Add(new CustomerExceptionFilter());//});#endregionservices.AddControllers();}// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.public void Configure(IApplicationBuilder app, IWebHostEnvironment env){if (env.IsDevelopment()){app.UseDeveloperExceptionPage();}else{app.UseExceptionHandler(builder => builder.Use(ExceptionHandlerDemo));}app.UseExceptionMiddleware();app.UseRouting();app.UseAuthorization();app.UseEndpoints(endpoints =>{endpoints.MapControllers();});}private async Task ExceptionHandlerDemo(HttpContext httpContext,Func<Task> next){//该信息由ExceptionHandlerMiddleware中间件提供，里面包含了ExceptionHandlerMiddleware中间件捕获到的异常信息。var exceptionDetails = httpContext.Features.Get<IExceptionHandlerFeature>();var ex = exceptionDetails?.Error;if (ex != null){httpContext.Response.ContentType = "application/problem+json";var title = "An error occured: " + ex.Message;var details = ex.ToString();var problem = new ProblemDetails{Status = 500,Title = title,Detail = details};var stream = httpContext.Response.Body;await JsonSerializer.SerializeAsync(stream, problem);}}}
}

中间件和过滤器的比较
在上面的例子中，我们分别使用了中间件和过滤器的方式来处理异常，那么中间件和过滤器有什么区别呢？两者的区别：拦截范围的不同。
IExceptionFilter作为一种过滤器，它需要在控制器发现错误之后将错误信息提交给它处理，因此它的异常处理范围是控制器内部。如果我们想捕获进入控制器之前的一些错误，IExceptionFilter是捕获不到的。而对于ExceptionHandlerMiddleware异常中间件来说就很容易了，它作为第一个中间件被添加到管道中，在它之后发生的任何异常都可以捕获的到。

那么为什么要有两种异常处理的方式呢？只使用ExceptionHandlerMiddleware中间件处理异常不可以吗？它可以捕获任何时候发生的异常，为什么还要有过滤器呢？如果你想在控制器发生异常时快速捕获和处理异常，那么使用过滤器处理异常是非常不错的选择。如果是控制器内部发生了异常，首先是由过滤器捕获到异常，最后才是中间件捕获到异常。

我们在自定义过滤器的时候有这样一段代码：context.ExceptionHandled = true;如果在自定义过滤器中将异常标记为已经处理之后，则第一个异常处理中间件就认为没有错误了，不会进入到处理逻辑中了。所以，如果不把 ExceptionHandled属性设置为true，可能出现异常处理结果被覆盖的情况。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/bicheng/4430.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Spring Cloud学习笔记（Feigh）：简介，实战简单样例

Spring Cloud学习笔记（Feigh）：简介，实战简单样例

这是本人学习的总结&#xff0c;主要学习资料如下 - 马士兵教育 1、Netflix Feign简介2、Open Feign的简单样例2.1、dependency2.2、代码样例 1、Netflix Feign简介 Netfilx Feign是用来帮助发送远程服务的&#xff0c;它让开发者觉得调用远程服务就像是调用本地方法一样&…
阅读更多...
计算机系列之进程调度、死锁、存储管理、设备管理、文件管理

计算机系列之进程调度、死锁、存储管理、设备管理、文件管理

11、进程调度-死锁-存储管理-固定分页分段 1、进程调度 进程调度方式是指当有更高优先级的进程到来时如何分配CPU。分为可剥夺和不可剥夺两种&#xff0c;可剥夺指当有更高优先级进程到来时&#xff0c;强行将正在运行进程的CPU分配给高优先级进程&#xff1b;不可剥夺是指高…
阅读更多...
分享一些常用的内外网文件传输工具

分享一些常用的内外网文件传输工具

内外网隔离后的文件传输是网络安全领域中一个常见而又重要的问题。随着信息技术的快速发展&#xff0c;网络安全问题日益凸显&#xff0c;内外网隔离成为了许多企业和组织保护内部信息安全的重要手段。然而&#xff0c;内外网隔离后如何有效地进行文件传输&#xff0c;成为了摆…
阅读更多...
专利视角下的量子竞赛：《2024全球专利格局白皮书》

专利视角下的量子竞赛：《2024全球专利格局白皮书》

2024年1月&#xff0c;欧洲量子产业联盟&#xff08;QuIC&#xff09;发布了题为《全球量子技术专利格局描述》的综合白皮书。 该文件以透明的视角展示了当今的知识产权格局&#xff0c;包括知识产权持有人的地理分布。该文件由 QuIC 知识产权&#xff08;IP&#xff09;与贸易…
阅读更多...
3DTiles特性与内容解析

3DTiles特性与内容解析

一篇19年整理的比较老的笔记了。更多精彩内容尽在数字孪生平台。 瓦片种类 3DTiles瓦片有多种类型&#xff1a; b3dm(Batched 3D Model&#xff0c;批量3D模型) b3dm瓦片存储了多个个体&#xff0c;b3dm中的glb代表的实际对象应该具有相同的种类但是可能数据内容不同。b3dm…
阅读更多...
ABAP开发：SAPscript表单设计及打印简介

ABAP开发：SAPscript表单设计及打印简介

在SAP ERP系统应用中&#xff0c;通常利用Forms表单来定制诸如发票、支票及标签之类的特殊文档的打印格式。这些Forms用来描述文档页面中的信息结构&#xff0c;比如地址抬头、item行、页脚等等&#xff0c;Forms设计就是要确定这些文档的输出格式。 利用SAPscript工具进行Form…
阅读更多...
html+css 选择器优先级

html+css 选择器优先级

1.基本选择器优先级 id>class>tagname(标签选择器)>*(通配符选择器) <!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>基本选择器的优先级</title><style type"text/css"…
阅读更多...
ShaderLab的混合命令

ShaderLab的混合命令

文章目录 示例原理混合因子混合操作参考 示例 Pass {Tags{"LightMode" "ForwardBase"}// 关闭深度写入ZWrite Off// 设置Pass的混合模式&#xff0c;SrcAlpha: 片元着色器产生的颜色的混合因子// OneMinusSrcAlpha 已经存在于颜色缓冲中的颜色的混合因子…
阅读更多...
vue实现左右两栏布局宽度可拖拽

vue实现左右两栏布局宽度可拖拽

项目里需要左右两栏布局根据内容多少可以用户自己拖拽宽度的需求 找了文章参考了下&#xff0c;但都没有实现我要的效果&#xff0c;所以结合调整了一下&#xff0c;记录一下我自己用到的效果 参考文章放下面了&#xff0c;感谢两位大佬 vue拖拽 html实现拖拽 最终效果实现…
阅读更多...
STM32 cubemx hal库huart串口接收不到第一帧数据或数据全为0的问题

STM32 cubemx hal库huart串口接收不到第一帧数据或数据全为0的问题

存在问题的stm32工程是使用cubemx搭建stm32串口dma通讯的工程. 问题是&#xff1a; 每次上电后&#xff0c;串口接收第一帧数据全部都为0&#xff0c;第二帧及以后接收的数据都是正确。 原因是&#xff1a; 以下2行代码&#xff0c;放在void HAL_UART_MspInit(UART_HandleT…
阅读更多...
easyExcel - 带图片导出

easyExcel - 带图片导出

目录 前言一、情景介绍二、问题分析三、代码实现1. 单图片导出2. 多图片导出3. 多图片导出&#xff08;优化&#xff09; 前言 Java-easyExcel入门教程&#xff1a;https://blog.csdn.net/xhmico/article/details/134714025 之前有介绍过如何使用 easyExcel&#xff0c;以及写…
阅读更多...
适用于芯片行业的开发及管理工具：版本控制、持续集成、代码分析及项目管理工具介绍

适用于芯片行业的开发及管理工具：版本控制、持续集成、代码分析及项目管理工具介绍

3月28日-29日&#xff0c;2024国际集成电路展览会暨研讨会&#xff08;IIC Shanghai&#xff09;在上海成功举行。此次盛会汇聚了集成电路产业的众多领军企业&#xff0c;共同探寻和把握集成电路产业的发展脉络。 龙智携芯片研发及管理解决方案亮相展会&#xff0c;展示如何通…
阅读更多...
什么是外汇杠杆交易?

什么是外汇杠杆交易?

外汇杠杆交易是目前的外汇交易市场中&#xff0c;投资者进行外汇交易的重要方式&#xff0c;通过这样的交易方式&#xff0c;投资者就有机会进行以小搏大的交易&#xff0c;他们的交易就有可能会更成功&#xff0c;因此&#xff0c;投资者应该对这样的交易方式进行了解&#xf…
阅读更多...
springboot 集成 activemq

springboot 集成 activemq

文章目录 一&#xff1a;说明二&#xff1a;e-car项目配置1 引入activemq依赖2 application启动类配置消息监听3 application.yml配置4 MQConfig.java 配置类5 ecar 项目中的监听6 junit 发送消息 三&#xff1a;tcm-chatgpt项目配置5 MQListener.java 监听消息 三 测试启动act…
阅读更多...
RV1126添加gc2093摄像头

RV1126添加gc2093摄像头

前言 上篇讲的是双目摄像头GC2053摄像头进行拉流&#xff0c;本篇介绍下如何适配添加RGB Sensor GC2093并且可以在windows上成功拉取视频流 平台背景 开发板&#xff1a;易百纳开发板 cpu: rv1126 sensor: gc2093 200w像素 2lanes type&#xff1a;MIPI kernel: 4.19.111 sys…
阅读更多...
K8S深度解析：从入门到精通的全方位指南

K8S深度解析：从入门到精通的全方位指南

目录 一、Kubernetes简介 二、Kubernetes的核心作用 三、Kubernetes架构图例 四、Kubernetes核心概念 Harbor仓库概述&#xff1a; Master----管理组件&#xff1a; API Server&#xff08;集群之心&#xff09;&#xff1a; Scheduler&#xff08;调度大师&…
阅读更多...
基于Transformer深度学习的翻译模型（英-＞中）源码系统

基于Transformer深度学习的翻译模型（英-＞中）源码系统

第一步&#xff1a;Transformer介绍 Transformer是一种基于注意力机制的序列到序列模型&#xff0c;它在机器翻译任务中表现出色并逐渐成为自然语言处理领域的主流模型。Transformer模型的核心思想是使用自注意力机制&#xff08;self-attention&#xff09;来捕捉输入序列中各…
阅读更多...
Redis系列：内存淘汰策略

Redis系列：内存淘汰策略

1 前言 通过前面的一些文章我们知道&#xff0c;Redis的各项能力是基于内存实现的&#xff0c;相对其他的持久化存储&#xff08;如MySQL、File等&#xff0c;数据持久化在磁盘上&#xff09;&#xff0c;性能会高很多&#xff0c;这也是高速缓存的一个优势。 但是问题来了&am…
阅读更多...
如果通过Glide 设置图片圆角

如果通过Glide 设置图片圆角

要给图片设置一个圆角,通常方法是在ImageView 标签外添加一个CardView 标签,然后设置圆角值,但是今天遇到一个问题就是 RecyclerView Item 中这样操作的话会遇到这样的一个报错: Cannot call this method while RecyclerView is computing a layout or scrolling androidx.rec…
阅读更多...
RLC防孤岛负载测试，你了解多少？

RLC防孤岛负载测试，你了解多少？

RLC防孤岛负载测试是一种用于检测并防止电力系统中出现孤岛现象的测试方法。孤岛现象是指在电网故障或停电的情况下&#xff0c;部分电网与主电网断开连接&#xff0c;形成一个独立的、不受控制的电力系统。这种情况下&#xff0c;如果不及时切断与孤岛的连接&#xff0c;可能会…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023