AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Abp vNext异常处理的缺陷/改造方案

2022-04-23 609
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 SLS，月写入数据量 50GB 1个月
云原生数据仓库AnalyticDB MySQL版，基础版 8ACU 100GB 1个月
简介： 之前吐槽Abp的用户/租户管理模块！今天我又来了，这次我给Abp官方repo提了一个issue。

目前Website使用Abp vNext开发，免不了要全局处理异常、提示服务器异常信息。


1. Abp官方异常处理


Abp项目默认会启动内置的异常处理，默认不将异常信息发送到客户端。


在AppModule文件ConfigureServices方法中使用以下代码：


Configure<AbpExceptionHandlingOptions>(options =>
{
    options.SendExceptionsDetailsToClients = true;
});


可将异常信息发送到客户端：如下图：


{
"error": {
   "code": null,
   "message": "ERROR [42000] [Cloudera][ImpalaODBC] (360) Syntax error occurred during query execution: [HY000] : AnalysisException: Could not resolve column/field reference: 'ug_fed89221846a42dc8427932b2965a020'\n",
   "details": "OdbcException: ERROR [42000] [Cloudera][ImpalaODBC] (360) Syntax error occurred during query execution: [HY000] : AnalysisException: Could not resolve column/field reference: 'ug_fed89221846a42dc8427932b2965a020'\n\nSTACK TRACE: at Gridsum.EAP.Olap.ExecuteQueryLayer.HandleQueryAsync(QueryContext queryContext, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/Olap/ExecuteQueryLayer.cs:line 81\n at Gridsum.EAP.Olap.DistributedCacheLayer.HandleQueryAsync(QueryContext queryContext, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/Olap/DistributedCacheLayer.cs:line 50\n at Gridsum.EAP.DataQuery.AbstractQueryExecutor`1.ExecuteQueryAsync(TQuery query, DistributedCacheEntryOptions options, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/AbstractQueryExecutor.cs:line 60\n at Gridsum.EAP.DataQuery.AbstractQueryExecutor`1.ExecuteQueryAsync(TQuery query, CancellationToken token) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/AbstractQueryExecutor.cs:line 47\n at Gridsum.EAP.Application.UserGroupService.ClearUserGroupUserAsync(UserGroupUpdateUserDto updateDto, String idshort, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.Application/UserGroup/UserGroupService.cs:line 332\n at Gridsum.EAP.Application.UserGroupService.UpdateUserGroupUserAsync(UserGroupUpdateUserDto updateDto, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.Application/UserGroup/UserGroupService.cs:line 370\n at Castle.DynamicProxy.AsyncInterceptorBase.ProceedAsynchronous[TResult](IInvocation invocation, IInvocationProceedInfo proceedInfo "42000] [Cloudera][ImpalaODBC] (360 "42000] [Cloudera][ImpalaODBC] (360) Syntax error occurred during query execution: [HY000] : AnalysisException: Could not resolve column/field reference: 'ug_fed89221846a42dc8427932b2965a020'\n\nSTACK TRACE: at Gridsum.EAP.Olap.ExecuteQueryLayer.HandleQueryAsync(QueryContext queryContext, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/Olap/ExecuteQueryLayer.cs:line 81\n at Gridsum.EAP.Olap.DistributedCacheLayer.HandleQueryAsync(QueryContext queryContext, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/Olap/DistributedCacheLayer.cs:line 50\n at Gridsum.EAP.DataQuery.AbstractQueryExecutor`1.ExecuteQueryAsync(TQuery query, DistributedCacheEntryOptions options, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/AbstractQueryExecutor.cs:line 60\n at Gridsum.EAP.DataQuery.AbstractQueryExecutor`1.ExecuteQueryAsync(TQuery query, CancellationToken token) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/AbstractQueryExecutor.cs:line 47\n at Gridsum.EAP.Application.UserGroupService.ClearUserGroupUserAsync(UserGroupUpdateUserDto updateDto, String idshort, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.Application/UserGroup/UserGroupService.cs:line 332\n at Gridsum.EAP.Application.UserGroupService.UpdateUserGroupUserAsync(UserGroupUpdateUserDto updateDto, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.Application/UserGroup/UserGroupService.cs:line 370\n at Castle.DynamicProxy.AsyncInterceptorBase.ProceedAsynchronous[TResult") Syntax error occurred during query execution: [HY000] : AnalysisException: Could not resolve column/field reference: 'ug_fed89221846a42dc8427932b2965a020'\n\nSTACK TRACE: at Gridsum.EAP.Olap.ExecuteQueryLayer.HandleQueryAsync(QueryContext queryContext, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/Olap/ExecuteQueryLayer.cs:line 81\n at Gridsum.EAP.Olap.DistributedCacheLayer.HandleQueryAsync(QueryContext queryContext, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/Olap/DistributedCacheLayer.cs:line 50\n at Gridsum.EAP.DataQuery.AbstractQueryExecutor`1.ExecuteQueryAsync(TQuery query, DistributedCacheEntryOptions options, CancellationToken cancellationToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/AbstractQueryExecutor.cs:line 60\n at Gridsum.EAP.DataQuery.AbstractQueryExecutor`1.ExecuteQueryAsync(TQuery query, CancellationToken token) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.DataQuery/AbstractQueryExecutor.cs:line 47\n at Gridsum.EAP.Application.UserGroupService.ClearUserGroupUserAsync(UserGroupUpdateUserDto updateDto, String idshort, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.Application/UserGroup/UserGroupService.cs:line 332\n at Gridsum.EAP.Application.UserGroupService.UpdateUserGroupUserAsync(UserGroupUpdateUserDto updateDto, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.Application/UserGroup/UserGroupService.cs:line 370\n at Castle.DynamicProxy.AsyncInterceptorBase.ProceedAsynchronous[TResult")\n at Volo.Abp.Castle.DynamicProxy.CastleAbpMethodInvocationAdapterWithReturnValue`1.ProceedAsync()\n at Volo.Abp.Validation.ValidationInterceptor.InterceptAsync(IAbpMethodInvocation invocation)\n at Volo.Abp.Castle.DynamicProxy.CastleAsyncAbpInterceptorAdapter`1.InterceptAsync[TResult](IInvocation invocation, IInvocationProceedInfo proceedInfo, Func`3 proceed "TResult")\n at Castle.DynamicProxy.AsyncInterceptorBase.ProceedAsynchronous[TResult](IInvocation invocation, IInvocationProceedInfo proceedInfo "TResult")\n at Volo.Abp.Castle.DynamicProxy.CastleAbpMethodInvocationAdapterWithReturnValue`1.ProceedAsync()\n at Volo.Abp.Auditing.AuditingInterceptor.InterceptAsync(IAbpMethodInvocation invocation)\n at Volo.Abp.Castle.DynamicProxy.CastleAsyncAbpInterceptorAdapter`1.InterceptAsync[TResult](IInvocation invocation, IInvocationProceedInfo proceedInfo, Func`3 proceed "TResult")\n at Castle.DynamicProxy.AsyncInterceptorBase.ProceedAsynchronous[TResult](IInvocation invocation, IInvocationProceedInfo proceedInfo "TResult")\n at Volo.Abp.Castle.DynamicProxy.CastleAbpMethodInvocationAdapterWithReturnValue`1.ProceedAsync()\n at Volo.Abp.Uow.UnitOfWorkInterceptor.InterceptAsync(IAbpMethodInvocation invocation)\n at Volo.Abp.Castle.DynamicProxy.CastleAsyncAbpInterceptorAdapter`1.InterceptAsync[TResult](IInvocation invocation, IInvocationProceedInfo proceedInfo, Func`3 proceed "TResult")\n at Gridsum.EAP.Controllers.UserGroupController.UpdateUserGroupUserAsync(String id, CancellationToken cancelToken) in /home/gitlab-runner/builds/ttRjAPVA/0/eap/website/app/src/Gridsum.EAP.HttpApi/Controllers/UserGroupController.cs:line 320\n at lambda_method3440(Closure , Object )\n at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.AwaitableObjectResultExecutor.Execute(IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)\n at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.<InvokeActionMethodAsync>g__Awaited|12_0(ControllerActionInvoker invoker, ValueTask`1 actionResultValueTask)\n at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.<InvokeNextActionFilterAsync>g__Awaited|10_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)\n at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Rethrow(ActionExecutedContextSealed context)\n at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)\n at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.<InvokeInnerFilterAsync>g__Awaited|13_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeNextExceptionFilterAsync>g__Awaited|25_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)\n",
   "data": null,
   "validationErrors": null
  }
}


经过几天倒腾，发现Abp vNext的异常处理有几个问题。


2.Abp异常处理存在的缺陷


  1. 并没有如官方所述：自动处理所有异常，实际需要满足官方所说的某个条件：


b23e8d765efdab8fa2455c78cee6247e.png


这就导致当Controller Action方法返回的不是object result时，则根本捕获不到异常(我们暂时不说middleware产生的异常)，这应该算Abp的一个Bug


  1. 输出的异常没有TraceId， 不利于日志排查


  1. 发送到客户端的日志字段message,detail过于详细冗长，不适合前端显示


也可以配置SendExceptionsDetailsToClients，不将异常信息发送到客户端，但这样就因噎废食了。


3. 异常处理的目标


虽然Abp的异常处理有缺陷， 但只是异常信息应用上的缺陷，Abp异常处理


①对异常的划分、

②异常信息的本地化、

③出现异常时写日志  支持的还是相当好。


基于Abp的异常处理现状，考虑做一些改进：


  1. 对所有Controller-Action方法捕获异常， [修复Abp Bug]


  1. 在Abp的异常处理结果中添加 TraceId


  1. 希望将服务端异常分类，简化后给到前端；同时也不妨碍开发者查看详细异常信息。


4. 揪出Abp异常处理缺陷的根源


Abp异常处理的核心对象AbpExceptionFilter，实现IAsyncExceptionFilter过滤器, ITransientDependency瞬时注入接口。


这是一个ServiceFilterAttribute, 你可以理解有个特性作用在每一个Controller的Action方法上：


[ServiceFilter(typeof(AbpExceptionFilter))]


一旦某个Controller的Action方法发生异常， 会执行如下代码：


public async Task OnExceptionAsync(ExceptionContext context)
{
   if (!ShouldHandleException(context))
   {
        return;
   }
   await HandleAndWrapException(context);
}


  1. ShouldHandleException(context) ：监测是否应该处理异常，据查该函数确实存在我上文说的问题：并不能捕获所有的Action方法的异常。


  1. HandleAndWrapException(context)：异常处理步骤：


  • 根据Abp内置的异常类型，自动确定状态码 (这个在Abp官方文档有讲)


  • 序列化异常对象，并向客户端输出如下格式：


{
"error": {
  "code": null,
   "message": "ERROR [42000] [Cloudera][ImpalaODBC] (360) Syntax error occurred during query execution: [HY000] : AnalysisException: Could not resolve column/field reference: 'ug_fed89221846a42dc8427932b2965a020'\n",
   "details":xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx......,
   "data": null,
   "validationErrors": null
  }
}


① 输出的信息，从一开始就没有包含TraceId；


② Abp标准格式化后的异常信息，过于冗长，message，details字段均不适合前端显示。


  • 写日志，默认异常级别为Error

掌握以上源码，我们可以针对性的改造Abp的核心异常处理类AbpExceptionFilter。


5. Abp异常处理: 缺陷修复方案


光说不练假把式


Abp的AbpExceptionFilter不是抽象类，没法重载，为达到我们设定的3个目标。

考虑使用针对性的ExceptionFilter替换默认有缺陷的AbpExceptionFilter。


①.  新建EapExceptionFilter，内容拷贝自AbpExceptionFilter， 并做出如下针对性修改：


8ec59beecf0ca18c2d33d40ed612337c.png

b74a4f24774bc98aa64398cf23ccc23e.png


②. 在AppModule中，替换默认的AbpExceptionFilter为新的EapExceptionFilter过滤器：


context.Services.AddMvc(options =>
{
    options.Filters.ReplaceOne(x=> (x as ServiceFilterAttribute)?.ServiceType?.Name==nameof(AbpExceptionFilter), new ServiceFilterAttribute(typeof(EapExceptionFilter)));  
})

改造的效果如下：


5ab80469cea8e10723bb8cb6423d50f9.png


That's  All


如果大家真切使用了Abp vNext最新版，


相信我在第2点提到的Abp异常处理的缺陷，Abp使用者会感同身受；


第3点提出的几个目标也是企业级异常处理要解决的痛点。


此异常处理的思路也可推及到其他非Abp项目.


改造方案在Abp官方github issue上：  https://github.com/abpframework/abp/issues/6761


一家之言，如有其他看法，请不吝赐教！

文章标签：
云原生数据仓库AnalyticDB MySQL版
日志服务
前端开发
中间件
开发者
相关实践学习
阿里云云原生数据仓库AnalyticDB MySQL版 使用教程
云原生数据仓库AnalyticDB MySQL版是一种支持高并发低延时查询的新一代云原生数据仓库，高度兼容MySQL协议以及SQL:92、SQL:99、SQL:2003标准，可以对海量数据进行即时的多维分析透视和业务探索，快速构建企业云上数据仓库。 了解产品 https://www.aliyun.com/product/ApsaraDB/ads
阿里云马甲哥
目录
相关文章
小华同学ai
|
9月前
|
JavaScript Linux iOS开发
Motrix：Star46.4k,有了这个开源项目你的烦恼基本少了一半？一款开源功能全面的下载管理器，用上它妈妈再也不用担心下载速度啦～～～
嗨，大家好，我是小华同学。今天为大家介绍一款全能下载管理器——Motrix。它支持HTTP、FTP、BitTorrent等多种协议，拥有简洁易用的界面和强大的下载功能，包括选择性下载、多线程加速、自动更新Tracker列表等，适用于工作、学习和娱乐场景。欢迎关注我们，获取更多优质开源项目和高效工具。
小华同学ai
366 15
Motrix：Star46.4k,有了这个开源项目你的烦恼基本少了一半？一款开源功能全面的下载管理器，用上它妈妈再也不用担心下载速度啦～～～
还在路上的秃头
|
安全 Java 开发者
【JAVA】哪些集合类是线程安全的
【JAVA】哪些集合类是线程安全的
还在路上的秃头
424 0
dotNative
|
11月前
|
Kubernetes Cloud Native Ubuntu
庆祝 .NET 9 正式版发布与 Dapr 从 CNCF 毕业：构建高效云原生应用的最佳实践
2024年11月13日，.NET 9 正式版发布，Dapr 从 CNCF 毕业，标志着云原生技术的成熟。本文介绍如何使用 .NET 9 Aspire、Dapr 1.14.4、Kubernetes 1.31.0/Containerd 1.7.14、Ubuntu Server 24.04 LTS 和 Podman 5.3.0-rc3 构建高效、可靠的云原生应用。涵盖环境准备、应用开发、Dapr 集成、容器化和 Kubernetes 部署等内容。
dotNative
579 6
好奇的菜鸟
|
关系型数据库 MySQL 数据库
使用ZIP包安装MySQL及配置教程
使用ZIP包安装MySQL及配置教程
好奇的菜鸟
1237 4
可编程芯片开发
|
vr&ar C++
基于simulink的风轮机发电系统建模与仿真
本课题使用Simulink实现风轮机发电系统的建模与仿真，涵盖风速模型（基本风、阵风、阶跃风、随机风）、风力机模型及飞轮储能模块。采用MATLAB 2022a进行仿真，详细介绍了各风速成分的数学模型及其组合模型，阐述了风力机从风能捕获到电能输出的全过程，为风力发电系统的设计和优化提供了理论基础和技术支持。
可编程芯片开发
459 4
Echo_Wish
|
12月前
|
机器学习/深度学习 数据采集 API
使用Python实现深度学习模型：智能光污染监测与管理
使用Python实现深度学习模型：智能光污染监测与管理
Echo_Wish
172 0
不吃核桃
|
Java 测试技术 API
详解单元测试问题之Mockito的注入过程如何解决
详解单元测试问题之Mockito的注入过程如何解决
不吃核桃
244 1
1941623231718325
|
分布式计算 Hadoop 大数据
大数据技术：Hadoop与Spark的对比
【6月更文挑战第15天】**Hadoop与Spark对比摘要** Hadoop是分布式系统基础架构，擅长处理大规模批处理任务，依赖HDFS和MapReduce，具有高可靠性和生态多样性。Spark是快速数据处理引擎，侧重内存计算，提供多语言接口，支持机器学习和流处理，处理速度远超Hadoop，适合实时分析和交互式查询。两者在资源占用和生态系统上有差异，适用于不同应用场景。选择时需依据具体需求。
1941623231718325
597 1
掉发的小王
|
XML SQL Java
Mybatis-Plus中实现使用xml文件来写复杂sql
Mybatis-Plus中实现使用xml文件来写复杂sql
掉发的小王
2352 0
龙蜥社区（OpenAnolis）
|
算法 Linux 调度
根基已筑！Anolis OS 23.1 预览版本搭载 Linux 6.6 内核和工具链升级完成
Anolis OS 23.1 对软件包的选择和组合进行了重新规划与决策，满足更为广泛的应用场景需求。
龙蜥社区（OpenAnolis）
461 0