ABP Changing Httpcode status
小弟初来乍到,分享一些工作学习中遇到的问题和解决方式,如有不准确或是有错误的地方,希望不吝赐教,谢过了。 --Dogtwo
起因:
ABP 中异常处理的思路是很清晰的。一共五种类型的异常类。
AbpInitializationException用于封装ABP初始化过程中出现的异常,只要抛出AbpInitializationException异常就可以,无须做额外处理。这类异常往往是需要维护人员介入分析的。
其他四个异常都在AbpController中被集中处理,处理分为两步:一,通过EventBus触发异常事件,相应的异常处理函数则处理异常。二,针对AbpValidationException,UserFriendlyException和AbpAuthorizationException异常,Abp会将异常信息转换为ErrorInfo,并以view或Json的形式返回给客户端。
(以上内容摘自 HK Zhand大大的博客)
我们应使用UserFriendlyException来包装我们自定义的异常,但UserFriendlyException抛出的异常存在一个问题:无法指定HttpStatus code,这样前端收到的response中HttpStatus code均为500。对一部分前端语言或框架来说,这个状态码难以处理或不便于处理,因为约定5xx指示服务器异常,不应再由前端进行Handle。
所以,我们希望更改Response中的HttpStatus code。
思路很简单,我们利用filter去拦截异常,判断其类型,若为我们自定义的异常则更改HttpStatus code。
Filter部分代码
public class MyExceptionFilter : IExceptionFilter
{
public ILogger Logger { get; set; } public MyExceptionFilter()
{
Logger = NullLogger.Instance;
} public void OnException(ExceptionContext context)
{
if (!(context.Exception is MyException))
{
return;
} HandleAndWrapException(context);
} private void HandleAndWrapException(ExceptionContext context)
{
context.HttpContext.Response.StatusCode = (int)HttpStatusCode.BadRequest; var myException = (MyException)context.Exception; context.Result = new ObjectResult(
new AjaxResponse(
new ErrorInfo(myException.ErrorCode, myException.Message)
)
); LogHelper.LogException(Logger, context.Exception); context.Exception = null; //Handled!
}
}
然后再StartUp文件中添加filter
services.Configure(mvcOptions =>
{
mvcOptions.Filters.AddService(typeof(MyExceptionFilter ));
});
运行发现,filter并不能catch住我们抛出的异常,甚至OnException方法体都没进入。
原来,ABP本身实现了几个filter,包括Authorization Filter, Audit Action Filter, Validation Action Filter, Unit of Work Action Filter, Exception Filter和Result Filter.
造成我们的自定义filter无法正常执行的原因就是Exception Filter.
ABP官方文档介绍为:
AbpExceptionFilter is used to handle exceptions thrown from controller actions. It handles and logs exceptions and returns a wrapped response to the client.
This only handles object results, and not view results. Actions returning any object, JsonResult or ObjectResult will be handled. Actions are not handled if they return a view or any other result type implementing IActionsResult. It is recommend that you use the built-in UseExceptionHandler extension method defined in the Microsoft.AspNetCore.Diagnostics package to handle view exceptions.
Exception handling and logging behaviour can be changed using the WrapResult and DontWrapResult attributes for methods and classes.
除此之外, ABPExceptionFilter还会触发AbpHandledExceptionData eventbus event.且,经由ABPExceptionFilter处理之后,会将异常信息转换为ErrorInfo,并以view或Json的形式返回给客户端。所以当response通过ABPExceptionFilter之后便不再包含Exception了,自然我们的Filter捕捉不到了。
由此,想到两个解决方法
一 经由Event bus再次将异常抛出(很明显,如果是为了解决本问题的话,逻辑不通,很差的解决方式。已经被catch的异常再抛出来被自定义的filter去处理,七擒孟获)
但为了熟悉这部分的代码逻辑还是做了一下实现。
public class MyExceptionHandler : IEventHandler, ITransientDependency
{
public ILogger Logger { get; set; } public MyExceptionHandler()
{
Logger = NullLogger.Instance;
} public void HandleEvent(AbpHandledExceptionData eventData)
{
Logger.Info(eventData.Exception.ToString());
throw eventData.Exception;
}
}
如果是为了别的一些功能,上面利用EventBus来处理的方式也可以借鉴。
二是禁用ABPExceptionFilter改为使用我们自己的filter
禁用ABPExceptionFilter
除上面声明Filter之外还需要在Configure中app.UseMvc之后添加
// Remove AbpExceptionFilter
var ops = app.ApplicationServices.GetRequiredService<IOptions<MvcOptions>>().Value;
var abpExceptionFilter = ops.Filters.FirstOrDefault(f =>
(f as ServiceFilterAttribute)?.ServiceType == (typeof(AbpExceptionFilter)));
ops.Filters.Remove(abpExceptionFilter);
此方法也有不好的地方,即除我们自定义的异常外,其他异常并不能再由ABPExceptionFilter来处理。
改良最佳版:
我们的最根本的目的其实是更改HttpStatusCode,所以即便Exception被ABPExceptionFilter 封装成ErrorInfo来说对我们影响并不大,只要能让我们的自定义Filter catch住异常即可,因此,在Configuresevice中注册filter时声明顺序即可。
options.Filters.AddService(typeof(myExceptionFilter), order: );
另:由ABPExceptionFilter介绍可知,它并不会catch住所有类型的异常,如果想对任意类型的异常进行处理,使用middleware可能会更好。
参考内容:
github:
https://github.com/aspnetboilerplate/aspnetboilerplate/issues/1550
https://github.com/aspnetboilerplate/aspnetboilerplate/issues/3280
ABP Changing Httpcode status的更多相关文章
- clear read-only status问题的解决
IDEA系工具可能会报出的错误. 解决方法见官方文档吧:Changing Read-Only Status of Files : https://www.jetbrains.com/help/ide ...
- words
conscious[英][ˈkɒnʃəs][美][ˈkɑnʃəs]consensus[英][kənˈsensəs][美][kənˈsɛnsəs] scious sensuswaterflood; de ...
- SQLSERVER全文搜索
SQLSERVER全文搜索 看这篇文章之前请先看一下下面我摘抄的全文搜索的MSDN资料,基本上MSDN上关于全文搜索的资料的我都copy下来了 并且非常认真地阅读和试验了一次,并且补充了一些SQL语句 ...
- xp+WinDBG+VMware调试内核
呵呵,搞点突兀的标题而已.其实说的还是如何使用WinDBG和VMware来搭建调试内核的环境而已,这些网上已经有数不清的教程了,不过我喜欢自己亲手写一下.第一,把这个过程写一遍能加深印象,就算以后忘记 ...
- oracle11g中SQL优化(SQL TUNING)新特性之SQL Plan Management(SPM)
1. 简介 Oracle Database11gR1引进了SQL PlanManagement(简称SPM),一套允许DBA捕获和保持任意SQL语句执行计划最优的新工具,这样,限制了刷新优化器统计 ...
- APPCORE Routine APIs
Introduction to APPCORE Routine APIs This chapter provides you with specifications for calling many ...
- Mysql 5.7 基于组复制(MySQL Group Replication) - 运维小结
之前介绍了Mysq主从同步的异步复制(默认模式).半同步复制.基于GTID复制.基于组提交和并行复制 (解决同步延迟),下面简单说下Mysql基于组复制(MySQL Group Replication ...
- CloudSim源代码学习——任务单元(Cloudlet)
/* * Title: CloudSim Toolkit * Description: CloudSim (Cloud Simulation) Toolkit for Modeling and Sim ...
- SQL Server全文搜索
SQL Server全文搜索 看这篇文章之前请先看一下下面我摘抄的全文搜索的MSDN资料,基本上MSDN上关于全文搜索的资料的我都copy下来了 并且非常认真地阅读和试验了一次,并且补充了一些SQL语 ...
随机推荐
- dubbo 源码学习1 服务发布机制
1.源码版本:2.6.1 源码demo中采用的是xml式的发布方式,在dubbo的 DubboNamespaceHandler 中定义了Spring Framework 的扩展标签,即 <dub ...
- JavaScript的文档对象模型DOM
小伙伴们之前我们讲过很多JavaScript的很多知识点,可以点击回顾一下: <JavaScript大厦之JS运算符>: <JavaScript工作原理:内存管理 + 如何处理4个常 ...
- Javascript高级编程学习笔记(49)—— DOM2和DOM3(1)DOM变化
DOM变化 我们知道DOM有许多的版本,其中DOM0和DOM2这两个级别以对事件的纳入标准而为人所知 但是呢,这里不讲事件,在后面会有专门和事件有关的部分作为详细讲解 这里就只讲一下DOM2和DOM3 ...
- 全栈开发工程师微信小程序-上(中)
全栈开发工程师微信小程序-上(中) width: 750rpx; 750rpx代表与屏幕等宽,rpx的缩写responsive pixel,这个单位是可以根据屏幕大小进行自适应调整的像素单位. 小程序 ...
- TX-LCN分布式事务Demo实战
1. TX-LCN分布式事务Demo实战 1.1. 原理介绍 1.1.1. 事务控制原理 TX-LCN由两大模块组成, TxClient.TxManager,TxClient作为模块的依赖框架,提供T ...
- redis入门知识汇总
1.什么是redis? Redis 是一个基于内存的高性能key-value数据库. 2.Reids的特点 Redis本质上是一个Key-Value类型的内存数据库,很像memcached,整个数据库 ...
- java基础-3
java基础-3 API Application Programming Interfaces --- 应用程序接口 Object 顶级父类 Bin --- 二进制 Oct --- 八进制 Dec ...
- SVN密码找回 完美方案
问题背景 SVN(Subversion)版本管理工具.本文以Windows操作系统下使用SVN的场景. 长时间不使用SVN,可能会出现忘记了SVN密码的尴尬局面.那么,该如何找回SV密码呢? 处理思路 ...
- freemarker变量自加
[#assign i = 0][#list dateList as item][#assign i = i + 1]<li><input type="radio" ...
- sql server 索引阐述系列七 索引填充因子与碎片
一.概述 索引填充因子作用:提供填充因子选项是为了优化索引数据存储和性能. 当创建或重新生成索引时,填充因子的值可确定每个叶级页上要填充数据的空间百分比,以便在每一页上保留一些剩余存储空间作为以后扩展 ...