MVC源碼分析 - Action/Result 過濾器執行時機

前面的篇章, 解析了Action方法的查找, 以及 Authorize, Action, Result, Error 過濾器的載入時機. 也花了兩篇去看授權和錯誤過濾器的使用. 但是對於 Action/Result 的執行以及Action/Result裡面的兩個過濾器的執行時機, 並沒有清晰看到. ...

前面的篇章, 解析了Action方法的查找, 以及 Authorize, Action, Result, Error 過濾器的載入時機. 也花了兩篇去看授權和錯誤過濾器的使用. 但是對於 Action/Result 的執行以及Action/Result裡面的兩個過濾器的執行時機, 並沒有清晰看到.

一、Action 方法的執行和過濾器的執行

//System.Web.Mvc.ControllerActionInvoker
protected virtual ActionExecutedContext InvokeActionMethodWithFilters(ControllerContext controllerContext,
　　 IList<IActionFilter> filters, ActionDescriptor actionDescriptor, IDictionary<string, object> parameters)
{
    ActionExecutingContext preContext = new ActionExecutingContext(controllerContext, actionDescriptor, parameters);
    //這裡定義了一個Func委托, 返回值為 ActionExecutedContext 類型
　　 //在返回的 ActionExecutedContext 類型實例中, 對 Result 指定了執行方法
　　 //這裡其實都是在指定待執行的方法, 在它執行完畢後, 並沒有任何的方法被執行. 以下標紅的部分, 就是執行 Action 方法
　　 Func<ActionExecutedContext> seed = () => new ActionExecutedContext(controllerContext, actionDescriptor, false, null) 
　　　　{ Result = this.InvokeActionMethod(controllerContext, actionDescriptor, parameters) };
    return filters
　　　　　　 //filters變數是一個以controller為首元素的List<IActionFilter>集合,這裡的目的就是要反轉集合, 變成
　　　　　　 // IActionFilter->Controller
　　　　　　.Reverse<IActionFilter>()
　　　　　　 //聚合函數, 這裡的 next 其實就是 seed 對象
　　　　　　 //filter 是 IEnumberable<IActionFilter> 中的元素
　　　　　　 //這裡的效果, 就是返回累加後的 seed 對象
　　　　　　.Aggregate<IActionFilter, Func<ActionExecutedContext>>(seed,
　　　　　　　　 (next, filter) => () => InvokeActionMethodFilter(filter, preContext, next))
　　　　　　(); //這一步執行方法
}

這裡的代碼就是前面的 3.4, 只是我對他進行了分割, 這樣容易看懂點

這裡有一個 Aggregate<>() 可能不是那麼好理解, 先上一個demo, 應該是能夠促進理解的.

var numbers = new int[] { 1, 3, 9, 2 };  
// 使用當前總值乘以下一個數值得到新的總值 
var product = numbers.Aggregate((total, next) => total * next);
最後的值是: 1 X 3 X 9 X 2 = 54。

這裡的執行過程是這樣的:

1). 當第一次執行 Aggregate() 的時候, 匿名方法(next, filter)中的next 就是 seed 對象, filter就是ActionFilter對象. 他將InvokeActionMethodFilter(filter, preContext, next)作為返回值, 並作為下一次執行(next, filter)中的next參數

2). 第二次執行(next, filter)的時候, next參數的值是 InvokeActionMethodFilter(filter, preContext, next) , filter是Controller, 最終將

InvokeActionMethodFilter(filter, preContext, next)最為結果返回給 filters 變數.

整個執行表達式為 : filters = InvokeActionMethodFilter(controller, preContext, InvokeActionMethodFilter(ActionFilter, preContext, seed));

經過上述步驟後, filters形成了一個鏈表, 其最先執行的還是Controller.

1. InvokeActionMethodFilter

internal static ActionExecutedContext InvokeActionMethodFilter(IActionFilter filter, 
　　ActionExecutingContext preContext, Func<ActionExecutedContext> continuation)
{
　　 //這一步執行 ActionExecuting 過濾器
    filter.OnActionExecuting(preContext);
    if (preContext.Result != null)
    {
　　　　  //當不能通過過濾器的時候, 會走這裡
        return new ActionExecutedContext(preContext, preContext.ActionDescriptor, true, null) 
　　　　　　{ Result = preContext.Result };
    }
    bool flag = false;
    ActionExecutedContext filterContext = null;
    try
    {
　　　　  //1.第一次執行這一步,會跳轉到 InvokeActionFilter(filter, preContext, next)中去執行
　　　　　 //2.第二次運行到這裡的時候,會去執行 上面的 seed 方法
　　　　　 //在執行seed方法的時候, 就回去運行 InvokeActionMethod() 方法
        filterContext = continuation();
    }
    catch (ThreadAbortException)
    {
        filterContext = new ActionExecutedContext(preContext, preContext.ActionDescriptor, false, null);
        filter.OnActionExecuted(filterContext);
        throw;
    }
    catch (Exception exception)
    {
        flag = true;
        filterContext = new ActionExecutedContext(preContext, preContext.ActionDescriptor, false, exception);
        filter.OnActionExecuted(filterContext);
        if (!filterContext.ExceptionHandled)
        {
            throw;
        }
    }
    if (!flag)
    {
        filter.OnActionExecuted(filterContext);
    }
    return filterContext;
}

