MasaFramework -- 异常处理
前言
在程序设计中,我们会遇到各种各样的异常问题,一个异常处理不仅仅可以帮助开发者快速的定位问题,也可以给用户更好的使用体验,那么我们在AspNetCore项目中如何捕获以及处理异常呢?
而对应AspNetCore程序,我们有两种异常处理方案,它们分别是:
- 异常中间件
- 异常过滤器
介绍
Masa Franework
作为一个框架,它为开发者以及用户提供更好的开发体验和使用体验的异常处理功能
Masa.Utils.Exceptions
中定义了两种异常类
UserFriendlyException
(友好异常)MasaException
(框架异常)
并提供了两种异常处理方案,那接下来就让我们看看它们是如何使用的
根据需要自行选择一种方案使用即可
快速入门
项目基于.NET 6.0创建,必须安装所必须的环境
- 安装.NET 6.0
异常中间件
基于中间件实现的全局异常处理,用于捕捉应用程序异常,并将异常信息处理后返回
- 新建ASP.NET Core 空项目
Assignment.GlobalExceptionDemo
,并安装Masa.Utils.Exceptions
dotnet new web -o Assignment.GlobalExceptionDemo
cd Assignment.GlobalExceptionDemo
dotnet add package Masa.Utils.Exceptions --version 0.6.0-rc.3 //提供全局异常过滤器
- 新建用户类
User
public class User
{
public string Name { get; set; }
public int Age { get; set; }
}
- 使用全局异常,修改
Program
//支持处理自定义异常
app.UseMasaExceptionHandler(options =>
{
//支持处理自定义异常
options.ExceptionHandler = context =>
{
if (context.Exception is ArgumentNullException ex)
{
context.ToResult($"{ex.ParamName}不能为空");
}
};
});
- 新增注册用户方法(用于自定义抛出异常)
app.MapPost("/register", (User user) =>
{
if (string.IsNullOrEmpty(user.Name))
throw new ArgumentNullException(nameof(user.Name));
//todo: Impersonate a registered user
});
更多使用技巧可查看
异常过滤器
基于MVC的全局异常过滤器,用于捕捉应用程序异常,并将异常信息处理后返回
- 新建ASP.NET Core 空项目
Assignment.GlobalFilterDemo
,并安装Masa.Utils.Exceptions
dotnet new web -o Assignment.GlobalFilterDemo
cd Assignment.GlobalFilterDemo
dotnet add package Masa.Utils.Exceptions --version 0.6.0-rc.3 //提供全局异常过滤器
- 新建用户类
User
public class User
{
public string Name { get; set; }
public int Age { get; set; }
}
- 使用全局异常过滤器,修改
Program
builder.Services
.AddMvc()
//使用MasaException
.AddMasaExceptionHandler(options =>
{
options.ExceptionHandler = context =>
{
if (context.Exception is ValidationException ex)
{
string message = ex.Errors.Select(error => error.ErrorMessage).FirstOrDefault()!;
context.ToResult(message);
}
};
});
- 新增注册用户方法,用于自定义抛出异常
[ApiController]
[Route("[Action]")]
public class UserController : ControllerBase
{
[HttpPost]
public void Register(User user)
{
if (string.IsNullOrEmpty(user.Name))
throw new ArgumentNullException(nameof(user.Name));
//todo: Impersonate a registered user
}
}
验证全局异常处理
分别启用使用异常中间件的项目以及异常过滤器的项目,用Postman或者通过Swagger分别请求两个项目的注册用户接口,其中Name
为空,可得到以下提示,则代表全局异常处理成功
进阶
不论是通过中间件还是过滤器来处理全局异常,我们都支持自定义异常处理,我们首先来看一下异常的处理流程
根据流程图可以直观的了解到,只要使用了Masa
提供的异常处理,哪怕我们不自定义异常,框架也会帮助我们按照无自定义异常流程默认处理异常信息,但如果我们希望对特定的异常做出特定的响应,那么就需要我们自定义异常
自定义异常
自定义异常支持三种方式
以中间件为例:
方案一. 通过配置ExceptionHandler
(异常处理),修改Program.cs
app.UseMasaExceptionHandler(options =>
{
options.ExceptionHandler = context =>
{
// 根据context.Exception判断异常类型,并通过context.ToResult()输出响应内容
if (context.Exception is ArgumentNullException ex)
{
context.ToResult($"{ex.ParamName}不能为空");
}
};
});
方案二. 通过自定义ExceptionHandler,并注册到服务集合
- 自定义异常处理类
ExceptionHandler
,并继承IMasaExceptionHandler
/// <summary>
/// 构造函数参数需支持从IOC获取
/// </summary>
public class ExceptionHandler : IMasaExceptionHandler
{
public void OnException(MasaExceptionContext context)
{
if (context.Exception is ArgumentNullException ex)
{
context.ToResult($"{ex.ParamName}不能为空");
}
}
}
- 使用指定的异常Handler,修改
Program.cs
builder.Services.AddSingleton<IMasaExceptionHandler, ExceptionHandler>();//注册自定义异常
var app = builder.Build();
app.UseMasaExceptionHandler();// 在Program中执行异常处理程序
方案三. 通过自定义ExceptionHandler并指定ExceptionHandler来实现
- 自定义异常处理类
ExceptionHandler
,并继承IMasaExceptionHandler
/// <summary>
/// 构造函数参数需支持从IOC获取
/// </summary>
public class ExceptionHandler : IMasaExceptionHandler
{
public void OnException(MasaExceptionContext context)
{
if (context.Exception is ArgumentNullException ex)
{
context.ToResult($"{ex.ParamName}不能为空");
}
}
}
- 使用指定的异常Handler,修改
Program.cs
app.UseMasaExceptionHandler(options => options.UseExceptionHanlder<ExceptionHandler>());//指定使用特定的异常处理程序
上述三种方案任选其一即可,提供的功能时一样的,仅仅是写法不同
修改HttpStatusCode状态码
MasaExceptionContext
默认提供了ToResult
方法支持输入响应内容,状态码(默认: 299),内容类型 (默认:text/plain; charset=utf-8),我们可以根据自己的实际情况调用传参即可
修改日志级别
异常类型为UserFriendlyException
的默认日志等级为Information
,其余异常的日志等级为Error
,那么如果我想修改对应异常的日志等级应该怎么做?
配置异常日志关系:
builder.Services.Configure<MasaExceptionLogRelationOptions>(options =>
{
options.MapLogLevel<ArgumentNullException>(LogLevel.None);
});
按照此方式,可以将类型为ArgumentNullException异常的日志等级设置为None(不记录日志)
常见问题
A: 为什么使用全局异常后没有记录日志?
Q:
- 检查是否指定了自定义异常处理的Handler,并且当前异常已经被自定义异常处理程序处理(ExceptionHandled = true)
- 检查当前异常类型是否配置了指定的日志等级,且当前日志等级小于默认记录日志的等级
A: 实现IMasaExceptionHandler
后,为什么发生异常后没有进入OnException
Q: 未注入到服务集合且没有指定使用指定的ExceptionHanlder
- 自定义异常Handler
public class ExceptionHandler : IMasaExceptionHandler
{
public void OnException(MasaExceptionContext context)
{
throw new NotImplementedException();
}
}
可参考自定义异常中的方案二或者方案三修改即可
总结
Masa提供的全局异常中间件,对自定义异常的扩展支持较好,并且后续Masa Framework
支持I18n后,全局异常也将增加I18n支持, 届时全局异常会更加方便
本章源码
Assignment13
https://github.com/zhenlei520/MasaFramework.Practice
开源地址
MASA.Framework:https://github.com/masastack/MASA.Framework
MASA.EShop:https://github.com/masalabs/MASA.EShop
MASA.Blazor:https://github.com/BlazorComponent/MASA.Blazor
如果你对我们的 MASA Framework 感兴趣,无论是代码贡献、使用、提 Issue,欢迎联系我们
MasaFramework -- 异常处理的更多相关文章
- 关于.NET异常处理的思考
年关将至,对于大部分程序员来说,马上就可以闲下来一段时间了,然而在这个闲暇的时间里,唯有争论哪门语言更好可以消磨时光,估计最近会有很多关于java与.net的博文出现,我表示要作为一个吃瓜群众,静静的 ...
- 基于spring注解AOP的异常处理
一.前言 项目刚刚开发的时候,并没有做好充足的准备.开发到一定程度的时候才会想到还有一些问题没有解决.就比如今天我要说的一个问题:异常的处理.写程序的时候一般都会通过try...catch...fin ...
- 异常处理汇总 ~ 修正果带着你的Net飞奔吧!
经验库开源地址:https://github.com/dunitian/LoTDotNet 异常处理汇总-服 务 器 http://www.cnblogs.com/dunitian/p/4522983 ...
- JavaScript var关键字、变量的状态、异常处理、命名规范等介绍
本篇主要介绍var关键字.变量的undefined和null状态.异常处理.命名规范. 目录 1. var 关键字:介绍var关键字的使用. 2. 变量的状态:介绍变量的未定义.已定义未赋值.已定义已 ...
- IL异常处理
异常处理在程序中也算是比较重要的一部分了,IL异常处理在C#里面实现会用到一些新的方法 1.BeginExceptionBlock:异常块代码开始,相当于try,但是感觉又不太像 2.EndExcep ...
- Spring MVC重定向和转发以及异常处理
SpringMVC核心技术---转发和重定向 当处理器对请求处理完毕后,向其他资源进行跳转时,有两种跳转方式:请求转发与重定向.而根据要跳转的资源类型,又可分为两类:跳转到页面与跳转到其他处理器.对于 ...
- 【repost】JS中的异常处理方法分享
我们在编写js过程中,难免会遇到一些代码错误问题,需要找出来,有些时候怕因为js问题导致用户体验差,这里给出一些解决方法 js容错语句,就是js出错也不提示错误(防止浏览器右下角有个黄色的三角符号,要 ...
- 札记:Java异常处理
异常概述 程序在运行中总会面临一些"意外"情况,良好的代码需要对它们进行预防和处理.大致来说,这些意外情况分三类: 交互输入 用户以非预期的方式使用程序,比如非法输入,不正当的操作 ...
- 关于bug分析与异常处理的一些思考
前言:工作三年了,工作内容主要是嵌入式软件开发和维护,用的语言是C,毕业后先在一家工业自动化控制公司工作两年半,目前在一家医疗仪器公司担任嵌入式软件开发工作.软件开发中,难免不产生bug:产品交付客户 ...
随机推荐
- 合并表格行---三层for循环遍历数据
合并表格行---三层for循环遍历数据 示例1 json <!DOCTYPE html> <html lang="zh_cn"> <head> ...
- 关于奇妙的 Fibonacci 的一些说明
奇妙的 Fibonacci,多次模拟赛中出现 同时也是 BZOJ 2813 一 Fibonacci 的 GCD 如果 \(F\) 是 Fibonacci 数列,那么众所周知的有 \(\gcd(F_i, ...
- Linux—系统基础一
Linux系统基础(一) Linux的基本原则: 由目的单一的小程序组成,组合小程序完成复杂任务: 一切皆文件: 配置文件保存为纯文本格式. 1.shell 1.1 shell简介 Shell俗称壳( ...
- GreatSQL季报(2021.12.26)
欢迎来到 GreatSQL社区分享的MySQL技术文章,如有疑问或想学习的内容,可以在下方评论区留言,看到后会进行解答 自从GreatSQL 8.0.25 于 2021.8.26发布以来,针对MGR的 ...
- Dolphin Scheduler 1.2.0 部署参数分析
本文章经授权转载 1 组件介绍 Apache Dolphin Scheduler是一个分布式易扩展的可视化DAG工作流任务调度系统.致力于解决数据处理流程中错综复杂的依赖关系,使调度系统在数据处理流程 ...
- 部署 Vite 静态网站到 Gitee Pages
开启仓库的 Gitee Pages 服务,部署目录 dist/: Vite 构建 build,输出到 dist 文件:取消 .gitignore 中的 dist: Vite preview 查看静态网 ...
- Unhandled Exception: MissingPluginException(No implementation found for method launch on channel)
在添加依赖包时,可能会出现Unhandled Exception: MissingPluginException(No implementation found for method launch o ...
- Codeforces Round #585 (Div. 2) E. Marbles (状压DP),BZOJ大理石(同一道题)题解
题意 林老师是一位大理石收藏家,他在家里收藏了n块各种颜色的大理石,第i块大理石的颜色为ai.但是林老师觉得这些石头在家里随意摆放太过凌乱,他希望把所有颜色相同的石头放在一起.换句话说,林老师需要对现 ...
- DataGridVIew控件绑定数据之后的,增、插、删操作
最开始没有绑定数据,很快就实现了增.插.删操作,可是绑定数据之后,进行这些操作就会报错. 网上对这方面的资料比较少,自己摸索着找到了解决方法,也就是直接对绑定的数据进行操作,这里以DataTable为 ...
- Android Notification使用
一 Notification的类别 1.状态栏和抽屉式通知 //获取NotificationManager对象 val notificationManager = getSystemService(N ...