.NET/ASP.NET MVC Controller 控制器（IController控制器的創建過程）

閱讀目錄：

• 1.開篇介紹
• 2.ASP.NETMVC IControllerFactory 控制器工廠接口
• 3.ASP.NETMVC DefaultControllerFactory 默認控制器工廠
• 4.ASP.NETMVC ControllerBuilder 控制器創建入口設置
• 5.ASP.NETMVC 自定義IControllerFactory

1】開篇介紹

上一篇文章“.NET/ASP.NET MVC Controller 控制器（一：深入解析控制器運行原理）”詳細的講解了MvcHandler對象內部的基本流程邏輯，這基本的流程邏輯為我們后面的學習起到鋪墊作用，當我們能正確的搞懂它的內部執行流程后，我們就可以順藤摸瓜的去挖掘每個邏輯環節中的詳細邏輯；

通過前面兩篇文章的介紹，我們基本上能搞清楚一個Url請求是如何借助於UrlRoutingModule模塊順利穿過ASP.NET基礎框架到達應用框架的過程，當UrlRoutingModule處理過后將RouteData對象封裝在RequestContext請求上下文中傳入到MvcHandler對象，然后MvcHandler對象通過IControllerFactory接口根據從RouteData中獲取到controllername控制器名稱字符串創建具體的IController對象實例；

這基本的流程我們是清晰了，但是我們並不太清楚IControllerFactory背后所發生的一切，到底誰作為IControllerFactory默認實現的，它又有着怎樣的擴展入口讓我們來擴展創建過程，這值得一探究竟；

那么這篇文章讓我們來分析一下IControllerFactory的背后所發生的事情，我們是否能從中學到什么設計思想；

2】ASP.NETMVC IControllerFactory 控制器工廠接口

既然能將ControllerFactory提取出接口來，那么對於IController的創建將是一個非常寬松的過程；簡單的設想一下，如果不將Factory提出接口來，那么對於IController的創建將是一個很直觀的過程，但是ASP.NETMVC將IController創建不是簡單的使用一個ControllerFactory來解決，而是將這個創建過程設計的很松散，目的是為了擴展性方便，換句話說我們完全可以自定義一個Factroy來替代這個創建過程，也可以基於系統內部的Factroy來擴展一下；

MvcHandler使用IControllerFactroy創建出相應IController對象，那么首先我們需要搞清楚MvcHandler通過什么方式獲取到實現IControllerFactory接口的；

其實在MvcHandler中並不是直接使用IControllerFactroy的相關實現，而是使用了ControllerBuilder對象，這個對象是一個單例模式的實現；MvcHanlder通過ControllerBuilder對象獲取到一個實例，然后通過ControllerBuilder創建出IControllerFactory實現；

internal ControllerBuilder ControllerBuilder {
    get {
        if (_controllerBuilder == null) {
            _controllerBuilder = ControllerBuilder.Current;
        }
        return _controllerBuilder;
    }
    set {
        _controllerBuilder = value;
    }
} 

factory = ControllerBuilder.GetControllerFactory(); 

可以簡單的理解為，ControllerBuilder管理着IControllerFactory的創建過程，MvcHanlder通過獲取ControllerBuilder的全局實例，然后調用其方法GetControllerFactory，得到可以使用的IControllerFactory實現；

圖1:

ControllerBuilder的設計很巧妙，它將IControllerFactory的實現為我們敞開了大門，我們可以通過這個入口做很多事情；

我們看一下IControllerFactroy接口的定義：

public interface IControllerFactory {
    IController CreateController(RequestContext requestContext, string controllerName);
    SessionStateBehavior GetControllerSessionBehavior(RequestContext requestContext, string controllerName);
    void ReleaseController(IController controller);
} 

接口中定義了三個方法，第一個方法CreateController很好理解，根據方法的第二個參數controllerName創建Controller實例；第二個方法GetControllerSessionBehavior方法是用來獲取controllerName所代表的Controller的Session行為的，該行為是通過SessionStateAttribute特性表示；第三個方法ReleaseController方法是用在最后釋放Controller的：

public virtual void ReleaseController(IController controller) {
    IDisposable disposable = controller as IDisposable;
    if (disposable != null) {
        disposable.Dispose();
    }
} 

由於Controller繼承自IDisposable接口，所以在方法內部是直接調用Dispose方法來釋放資源；這里需要注意的是，Controller對IDisposable接口的實現是virtual修飾符：

protected virtual void Dispose(bool disposing) {
} 

這就很方便我們通過重寫此方法的方式來釋放一些其他資源；

3】ASP.NETMVC DefaultControllerFactory 默認控制器工廠

在ASP.NETMVC內部有一個默認的Factroy（DefaultControllerFactroy），DefaultControllerFactroy實現了核心的創建IController代碼，這為我們的擴展提供了很好的接口；

通過調用IControllerFactory接口的CreateController(RequestContext requestContext, string controllerName) 方法，將進入到DefaultControllerFactory實現中，首要任務就是要根據controllerName名稱找到對應的ContorllerType，然后才能創建具體的實例；

