2、⾃定义过滤器特性ActionFilterAttribute 的处理这个ActionFilterAttribute 主要⽤于拦截⽤户访问控制器⽅法的处理过程，前⾯说到，OnActionExecuting⽅法在Action执⾏之前执⾏，OnActionExecuted⽅法在Action执⾏完成之后执⾏。那么我们可以利⽤它进⾏函数AOP的处理了，也就是在执⾏前，执⾏后进⾏⽇志记录等，还有就是常规的参数检查、结果封装等，都可以在这个⾃定义过滤器中实现。我们定义⼀个类WrapResultAttribute来标记封装结果，定义⼀个类DontWrapResultAttribute来标记不封装结果。 /// /// ⽤于判断Web API需要包装返回结果. /// [AttributeUsage( | ace | )] public class WrapResultAttribute : ActionFilterAttribute{} /// /// ⽤于判断Web API不需要包装返回结果. /// [AttributeUsage( | ace | )] public class DontWrapResultAttribute : WrapResultAttribute{}这个处理⽅式是借⽤ABP框架中这两个特性的处理逻辑。利⽤，对于获取⽤户⾝份令牌的基础操作接⼝，我们可以不封装返回结果，如下标记所⽰。 那么执⾏后，返回的结果如下所⽰，就是正常的TokenResult对象的JSON信息{ "access_token": "3MiOiIxIiwiaWF0IjoxNjE3MjY0MDQ4LCJqdGkiOiI0NTBjZmY3OC01OTEwLTQwYzUtYmJjMC01OTQ0YzNjMjhjNTUiLCJuYW1lIjoiYWRtaW4iLCJjb3JwaWQiOiI2IiwiY2hhbm5lb "expires_in": 604800}如果取消这个DontWrapResult的标记，那么它就继承基类BaseApiController的WrapResult的标记定义了。 /// /// 所有接⼝基类 /// [ExceptionHandling] [WrapResult] public class BaseApiController : ApiController那么接⼝定义不变，但是返回的okenResult对象的JSON信息已经经过包装了。{ "result": { "access_token": "3MiOiIxIiwiaWF0IjoxNjE3MjY0NDQ5LCJqdGkiOiJmZTAzYzhlNi03NGVjLTRjNmEtYmMyZi01NTU3MjFiOTM1NDEiLCJuYW1lIjoiYWRtaW4iLCJjb3JwaWQiOiI2IiwiY2hhbm5l "expires_in": 604800 }, "targetUrl": null, "success": true, "error": null, "unAuthorizedRequest": false, "__api": true}这个JSON格式是我们⼀个通⽤的接⼝返回，其中Result⾥⾯定义了返回的信息，⽽Error⾥⾯则定义⼀些错误信息（如果有错误的话），⽽success则⽤于判断是否执⾏成功，如果有错误异常信息，那么success返回为false。这个通⽤返回的定义，是依照ABP框架的返回格式进⾏调整的，可以作为我们普通Web API的⼀个通⽤返回结果的处理。前⾯提到过ActionFilterAttribute⾃定义处理过程，在控制器⽅法完成后，我们对返回的结果进⾏进⼀步的封装处理即可。我们需要重写逻辑实现OnActionExecuted的函数 在做包装返回结果之前，我们需要判断是否⽅法或者控制器设置了不包装的标记DontWrapResultAttribute。 public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) { //如果有异常，则退出交给Exception的通⽤处理 if (ion != null) return; //正常完成，那么判断是否需要包装结果输出，如果不需要则返回 var dontWrap = false; var actionContext = Context; if (Descriptor is ReflectedHttpActionDescriptor actionDesc) { //判断⽅法是否包含DontWrapResultAttribute dontWrap = tomAttributes(inherit: false) .Any(a => e().Equals(typeof(DontWrapResultAttribute))); if (dontWrap) return; } if (llerDescriptor is HttpControllerDescriptor controllerDesc) { //判断控制器是否包含DontWrapResultAttribute dontWrap = tomAttributes(inherit: true) .Any(a => e().Equals(typeof(DontWrapResultAttribute))); if (dontWrap) return; }上述代码也就是如果找到⽅法或者控制器有定义DontWrapResultAttribute的，就不要包装结果，否则下⼀步就是对结果进⾏封装了 //需要包装，那么就包装输出结果 AjaxResponse result = new AjaxResponse(); // 状态代码 var statusCode = Code; // 读取返回的内容 var content = Async
3、异常处理过滤器ExceptionFilterAttribute
前⾯介绍到，Web API的过滤器⽆法改变其顺序，它是按照 AuthorizationFilterAttribute -> ActionFilterAttribute -> ExceptionFilterAttribute 这个执⾏顺序来处理的，也就是说授权过滤器执⾏在前⾯，再次到⾃定义的ActionFilter，最后才是异常的过滤器处理。异常处理过滤器，我们定义后，可以统⼀处理和封装异常信息，⽽我们只需要实现OnException的⽅法即可。 /// /// ⾃定义异常处理 /// public class ExceptionHandlingAttribute : ExceptionFilterAttribute { /// /// 统⼀对调⽤异常信息进⾏处理，返回⾃定义的异常信息 /// /// HTTP上下⽂对象 public override void OnException(HttpActionExecutedContext context) { } }完整的处理过程代码如下所⽰。 /// /// ⾃定义异常处理 /// public class ExceptionHandlingAttribute : ExceptionFilterAttribute { /// /// 统⼀对调⽤异常信息进⾏处理，返回⾃定义的异常信息 /// /// HTTP上下⽂对象 public override void OnException(HttpActionExecutedContext context) { //获取⽅法或控制器对应的WrapResultAttribute属性 var actionDescriptor = Descriptor; var wrapResult = tomAttributes(inherit: true).FirstOrDefault() tomAttributes(inherit: true).FirstOrDefault(); //如设置，记录异常信息 if (wrapResult != null && or) { (ion); } var statusCode = GetStatusCode(context, Error); if (!Error) { se = new HttpResponseMessage(statusCode) {
Content = new StringContent(()) }; ion = null; //Handled! return; } //使⽤AjaxResponse包装结果 var content = new ErrorInfo(e/*, race*/); var isAuth = ion is AuthorizationException; se = new HttpResponseMessage(statusCode) { Content = new ObjectContent( new AjaxResponse(content, isAuth), matter()) }; ion = null; //Handled! }这样我们在BaseApiController⾥⾯声明即可。 这样，⼀旦程序处理过程中，有错误抛出，都会统⼀到这⾥进⾏处理，有异常的返回JSON如下所⽰。
2、⾃定义过滤器特性ActionFilterAttribute 的处理这个ActionFilterAttribute 主要⽤于拦截⽤户访问控制器⽅法的处理过程，前⾯说到，OnActionExecuting⽅法在Action执⾏之前执⾏，OnActionExecuted⽅法在Action执⾏完成之后执⾏。那么我们可以利⽤它进⾏函数AOP的处理了，也就是在执⾏前，执⾏后进⾏⽇志记录等，还有就是常规的参数检查、结果封装等，都可以在这个⾃定义过滤器中实现。我们定义⼀个类WrapResultAttribute来标记封装结果，定义⼀个类DontWrapResultAttribute来标记不封装结果。 /// /// ⽤于判断Web API需要包装返回结果. /// [AttributeUsage( | ace | )] public class WrapResultAttribute : ActionFilterAttribute{} /// /// ⽤于判断Web API不需要包装返回结果. /// [AttributeUsage( | ace | )] public class DontWrapResultAttribute : WrapResultAttribute{}这个处理⽅式是借⽤ABP框架中这两个特性的处理逻辑。利⽤，对于获取⽤户⾝份令牌的基础操作接⼝，我们可以不封装返回结果，如下标记所⽰。 那么执⾏后，返回的结果如下所⽰，就是正常的TokenResult对象的JSON信息{ "access_token": "3MiOiIxIiwiaWF0IjoxNjE3MjY0MDQ4LCJqdGkiOiI0NTBjZmY3OC01OTEwLTQwYzUtYmJjMC01OTQ0YzNjMjhjNTUiLCJuYW1lIjoiYWRtaW4iLCJjb3JwaWQiOiI2IiwiY2hhbm5lb "expires_in": 604800}如果取消这个DontWrapResult的标记，那么它就继承基类BaseApiController的WrapResult的标记定义了。 /// /// 所有接⼝基类 /// [ExceptionHandling] [WrapResult] public class BaseApiController : ApiController那么接⼝定义不变，但是返回的okenResult对象的JSON信息已经经过包装了。{ "result": { "access_token": "3MiOiIxIiwiaWF0IjoxNjE3MjY0NDQ5LCJqdGkiOiJmZTAzYzhlNi03NGVjLTRjNmEtYmMyZi01NTU3MjFiOTM1NDEiLCJuYW1lIjoiYWRtaW4iLCJjb3JwaWQiOiI2IiwiY2hhbm5l "expires_in": 604800 }, "targetUrl": null, "success": true, "error": null, "unAuthorizedRequest": false, "__api": true}这个JSON格式是我们⼀个通⽤的接⼝返回，其中Result⾥⾯定义了返回的信息，⽽Error⾥⾯则定义⼀些错误信息（如果有错误的话），⽽success则⽤于判断是否执⾏成功，如果有错误异常信息，那么success返回为false。这个通⽤返回的定义，是依照ABP框架的返回格式进⾏调整的，可以作为我们普通Web API的⼀个通⽤返回结果的处理。前⾯提到过ActionFilterAttribute⾃定义处理过程，在控制器⽅法完成后，我们对返回的结果进⾏进⼀步的封装处理即可。我们需要重写逻辑实现OnActionExecuted的函数 在做包装返回结果之前，我们需要判断是否⽅法或者控制器设置了不包装的标记DontWrapResultAttribute。 public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) { //如果有异常，则退出交给Exception的通⽤处理 if (ion != null) return; //正常完成，那么判断是否需要包装结果输出，如果不需要则返回 var dontWrap = false; var actionContext = Context; if (Descriptor is ReflectedHttpActionDescriptor actionDesc) { //判断⽅法是否包含DontWrapResultAttribute dontWrap = tomAttributes(inherit: false) .Any(a => e().Equals(typeof(DontWrapResultAttribute))); if (dontWrap) return; } if (llerDescriptor is HttpControllerDescriptor controllerDesc) { //判断控制器是否包含DontWrapResultAttribute dontWrap = tomAttributes(inherit: true) .Any(a => e().Equals(typeof(DontWrapResultAttribute))); if (dontWrap) return; }上述代码也就是如果找到⽅法或者控制器有定义DontWrapResultAttribute的，就不要包装结果，否则下⼀步就是对结果进⾏封装了 //需要包装，那么就包装输出结果 AjaxResponse result = new AjaxResponse(); // 状态代码 var statusCode = Code; // 读取返回的内容 var content = Async
3、异常处理过滤器ExceptionFilterAttribute
前⾯介绍到，Web API的过滤器⽆法改变其顺序，它是按照 AuthorizationFilterAttribute -> ActionFilterAttribute -> ExceptionFilterAttribute 这个执⾏顺序来处理的，也就是说授权过滤器执⾏在前⾯，再次到⾃定义的ActionFilter，最后才是异常的过滤器处理。异常处理过滤器，我们定义后，可以统⼀处理和封装异常信息，⽽我们只需要实现OnException的⽅法即可。 /// /// ⾃定义异常处理 /// public class ExceptionHandlingAttribute : ExceptionFilterAttribute { /// /// 统⼀对调⽤异常信息进⾏处理，返回⾃定义的异常信息 /// /// HTTP上下⽂对象 public override void OnException(HttpActionExecutedContext context) { } }完整的处理过程代码如下所⽰。 /// /// ⾃定义异常处理 /// public class ExceptionHandlingAttribute : ExceptionFilterAttribute { /// /// 统⼀对调⽤异常信息进⾏处理，返回⾃定义的异常信息 /// /// HTTP上下⽂对象 public override void OnException(HttpActionExecutedContext context) { //获取⽅法或控制器对应的WrapResultAttribute属性 var actionDescriptor = Descriptor; var wrapResult = tomAttributes(inherit: true).FirstOrDefault() tomAttributes(inherit: true).FirstOrDefault(); //如设置，记录异常信息 if (wrapResult != null && or) { (ion); } var statusCode = GetStatusCode(context, Error); if (!Error) { se = new HttpResponseMessage(statusCode) {
Content = new StringContent(()) }; ion = null; //Handled! return; } //使⽤AjaxResponse包装结果 var content = new ErrorInfo(e/*, race*/); var isAuth = ion is AuthorizationException; se = new HttpResponseMessage(statusCode) { Content = new ObjectContent( new AjaxResponse(content, isAuth), matter()) }; ion = null; //Handled! }这样我们在BaseApiController⾥⾯声明即可。 这样，⼀旦程序处理过程中，有错误抛出，都会统⼀到这⾥进⾏处理，有异常的返回JSON如下所⽰。
发布评论