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

news2024/12/29 8:57:16

简述

处理全局异常的方法有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 所以必须现在前面注入AddLogging
  options.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());
            //});
            #endregion

            services.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.coloradmin.cn/o/1621975.html

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

相关文章

k-均值聚类

k-均值聚类

K均值聚类&#xff08;K-means clustering&#xff09;是一种常用的无监督学习方法&#xff0c;用于将一组数据点划分为K个簇&#xff08;cluster&#xff09;。 它的目标是将相似的数据点归到同一个簇中&#xff0c;同时使得不同簇之间的数据点尽可能不相似。K均值聚类算法的…
阅读更多...
Golang | Leetcode Golang题解之第47题全排列II

Golang | Leetcode Golang题解之第47题全排列II

题目&#xff1a; 题解&#xff1a; func permuteUnique(nums []int) (ans [][]int) {sort.Ints(nums)n : len(nums)perm : []int{}vis : make([]bool, n)var backtrack func(int)backtrack func(idx int) {if idx n {ans append(ans, append([]int(nil), perm...))return}…
阅读更多...
有效三角形的个数 ---- 双指针

有效三角形的个数 ---- 双指针

题目链接 题目: 分析: 这道题的意思就是将数组的元素, 拿出三个数, 能构成三角形就是有效的判断是否能构成三角形的条件: 两边之和大于第三边, 我们只需找到三个数中最小的两个数之和是否大于第三边, 大于则可以构成三角形解法一: 暴力解法, 即找到所有的三元组, 并挨个判断,…
阅读更多...
「 网络安全常用术语解读 」SBOM主流格式SPDX详解

「 网络安全常用术语解读 」SBOM主流格式SPDX详解

SPDX&#xff08;System Package Data Exchange&#xff09;格式是一种用于描述软件组件&#xff08;如源代码&#xff09;的规范&#xff0c;它提供了一种标准化的方法来描述软件组件的元数据&#xff0c;包括其许可证、依赖项和其他属性。SPDX最初由Linux基金会于2010年发起&…
阅读更多...
vue 实现左侧导航栏，右侧锚点定位滚动到指定位置（超简单方法）

vue 实现左侧导航栏，右侧锚点定位滚动到指定位置（超简单方法）

项目截图&#xff1a; 实现方法&#xff1a; 点击左侧菜单根据元素id定位到可视内容区域。 浏览器原生提供了一种方法scrollIntoView 。 通过scrollIntoView方法可以把元素滚动到可视区域内。 behavior: "smooth"是指定滚动方式为平滑效果。 具体代码如下&#xf…
阅读更多...
linux安装MySQL8.0，密码修改权限配置等常规操作详解

linux安装MySQL8.0，密码修改权限配置等常规操作详解

✨✨ 欢迎大家来到景天科技苑✨✨ &#x1f388;&#x1f388; 养成好习惯&#xff0c;先赞后看哦~&#x1f388;&#x1f388; &#x1f3c6; 作者简介&#xff1a;景天科技苑 &#x1f3c6;《头衔》&#xff1a;大厂架构师&#xff0c;华为云开发者社区专家博主&#xff0c;…
阅读更多...
【一刷剑指Offer】面试题 8：旋转数组的最小数字

【一刷剑指Offer】面试题 8：旋转数组的最小数字

力扣对应题目链接&#xff1a;154. 寻找旋转排序数组中的最小值 II - 力扣&#xff08;LeetCode&#xff09; 牛客对应题目链接&#xff1a; 旋转数组的最小数字_牛客题霸_牛客网 (nowcoder.com) 核心考点 &#xff1a;数组理解&#xff0c;二分查找&#xff0c;临界条件。 一…
阅读更多...
Ajax和axios基础

Ajax和axios基础

AJAX Asynchronous JavaScript And XML 异步的JavaScript和XML 作用 数据交换: 通过Ajax可以给服务器发送请求,服务器将数据直接响应回给浏览器. 异步交互: 可以在不重新加载整个页面的情况下,与服务器交换数据并更新部分网页的技术. 同步和异步 同步发送请求: 浏览器发…
阅读更多...
基于单片机的羽毛球计分器（含proteus仿真和程序）

基于单片机的羽毛球计分器（含proteus仿真和程序）

目录 完整文本及仿真、程序可私信我获取 前言 第一章 设计任务及方案 1.1 设计任务 1.2 总体设计分析 1.3 功能模块方案设计 1.4 方案确定 第二章、硬件设计 2.1 AT89C51 单片机芯片介绍 2.1.1 主要特性 2.1.2 管脚说明 2.1.3 元件清单 2.2 电路介绍 2…
阅读更多...
黑马微服务课程2

黑马微服务课程2

课程地址&#xff1a;2024最新SpringCloud微服务开发与实战&#xff0c;java黑马商城项目微服务实战开发&#xff08;涵盖MybatisPlus、Docker、MQ、ES、Redis高级等&#xff09;_哔哩哔哩_bilibili 课程名称&#xff1a;2024最新SpringCloud微服务开发与实战&#xff0c;java…
阅读更多...
《数据密集型应用系统设计》笔记——第一部分 数据系统基础（ch1-4）

