第五節：WebApi的三大過濾器

一. 基本說明 

 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 + "方法運行之前");
        }

        /// <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方法，手動制造錯誤，會進入異常過濾器中，獲取錯誤，進行相應的處理.

 

 

 

 

 

  

 

!

• 作       者 : Yaopengfei(姚鵬飛)
• 博客地址 : http://www.cnblogs.com/yaopengfei/
• 聲     明1 : 本人才疏學淺，用郭德綱的話說“我是一個小學生”，如有錯誤，歡迎討論，請勿謾罵^_^。
• 聲     明2 : 原創博客請在轉載時保留原文鏈接或在文章開頭加上本人博客地址，否則保留追究法律責任的權利。