API 的三大过滤器

一. 基本说明

1. 简介：

WebApi下的过滤器和MVC下的过滤器有一些区别,首先我们要注意的是通常建WebApi项目时，会自动把MVC的程序集也引入进来，所以我们在使用WebApi下的过滤器的时候，要引入“ System.Web.Http”这个程序集，而不是MVC的“System.Web.MVC”。

PS：关于WebApi下的过滤器在的作用位置和使用方法以及执行顺序，均和MVC下的过滤器相似，详见：https://www.cnblogs.com/yaopengfei/p/7910763.html

2. 与MVC过滤器的区别

由于WebApi只关注于方法,所以WebApi下没有结果过滤器, 详细分析: ActionFilterAttribute这个类并没有继承IResultFilter这个接口,只继承了IActionFilter这个接口,重写了OnActionExecuted和OnActionExecuting两个方法(包括对应的异步方法)，并没有重写：OnResultExecuted和OnResultExecuting两个方法。

3. 过滤器的重写方法的执行顺序：

OnAuthorization→OnActionExecuting-> Action方法执行 ->OnActionExecuted

二. 三大过滤器

1. 授权过滤器

继承AuthorizeAttribute类，重写OnAuthorization方法，eg：MyAuthorize类.

public class MyAuthorize : AuthorizeAttribute
    {
        public override void OnAuthorization(HttpActionContext actionContext)
        {

            //1.如果保留如下代码，则会运行.net framework定义好的身份验证，如果希望自定义身份验证，则删除如下代码
            // base.OnAuthorization(actionContext);

            //2.获取控制器作用的Controller和action的名字
            string controllerName = actionContext.ActionDescriptor.ControllerDescriptor.ControllerName.ToLower();
            string actionName = actionContext.ActionDescriptor.ActionName.ToLower();
            HttpContext.Current.Response.Write("身份验证过滤器作用于" + controllerName + "控制器下的" + actionName + "方法");
        }
    }

2. 行为过滤器

继承ActionFilterAttribute,重写OnActionExecuting和OnActionExecuted方法，eg：MyAction类

public class MyAction: ActionFilterAttribute
    {
        /// <summary>
        /// 在Action方法运行之前调用
        /// </summary>
        /// <param name="actionContext"></param>
        public override void OnActionExecuting(HttpActionContext actionContext)
        {

            //1.如果保留如下代码，则会运行.net framework定义好的行为验证，如果希望自定义行为验证，则删除如下代码
            // base.OnActionExecuting(actionContext);

            //2.获取控制器作用的Controller和action的名字
            string controllerName = actionContext.ActionDescriptor.ControllerDescriptor.ControllerName.ToLower();
            string actionName = actionContext.ActionDescriptor.ActionName.ToLower();
            HttpContext.Current.Response.Write("行为过滤器OnActionExecuting作用于" + controllerName + "控制器下的" + actionName + "方法运行之前");
			
			//不符合条件直接返回，不再进入控制器
			actionContext.Response = new HttpResponseMessage { Content = new StringContent(JsonConvert.SerializeObject(message), Encoding.GetEncoding("UTF-8"), "application/json") };
        }

        /// <summary>
        /// 在Action方法运行之后调用
        /// </summary>
        /// <param name="actionExecutedContext"></param>
        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            base.OnActionExecuted(actionExecutedContext);

            //1.如果保留如下代码，则会运行.net framework定义好的行为验证，如果希望自定义行为验证，则删除如下代码
            // base.OnActionExecuted(actionExecutedContext);

            //2.获取控制器作用的Controller和action的名字
            string controllerName = actionExecutedContext.ActionContext.ControllerContext.ControllerDescriptor.ControllerName.ToLower();
            string actionName = actionExecutedContext.ActionContext.ActionDescriptor.ActionName.ToLower();
            HttpContext.Current.Response.Write("行为过滤器OnActionExecuted作用于" + controllerName + "控制器下的" + actionName + "方法运行之后");
        }
    }

测试：用PostMan请求下面的CheckLogin方法，可以验证上面的执行顺序：OnAuthorization→OnActionExecuting-> Action方法执行 ->OnActionExecuted

3.异常个过滤器

实现IExceptionFilter接口，继承FilterAttribute类(能以特性的形式作用)，eg：MyException类.

/// <summary>
    /// 异常过滤器
    /// </summary>
    public class MyException : FilterAttribute,IExceptionFilter
    {
        //public bool AllowMultiple => throw new NotImplementedException();

        public async Task ExecuteExceptionFilterAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
        {
            //throw new NotImplementedException();

            //1.获取异常信息
            string errorMsg = actionExecutedContext.Exception.ToString();

            //2.对获取的异常信息进行处理
            using (StreamWriter writer = File.AppendText("d:/err.txt"))
            {
                await writer.WriteLineAsync(errorMsg);
            }

        }
    }

测试： 用PostMan请求下面的CheckLogin2方法，手动制造错误，会进入异常过滤器中，获取错误，进行相应的处理.