Asp.Net WebAPI中 Filter的使用以及執(zhí)行順序（收藏）

小編給大家分享一下Asp.Net WebAPI中 Filter的使用以及執(zhí)行順序（收藏），相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

在WEB Api中，引入了面向切面編程（AOP）的思想，在某些特定的位置可以插入特定的Filter進行過程攔截處理。引入了這一機制可以更好地踐行DRY(Don’t Repeat Yourself)思想，通過Filter能統(tǒng)一地對一些通用邏輯進行處理，如：權限校驗、參數(shù)加解密、參數(shù)校驗等方面我們都可以利用這一特性進行統(tǒng)一處理，今天我們來介紹Filter的開發(fā)、使用以及討論他們的執(zhí)行順序。

一、Filter的開發(fā)和調用

在默認的WebApi中，框架提供了三種Filter，他們的功能和運行條件如下表所示：

首先，我們實現(xiàn)一個AuthorizatoinFilter可以用以簡單的權限控制：

       
             (actionContext.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute> verifyResult = actionContext.Request.Headers.Authorization!= &&  == ; 

             (!= HttpError(

一個簡單的用于用戶驗證的Filter就開發(fā)完了，這個Filter要求用戶的請求中帶有Authorization頭并且參數(shù)為123456，如果通過則放行，不通過則返回401錯誤，并在Content中提示Token不正確。下面，我們需要注冊這個Filter，注冊Filter有三種方法：

第一種：在我們希望進行權限控制的Action上打上AuthFilterAttribute這個Attribute:

    public class PersonController : ApiController
    {
        [AuthFilter]        public CreateResult Post(CreateUser user)
        {            return new CreateResult() {Id = "123"};
        }
    }

這種方式適合單個Action的權限控制。

第二種，找到相應的Controller，并打上這個Attribute：

    [AuthFilter]    public class PersonController : ApiController
    {        public CreateResult Post(CreateUser user)
        {            return new CreateResult() {Id = "123"};
        }
    }

這種方式適合于控制整個Controller，打上這個Attribute以后，整個Controller里所有Action都獲得了權限控制。

第三種，找到App_Start\WebApiConfig.cs，在Register方法下加入Filter實例：

   { id =

用這種方式適合于控制所有的API，任意Controller和任意Action都接受了這個權限控制。

在大多數(shù)場景中，每個API的權限驗證邏輯都是一樣的，在這樣的前提下使用全局注冊Filter的方法最為簡單便捷，可這樣存在一個顯而易見的問題：如果某幾個API是不需要控制的（例如登錄）怎么辦？我們可以在這樣的API上做這樣的處理：

[AllowAnonymous]public CreateResult PostLogin(LoginEntity entity)
{      //TODO:添加驗證邏輯
      return new CreateResult() {Id = "123456"};
}

我為這個Action打上了AllowAnonymousAttribute，驗證邏輯就放過了這個API而不進行權限校驗。

在實際的開發(fā)中，我們可以設計一套類似Session的機制，通過用戶登錄來獲取Token，在之后的交互HTTP請求中加上Authorization頭并帶上這個Token，并在自定義的AuthFilterAttribute中對Token進行驗證，一套標準的Token驗證流程就可以實現(xiàn)了。

接下來我們介紹ActionFilter:

　　ActionFilterAttrubute提供了兩個方法進行攔截：OnActionExecuting和OnActionExecuted，他們都提供了同步和異步的方法。

　　OnActionExecuting方法在Action執(zhí)行之前執(zhí)行，OnActionExecuted方法在Action執(zhí)行完成之后執(zhí)行。

　　我們來看一個應用場景：使用過MVC的同學一定不陌生MVC的模型綁定和模型校驗，使用起來非常方便，定義好Entity之后，在需要進行校驗的地方可以打上相應的Attribute，在Action開始時檢查ModelState的IsValid屬性，如果校驗不通過直接返回View，前端可以解析并顯示未通過校驗的原因。而Web API中也繼承了這一方便的特性，使用起來更加方便：

 public class CustomActionFilterAttribute : ActionFilterAttribute
{    public override void OnActionExecuting(HttpActionContext actionContext)
    {        if (!actionContext.ModelState.IsValid)
        {
            actionContext.Response = actionContext.Request.CreateErrorResponse(HttpStatusCode.BadRequest,  actionContext.ModelState);
        }
    }
}

這個Filter就提供了模型校驗的功能，如果未通過模型校驗則返回400錯誤，并把相關的錯誤信息交給調用者。他的使用方法和AuthFilterAttribute一樣，可以針對Action、Controller、全局使用。我們可以用下面一個例子來驗證：

代碼如下：

public class LoginEntity
{
    [Required(ErrorMessage = "缺少用戶名")]    public string UserName { get; set; }

    [Required(ErrorMessage = "缺少密碼")]    public string Password { get; set; }
}

[AllowAnonymous]
[CustomActionFilter]public CreateResult PostLogin(LoginEntity entity)
{     //TODO:添加驗證邏輯
     return new CreateResult() {Id = "123456"};
}

當然，你也可以根據(jù)自己的需要解析ModelState然后用自己的格式將錯誤信息通過Request.CreateResponse()返回給用戶。

　　OnActionExecuted方法我在實際工作中使用得較少，目前僅在一次部分響應數(shù)據(jù)加密的場景下進行過使用，使用方法一樣，讀取已有的響應，并加密后再給出加密后的響應賦值給actionContext.Response即可。

我給大家一個Demo:

public override async Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
{        var key = 10;        var responseBody = await actionExecutedContext.Response.Content.ReadAsByteArrayAsync(); //以Byte數(shù)組方式讀取Content中的數(shù)據(jù)

        for (int i = 0; i < responseBody.Length; i++)
        {
            responseBody[i] = (byte)(responseBody[i] ^ key); //對每一個Byte做異或運算        }

        actionExecutedContext.Response.Content = new ByteArrayContent(responseBody); //將結果賦值給Response的Content
        actionExecutedContext.Response.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("Encrypt/Bytes"); //并修改Content-Type}

　　通過這個方法我們將響應的Content每個Byte都做了一個異或運算，對響應內容進行了一次簡單的加密，大家可以根據(jù)自己的需要進行更可靠的加密，如AES、DES或者RSA…通過這個方法可以靈活地對某個Action的處理后的結果進行處理，通過Filter進行響應內容加密有很強的靈活性和通用性，他能獲取當前Action的很多信息，然后根據(jù)這些信息選擇加密的方式、獲取加密所需的參數(shù)等等。如果加密所使用參數(shù)對當前執(zhí)行的Action沒有依賴，也可以采取HttpMessageHandler來進行處理，在之后的教程中我會進行介紹。

最后一個Filter：ExceptionFilter

顧名思義，這個Filter是用來進行異常處理的，當業(yè)務發(fā)生未處理的異常，我們是不希望用戶接收到黃頁或者其他用戶無法解析的信息的，我們可以使用ExceptionFilter來進行統(tǒng)一處理：

public class ExceptionFilter : ExceptionFilterAttribute
{    public override void OnException(HttpActionExecutedContext actionExecutedContext)
    {        //如果截獲異常為我們自定義，可以處理的異常則通過我們自己的規(guī)則處理
        if (actionExecutedContext.Exception is DemoException)
        {            //TODO:記錄日志
            actionExecutedContext.Response = actionExecutedContext.Request.CreateResponse(
                    HttpStatusCode.BadRequest, new {Message = actionExecutedContext.Exception.Message});
        }        else
        {            //如果截獲異常是我沒無法預料的異常，則將通用的返回信息返回給用戶，避免泄露過多信息，也便于用戶處理            //TODO:記錄日志
            actionExecutedContext.Response =
                    actionExecutedContext.Request.CreateResponse(HttpStatusCode.InternalServerError,                        new {Message = "服務器被外星人拐跑了！"});
        }
    }
}

我們定義了一個ExceptoinFilter用于處理未捕獲的異常，我們將異常分為兩類：一類是我們可以預料的異常：如業(yè)務參數(shù)錯誤，越權等業(yè)務異常；還有一類是我們無法預料的異常：如數(shù)據(jù)庫連接斷開、內存溢出等異常。我們通過HTTP Code告知調用者以及用相對固定、友好的數(shù)據(jù)結構將異常信息告訴調用者，以便于調用者記錄并處理這樣的異常。

 [CustomerExceptionFilter]public class TestController : ApiController
{    public int Get(int a, int b)
    {        if (a < b)
        {            throw new DemoException("A必須要比B大！");
        }        if (a == b)
        {            throw new NotImplementedException();
        }        return a*b;
    }
}

我們定義了一個Action：在不同的情況下會拋出不同的異常，其中一個異常是我們能夠預料并認為是調用者傳參出錯的，一個是不能夠處理的，我們看一下結果：

在這樣的RestApi中，我們可以預先定義好異常的表現(xiàn)形式，讓調用者可以方便地判斷什么情況下是出現(xiàn)異常了，然后通過較為統(tǒng)一的異常信息返回方式讓調用者方便地解析異常信息，形成統(tǒng)一方便的異常消息處理機制。

   但是，ExceptionFilter只能在成功完成了Controller的初始化以后才能起到捕獲、處理異常的作用，而在Controller初始化完成之前（例如在Controller的構造函數(shù)中出現(xiàn)了異常）則ExceptionFilter無能為力。對此WebApi引入了ExceptionLogger和ExceptionHandler處理機制，我們將在之后的文章中進行講解。

二、Filter的執(zhí)行順序

在使用MVC的時候，ActionFilter提供了一個Order屬性，用戶可以根據(jù)這個屬性控制Filter的調用順序，而Web API卻不再支持該屬性。Web API的Filter有自己的一套調用順序規(guī)則：

所有Filter根據(jù)注冊位置的不同擁有三種作用域：Global、Controller、Action：

通過HttpConfiguration類實例下Filters.Add()方法注冊的Filter（一般在App_Start\WebApiConfig.cs文件中的Register方法中設置）就屬于Global作用域；

通過Controller上打的Attribute進行注冊的Filter就屬于Controller作用域；

通過Action上打的Attribute進行注冊的Filter就屬于Action作用域；

他們遵循了以下規(guī)則：

1、在同一作用域下，AuthorizationFilter最先執(zhí)行，之后執(zhí)行ActionFilter

2、對于AuthorizationFilter和ActionFilter.OnActionExcuting來說，如果一個請求的生命周期中有多個Filter的話，執(zhí)行順序都是Global->Controller->Action；

3、對于ActionFilter，OnActionExecuting總是先于OnActionExecuted執(zhí)行；

4、對于ExceptionFilter和ActionFilter.OnActionExcuted而言執(zhí)行順序為Action->Controller->Global；

5、對于所有Filter來說，如果阻止了請求:即對Response進行了賦值，則后續(xù)的Filter不再執(zhí)行。

關于默認情況下的Filter相關知識我們就講這么一些，如果在文章中有任何不正確的地方或者疑問，歡迎大家為我指出。

以上是Asp.Net WebAPI中 Filter的使用以及執(zhí)行順序（收藏）的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業(yè)資訊頻道！