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部分代码

 1 public class myexceptionfilter : iexceptionfilter
 2 {
 3     public ilogger logger { get; set; }
 4 
 5     public myexceptionfilter()
 6     {
 7         logger = nulllogger.instance;
 8     }
 9 
10     public void onexception(exceptioncontext context)
11     {
12         if (!(context.exception is myexception))
13         {
14             return;
15         }
16 
17         handleandwrapexception(context);
18     }
19 
20     private void handleandwrapexception(exceptioncontext context)
21     {
22         context.httpcontext.response.statuscode = (int)httpstatuscode.badrequest;
23 
24         var myexception = (myexception)context.exception;
25 
26         context.result = new objectresult(
27         　　new ajaxresponse(
28         　　　　new errorinfo(myexception.errorcode, myexception.message)
29 　　　　　　　　)    
30 　　　　　);
31 
32         loghelper.logexception(logger, context.exception);
33 
34         context.exception = null; //handled!
35     }
36 }            

然后再startup文件中添加filter

1 services.configure(mvcoptions =>
2 {
3     mvcoptions.filters.addservice(typeof(myexceptionfilter ));
4 });

 

运行发现，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去处理，七擒孟获）
但为了熟悉这部分的代码逻辑还是做了一下实现。

 1 public class myexceptionhandler : ieventhandler, itransientdependency
 2 {
 3     public ilogger logger { get; set; }
 4 
 5     public myexceptionhandler()
 6     {
 7         logger = nulllogger.instance;
 8     }
 9 
10     public void handleevent(abphandledexceptiondata eventdata)
11     {
12         logger.info(eventdata.exception.tostring());
13         throw eventdata.exception;
14     }
15 }

 

如果是为了别的一些功能，上面利用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: 1);

 

另：由abpexceptionfilter介绍可知，它并不会catch住所有类型的异常，如果想对任意类型的异常进行处理，使用middleware可能会更好。

参考内容：

github：
https://github.com/aspnetboilerplate/aspnetboilerplate/issues/1550
https://github.com/aspnetboilerplate/aspnetboilerplate/issues/3280

hk zhang大佬的博客