《数据密集型应用系统设计》笔记——第一部分 数据系统基础（ch1-4）

写在前面&#xff1a;对DDIA这本书慕名已久&#xff0c;粗看书里的一些知识都或多或少了解&#xff0c;但仔细阅读下来&#xff0c;还是缺少对细节的认识。目前看了四个章节&#xff0c;这本书一直在围绕两个问题&#xff1a;是什么和为什么&#xff0c;来做阐述&#xff0c;针…
阅读更多...
AI大模型探索之路-训练篇3：大语言模型全景解读

AI大模型探索之路-训练篇3：大语言模型全景解读

文章目录 前言一、语言模型发展历程1. 第一阶段&#xff1a;统计语言模型&#xff08;Statistical Language Model, SLM&#xff09;2. 第二阶段&#xff1a;神经语言模型&#xff08;Neural Language Model, NLM&#xff09;3. 第三阶段&#xff1a;预训练语言模型&#xff08…
阅读更多...
【高阶数据结构】B树 {B树的概念；B树的实现：节点设计，查找，插入，遍历，删除；B树的性能分析；B+树和B*树；B树的应用}

【高阶数据结构】B树 {B树的概念；B树的实现：节点设计，查找，插入，遍历，删除；B树的性能分析；B+树和B*树；B树的应用}

一、常见的搜索结构 以上结构适合用于数据量相对不是很大&#xff0c;能够一次性存放在内存中&#xff0c;进行数据查找的场景。如果数据量很大&#xff0c;比如有100G数据&#xff0c;无法一次放进内存中&#xff0c;那就只能放在磁盘上了&#xff0c;如果放在磁盘上&#xff…
阅读更多...
Maven多模块快速升级超好用Idea插件-MPVP

Maven多模块快速升级超好用Idea插件-MPVP

功能&#xff1a;多模块maven项目快速升级指定版本插件&#xff0c;并提供预览和相关升级模块日志能力。 可快速进行版本升级&#xff0c;进行部署到Maven仓库。 安装&#xff1a; 可在idea插件中心进行安装 / 下载资源拖动安装 MPVP(Maven) - IntelliJ IDEs Plugin | Marke…
阅读更多...
IPv4 NAT（含Cisco配置）

IPv4 NAT（含Cisco配置）

IPv4 NAT&#xff08;含Cisco配置&#xff09; IPv4私有空间地址 类RFC 1918 内部地址范围前缀A10.0.0.0 - 10.255.255.25510.0.0.0/8B172.16.0.0 - 172.31.255.255172.16.0.0/12C192.168.0.0 - 192.168.255.255192.168.0.0/16 这些私有地址可在企业或站点内使用&#xff0c…
阅读更多...
【第35天】SQL进阶-SQL高级技巧-透视表（SQL 小虚竹)

【第35天】SQL进阶-SQL高级技巧-透视表（SQL 小虚竹)

回城传送–》《100天精通MYSQL从入门到就业》 文章目录 零、前言一、练习题目二、SQL思路初始化数据什么是透视表实战体验 三、总结四、参考 零、前言 今天是学习 SQL 打卡的第 35 天。 ​ 我的学习策略很简单&#xff0c;题海策略 费曼学习法。如果能把这些题都认认真真自己…
阅读更多...
网络安全-Diffie Hellman密钥协商

网络安全-Diffie Hellman密钥协商

密钥协商是保密通信双方&#xff08;或更多方&#xff09;通过公开信道来共同形成密钥的过程。一个密钥协商方案中&#xff0c;密钥的值是某个函数值&#xff0c;其输入量由两个成员&#xff08;或更多方&#xff09;来提供。密钥协商的记过是参与协商的双方&#xff08;或更多…
阅读更多...
消息服务应用1——java项目使用websocket

消息服务应用1——java项目使用websocket

在当前微服务项目中&#xff0c;由于业务模块众多&#xff0c;消息服务的使用场景变得异常活跃。而WebSocket由于其自身的可靠性强&#xff0c;实时性好&#xff0c;带宽占用更小的优势&#xff0c;在实时通讯应用场景中独占鳌头&#xff0c;加上HTML5标准的普及流行&#xff0…
阅读更多...
MultiHeadAttention在Tensorflow中的实现原理

MultiHeadAttention在Tensorflow中的实现原理

前言 通过这篇文章&#xff0c;你可以学习到Tensorflow实现MultiHeadAttention的底层原理。 一、MultiHeadAttention的本质内涵 1.Self_Atention机制 MultiHeadAttention是Self_Atention的多头堆嵌&#xff0c;有必要对Self_Atention机制进行一次深入浅出的理解&#xff0c;这…
阅读更多...
Docker 入门篇（一）-- 简介与安装教程（Windows和Linux）

Docker 入门篇（一）-- 简介与安装教程（Windows和Linux）

一、Docker简介 Docker是一个开源的应用容器引擎&#xff0c;让开发者可以打包他们的应用以及依赖包到一个可移植的容器中&#xff0c;然后发布到任何Linux机器上&#xff0c;也可以实现虚拟化。容器是完全使用沙箱机制&#xff0c;相互之间没有任何接口&#xff08;类似iPhon…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023