object routeNamespacesObj;
Type match;
if (requestContext != null && requestContext.RouteData.DataTokens.TryGetValue("Namespaces", out routeNamespacesObj)) {
    IEnumerable<string> routeNamespaces = routeNamespacesObj as IEnumerable<string>;
    if (routeNamespaces != null && routeNamespaces.Any()) {
        HashSet<string> nsHash = new HashSet<string>(routeNamespaces, StringComparer.OrdinalIgnoreCase);
        match = GetControllerTypeWithinNamespaces(requestContext.RouteData.Route, controllerName, nsHash); 

        // the UseNamespaceFallback key might not exist, in which case its value is implicitly "true"
        if (match != null || false.Equals(requestContext.RouteData.DataTokens["UseNamespaceFallback"])) {
            // got a match or the route requested we stop looking
            return match;
        }
    }
}

首先根據請求的路由數據RouteData，查找設置的命名空間集合，然后使用命名空間和控制器名稱獲取Type，如果Type!=null並且沒有開啟后被命名空間則直接返回Type；

3.1】Controller中的AreaRegistration命名空間

在DefaultControllerFactroy內部使用到了兩組命名空間來作為查找Controller的NameSpace，第一個是我們在配置Route數據的時候設置的：

context.MapRoute(name: "api.order.default", url: "api/order/{controller}/{action}/{orderid}",
    defaults: new { controller = "OrderController", action = "GetOrderOperationDatetime", orderid = "1001" },
    namespaces: new string[] { "Api.Order" }); 

而第二個我們一般都不會用它的，它是作為AreaRegistration后備命名空間而存在的，是在ControllerBuilder中設置的：

ControllerBuilder.Current.DefaultNamespaces.Add("MvcApplication4.ApiOrder"); 

對后備命名空間的賦值是在AreaRegistrationContext中的MapRoute(string name, string url, object defaults, object constraints, string[] namespaces) 方法中完成的：

if (namespaces == null && Namespaces != null) {
     namespaces = Namespaces.ToArray();
} 

 

Route route = Routes.MapRoute(name, url, defaults, constraints, namespaces);
route.DataTokens["area"] = AreaName; 

// disabling the namespace lookup fallback mechanism keeps this areas from accidentally picking up
// controllers belonging to other areas
bool useNamespaceFallback = (namespaces == null || namespaces.Length == 0);
route.DataTokens["UseNamespaceFallback"] = useNamespaceFallback; 

return route; 

由於AreaRegistration可以讓我們對Controller的設計不局限於ASP.NETMVCWeb程序中，而可以將Controller獨立出去進行模塊化設計，所以需要提供有關Area的特殊命名空間查找方式；

4】ASP.NETMVC ControllerBuilder 控制器創建入口設置

ControllerBuilder作為Controller創建的設置入口，可以用來設置ControllerFactory替換系統默認的DefaultControllerFactory，ControllerBuilder是Controller的創建過程框架擴展入口，可以借助ControllerBuilder方便做很多設置；

internal ControllerBuilder(IResolver<IControllerFactory> serviceResolver) {
    _serviceResolver = serviceResolver ?? new SingleServiceResolver<IControllerFactory>(
        () => _factoryThunk(),
         new DefaultControllerFactory { ControllerBuilder = this },
        "ControllerBuilder.GetControllerFactory"
    );
} 

在ControllerBuilder的構造函數中，初始化了一個SingleServiceResolver<IControllerFactory>類型的Resolver，目的是為了對Factory實現IOC方式的獲取；在代碼中，實例化了一個DefaultControllerFactory類型的實例作為默認的Factory，比較重要的是將ControllerBuilder做為參數設置到了ControllerBuilder屬性中，目的是為了能在后面解析Controller命名空間的時候用到；

public HashSet<string> DefaultNamespaces {
    get {
        return _namespaces;
    }
}

在此我們可以設置統一的命名空間，由於我們在設置Route的時候，都需要設置namesapce字段，但是如果有很多這樣的Route的時候就很麻煩，我們可以通過此方式進行統一的設置；

public void SetControllerFactory(IControllerFactory controllerFactory) {
    if (controllerFactory == null) {
        throw new ArgumentNullException("controllerFactory");
    } 

    _factoryThunk = () => controllerFactory;
}

還有一個比較重要的就是設置自定義的ControllerFactory，在方法SetControllerFactory中，我們可以設置一個IControllerFactory類型的對象，就可以接管系統默認的DefaultControllerFactory對象，包括后面的所有的IController緩存策略；

圖2：

基本上我們可以通過ControllerBuilder進入到ControllerFactroy的創建環節來，使用SetControllerFactory方法直接將我們自定義的IControllerFactroy傳入即可；

5】ASP.NETMVC 自定義IControllerFactory

既然知道了ContollerBulder可以使我們更改系統默認的控制器工廠，那么我們通過怎樣的方式使用現在的Factroy；大致上我們只需要繼承自DefaultControllerFactory然后進行相應的擴展即可；

public class CustomControllerFactory : DefaultControllerFactory
{
    protected override IController GetControllerInstance(System.Web.Routing.RequestContext requestContext, Type controllerType)
    {
        Console.WriteLine(string.Format("{0}is create.", controllerType.Name));
        return base.GetControllerInstance(requestContext, controllerType);
    }
}

現在假設我們需要在系統創建所有Controller的時候能記錄下創建的記錄信息，這樣就很方便的完成了，我們只需要在系統初始化的地方進行設置：

ControllerBuilder.Current.SetControllerFactory(new Api.Order.CustomControllerFactory());

這樣我們就接管了ControllerFactory的部分功能；

 

作者：王清培

出處：http://www.cnblogs.com/wangiqngpei557/

本文版權歸作者和博客園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責任的權利。