在這裡, 已經能看到 ActionExecuting 和 ActionExecuted 兩個過濾器的執行時機了

根據上面的註釋, 然後看一下 InvokeActionMethod 方法

protected virtual ActionResult InvokeActionMethod(ControllerContext controllerContext,
　　　　 ActionDescriptor actionDescriptor, IDictionary<string, object> parameters)
{
    object actionReturnValue = actionDescriptor.Execute(controllerContext, parameters);
    return this.CreateActionResult(controllerContext, actionDescriptor, actionReturnValue);
}

這裡的 Execute 方法, 返回的就是 ActionResult了, 調用CreateActionResult 是為了進行類型轉換, 將返回的actionReturnValue 轉換為ActionResult類型.

這裡其實就是執行的 Action 方法. 並返回執行結果.

二、Result 的執行和過濾器的執行

//ControllerActionInvoker
protected virtual ResultExecutedContext InvokeActionResultWithFilters(ControllerContext controllerContext,
　　 IList<IResultFilter> filters, ActionResult actionResult)
{
    ResultExecutingContext preContext = new ResultExecutingContext(controllerContext, actionResult);
    Func<ResultExecutedContext> seed = delegate {
        this.InvokeActionResult(controllerContext, actionResult);
        return new ResultExecutedContext(controllerContext, actionResult, false, null);
    };
    return filters
　　　　　　.Reverse<IResultFilter>()
　　　　　　.Aggregate<IResultFilter, Func<ResultExecutedContext>>(seed, 
　　　　　　　　(next, filter) => () => InvokeActionResultFilter(filter, preContext, next))
　　　　　　();
}

看這裡方法的結構和上面Action那裡差不多. 並且註意到這裡的返回值:ResultExecutedContext, 返回的就是執行完View的結果.

先看一下 InvokeActionResultFilter方法

1. InvokeActionResultFilter

internal static ResultExecutedContext InvokeActionResultFilter(IResultFilter filter,
　　 ResultExecutingContext preContext, Func<ResultExecutedContext> continuation)
{
    filter.OnResultExecuting(preContext);
    if (preContext.Cancel)
    {
        return new ResultExecutedContext(preContext, preContext.Result, true, null);
    }
    bool flag = false;
    ResultExecutedContext filterContext = null;
    try
    {
        filterContext = continuation();
    }
    catch (ThreadAbortException)
    {
        filterContext = new ResultExecutedContext(preContext, preContext.Result, false, null);
        filter.OnResultExecuted(filterContext);
        throw;
    }
    catch (Exception exception)
    {
        flag = true;
        filterContext = new ResultExecutedContext(preContext, preContext.Result, false, exception);
        filter.OnResultExecuted(filterContext);
        if (!filterContext.ExceptionHandled)
        {
            throw;
        }
    }
    if (!flag)
    {
        filter.OnResultExecuted(filterContext);
    }
    return filterContext;
}

內部方法的執行順序都是一樣的. 從這個方法能看出, Result 過濾器的執行順序, 確實如前面提到的那樣. 先執行Executing , 再執行 Result, 最後執行 Executed方法.

2. InvokeActionResult

protected virtual void InvokeActionResult(ControllerContext controllerContext, ActionResult actionResult)
{
    actionResult.ExecuteResult(controllerContext);
}

這一步, 就是執行View了, 具體的執行過程有機會的話, 就在後面解析了.

這一篇主要是驗證, Action/Result的四個過濾器的執行順序是否如前面描述的那樣子. 當然, 在探尋的過程中, 順便也看到了Action/Result方法的執行時機.

這裡其實還有一個問題, 從上面看, 把Controller排序到最前面執行了, 那麼如果我是在FilterConfig中註冊的呢? Action方法上標註的呢?Controller類上面標註的呢? 是一個什麼順序?

下一篇就去看一下, 這裡的順序, 也能輔助理解這一篇的內容.

參考:

　　深入分析Asp.net Mvc

目錄已同步