ASP.NET MVC Controller激活系统详解：默认实现

Controller激活系统最终通过注册的ControllerFactory创建相应的Conroller对象，如果没有对ControllerFactory类型或者类型进行显式注册（通过调用当前ControllerBuilder的SetControllerFactory方法），默认使用的是一个DefaultControllerFactory对象，我们现在就来讨论实现在DefaultControllerFactory类型中的默认Controller激活机制。

目录 
一、Controller类型的解析 
    实例演示：创建一个自定义ControllerFactory模拟Controller默认激活机制 
二、 Controller类型的缓存 
三、 Controller的释放 
四、会话状态行为的控制

一、Controller类型的解析

激活目标Controller对象的前提是能够正确解析出对应的Controller类型。对于DefaultControllerFactory来，用于解析目标Controller类型的信息包括：通过与当前请求匹配的路由对象生成的RouteData（其中包含Controller的名称和命名空间）和包含在当前ControllerBuilder中的命名空间。很对读者可以首先想到的是通过Controller名称得到对应的类型，并通过命名空间组成Controller类型的全名，最后遍历所有程序集以此名称去加载相应的类型即可。

这貌似一个不错的解决方案，实际上则完全不可行。不要忘了作为请求地址URL一部分的Controller名称是不区分大小写的，而类型名称则是区分大小的；不论是注册路由时指定的命名空间还是当前ControllerBuilder的默认命名空间，有可能是包含统配符（*）。由于我们不能通过给定的Controller名称和命名空间得到Controller的真实类型名称，自然就不可能通过名称去解析Controller的类型了。

ASP.NET MVC的Controller激活系统反其道而行之。它先遍历通过BuildManager的静态方法GetReferencedAssemblies方法得到的编译Web应用所使用的程序集，通过反射得到所有实现了接口IController的类型，最后通过给定的Controller的名称和命名空间作为匹配条件在这个预先获取的类型列表中得到目标Controller的类型。

实例演示：创建一个自定义ControllerFactory模拟Controller默认激活机制

为了让读者对默认采用的Controller激活机制，尤其是Controller类型的解析机制有一个深刻的认识，我们通过一个自定义的ControllerFactory来模拟其中的实现。由于我们采用反射的方式来创建Controller对象，所以我们将该自定义ControllerFactory起名为ReflelctionControllerFactory。[源代码从这里下载]

public class ReflelctionControllerFactory : IControllerFactory
{
    //其他成员
    private static List<Type> controllerTypes;
    static ReflelctionControllerFactory()
    {
        controllerTypes = new List<Type>();
        foreach (Assembly assembly in BuildManager.GetReferencedAssemblies())
        {
            controllerTypes.AddRange(assembly.GetTypes().Where(type => typeof(IController).IsAssignableFrom(type)));
        }
    }

    public IController CreateController(RequestContext requestContext, string controllerName)
    {
        Type controllerType = this.GetControllerType(requestContext.RouteData, controllerName);
        if (null == controllerType)
        {
            throw new HttpException(404, "No controller found");
        }
        return (IController)Activator.CreateInstance(controllerType);
    }

    private static bool IsNamespaceMatch(string requestedNamespace, string targetNamespace)
    {
        if (!requestedNamespace.EndsWith(".*", StringComparison.OrdinalIgnoreCase))
        {
            return string.Equals(requestedNamespace, targetNamespace, StringComparison.OrdinalIgnoreCase);
        }
        requestedNamespace = requestedNamespace.Substring(0, requestedNamespace.Length - ".*".Length);
        if (!targetNamespace.StartsWith(requestedNamespace, StringComparison.OrdinalIgnoreCase))
        {
            return false;
        }
        return ((requestedNamespace.Length == targetNamespace.Length) || (targetNamespace[requestedNamespace.Length] == '.'));
    }

   private Type GetControllerType(IEnumerable<string> namespaces, Type[] controllerTypes)
    {
        var types = (from type in controllerTypes
                        where namespaces.Any(ns => IsNamespaceMatch(ns, type.Namespace))
                        select type).ToArray();
        switch (types.Length)
        {
            case 0: return null;
            case 1: return types[0];
            default: throw new InvalidOperationException("Multiple types were found that match the requested controller name.");
        }
    }

    protected virtual Type GetControllerType(RouteData routeData, string controllerName)
    {
        //省略实现
    }
}

如上面的代码片断所示，ReflelctionControllerFactory具有一个静态的controllerTypes字段由于保存所有Controller的类型。在静态构造函数中，我们调用BuildManager的GetReferencedAssemblies方法得到所有用于编译Web应用的程序集，并从中得到所有实现了IController接口的类型，这些类型全部被添加到通过静态字段controllerTypes表示的类型列表。

Controller类型的解析实现在受保护的GetControllerType方法中，在用于最终激活Controller对象的CreateController方法中，我们通过调用该方法得到与指定RequestContext和Controller名称相匹配的Controller类型，最终通过调用Activator的静态方法CreateInstance根据该类型创建相应的Controller对象。如果不能找到匹配的Controller类型（GetControllerType方法返回Null），则抛出一个HTTP状态为404的HttpException。

ReflelctionControllerFactory中定义了两个辅助方法，IsNamespaceMatch用于判断Controller类型真正的命名空间是否与指定的命名空间（可能包含统配符）相匹配，在进行字符比较过程中是忽略大小写的。私有方法GetControllerType根据指定的命名空间列表和类型名称匹配的类型数组得到一个完全匹配的Controller类型。如果得到多个匹配的类型，直接抛出InvalidOperation异常，并提示具有多个匹配的Controller类型；如果找不到匹配类型，则返回Null。

在如下所示的用于解析Controller类型的GetControllerType方法中，我们从预先得到的所有Controller类型列表中筛选出类型名称与传入的Controller名称相匹配的类型。我们首先通过路由对象的命名空间对 之前 得到的类型列表进行进一步筛选，如果能够找到一个唯一的类型，则直接将其作为Controller的类型返回。为了确定是否采用后备命名空间对Controller类型进行解析，我们从作为参数参数的RouteData对象的DataTokens中得到获取一个Key为“UseNamespaceFallback”的元素，如果该元素存在并且值为False，则直接返回Null。

如果RouteData的DataTokens中不存在这样一个UseNamespaceFallback元素，或者它的值为True，则首先里当前ControllerBuilder的默认命名空间列表进一步对Controller类型进行解析，如果存在唯一的类型则直接当作目标Controller类型返回。如果通过两组命名空间均不能得到一个匹配的ControllerType，并且只存在唯一一个与传入的Controller名称相匹配的类型，则直接将该类型作为目标Controller返回。如果这样的类型具有多个，则直接抛出InvalidOperationException异常。

public class ReflelctionControllerFactory : IControllerFactory
{
    //其他成员
    protected virtual Type GetControllerType (RouteData routeData, string controllerName)
    {
        //根据类型名称筛选
        var types = controllerTypes.Where(type => string.Compare(controllerName + "Controller", type.Name, true) == 0).ToArray();
        if (types.Length == 0)
        {
            return null;
        }

        //通过路由对象的命名空间进行匹配
        var namespaces = routeData.DataTokens["Namespaces"] as IEnumerable<string>;
        namespaces = namespaces ?? new string[0];
        Type contrllerType = this.GetControllerType(namespaces, types);
        if (null != contrllerType)
        {
            return contrllerType;
        }

        //是否允许采用后备命名空间
        bool useNamespaceFallback = true;
        if (null != routeData.DataTokens["UseNamespaceFallback"])
        {
            useNamespaceFallback = (bool)(routeData.DataTokens["UseNamespaceFallback"]);
        }

        //如果不允许采用后备命名空间，返回Null
        if (!useNamespaceFallback)
        {
            return null;
        }

        //通过当前ControllerBuilder的默认命名空间进行匹配
        contrllerType = this.GetControllerType(ControllerBuilder.Current.DefaultNamespaces, types);
        if (null != contrllerType)
        {
            return contrllerType;
        }

        //如果只存在一个类型名称匹配的Controller，则返回之
        if (types.Length == 1)
        {
            return types[0];
        }

        //如果具有多个类型名称匹配的Controller，则抛出异常
        throw new InvalidOperationException("Multiple types were found that match the requested controller name.");
    }
}

二、 Controller类型的缓存

为了避免通过遍历所有程序集对目标Controller类型的解析，ASP.NET MVC对解析出来的Controller类型进行了缓存以提升性能。与针对用于Area注册的AreaRegistration类型的缓存类似，Controller激活系统同样采用基于文件的缓存策略，而用于保存Controller类型列表的名为MVC-ControllerTypeCache.xml的文件保存在ASP.NET的临时目录下面。具体的路径如下，其中第一个针对寄宿于IIS中的Web应用，后者针对直接通过Visual Studio Developer Server作为宿主的应用。而用于保存所有AreaRegistration类型列表的MVC-AreaRegistrationTypeCache.xml文件也保存在这个目录下面。

• %Windir%\Microsoft.NET\Framework\v{version}\Temporary ASP.NET Files\{appname}\...\...\UserCache\
• %Windir%\Microsoft.NET\Framework\v{version}\Temporary ASP.NET Files\root\...\...\UserCache\

对针对Web应用被启动后的第一个请求时，Controller激活系统会读取这个用于缓存所有Controller类型列表的ControllerTypeCache.xml文件并反序列化成一个List<Type>对象。只有在该列表为空的时候才会通过遍历程序集和反射的方式得到所有实现了接口IController的公有类型，而被解析出来的Controller类型重写被写入ControllerTypeCache.xml文件中。这个通过读取缓存文件或者重新解析出来的Controller类型列表被保存到内容中，在Web应用活动期间内被Controller激活系统所用。

下面的XML片断反映了这个用于Controller类型列表缓存的ControllerTypeCache.xml文件的结构，我们可以看出它包含了所有的Controller类型的全名和所在的程序集和托管模块信息。

<?xml version="1.0" encoding="utf-8"?>
<!--This file is automatically generated. Please do not modify the contents of this file.-->
<typeCache lastModified="3/22/2012 1:18:49 PM" mvcVersionId="80365b23-7a1d-42b2-9e7d-cc6f5694c6d1">
  <assembly name="Artech.Admin, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null">
    <module versionId="eb343e3f-2d63-4665-a12a-29fb30dceeed">
      <type> Artech.Admin .HomeController</type>
      <type> Artech.Admin .EmployeeController </type>
    </module>
  </assembly>
  <assembly name="Artech.Portal, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null">
    <module versionId=" 3717F116-35EE-425F-A1AE-EB4267497D8C ">
      <type>Artech. Portal.Controllers.HomeController</type>
      <type>Artech. Portal.ProductsController</type>
    </module>
  </assembly>
</typeCache>

三、 Controller的释放

作为激活Controller对象的ControllerFactory不仅仅用于创建目标Controller对象，还具有两个额外的功能，即通过ReleaseController方法对激活的Controller对象进行释放和回收，以及通过GetControllerSessionBehavior返回用于控制当前会话状态行为的SessionStateBehavior枚举。

对于默认使用DefaultControllerFactory来说，针对Controller对象的释放操作很简单：如果Controller类型实现了IDisposable接口，则直接调用其Dispose方法即可；否则直接忽略。我们将这个逻辑也实现在了我们自定义的ReflelctionControllerFactory中。

public class ReflelctionControllerFactory : IControllerFactory
{
    //其他操作
    public void ReleaseController(IController controller)
    {
        IDisposable disposable = controller as IDisposable;
        if (null != disposable)
        {
            disposable.Dispose();
        }
    }
}

四、会话状态行为的控制

至于用于返回SessionStateBehavior枚举的GetControllerSessionBehavior方法来说，在默认的情况下的返回值为SessionStateBehavior.Default。通过前面的介绍我们知道在这种情况下具体的会话状态行为取决于创建的HttpHandler所实现的标记接口。对于ASP.NET MVC应用来说，默认用于处理请求的HttpHandler是一个叫做MvcHandler的对象，如下面的代码片断所示，HttpHandler实现了IRequiresSessionState接口，意味着默认情况下会话状态是可读写的（相当于SessionStateBehavior.Requried）。

public class MvcHandler :
IHttpAsyncHandler,
IHttpHandler,
IRequiresSessionState
{
    //其他成员
}

不过我们可以通过在Controller类型上应用SessionStateAttribute特性来具体控制会话状态行为。如下面的代码片断所示，SessionStateAttribute具有一个SessionStateBehavior类型的只读属性Behavior用于返回具体行为设置的会话状态行为选项，该属性是在构造函数中被初始化的。

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
public sealed class SessionStateAttribute : Attribute
{
    public SessionStateAttribute(SessionStateBehavior behavior);
    public SessionStateBehavior Behavior { get; }
}

也就是说DefaultControllerFactory会通过解析出来的Controller类型得到应用在上面的SessionStateAttribute特性，如果这样的特性存在则直接返回它的Behavior属性所表示的SessionStateBehavior枚举；如果不存在则返回SessionStateBehavior.Default，具体的逻辑反映在我们自定义的ReflelctionControllerFactory的GetControllerSessionBehavior方法中。

public class ReflelctionControllerFactory : IControllerFactory
{
    //其他成员
    public SessionStateBehavior GetControllerSessionBehavior(RequestContext requestContext, string controllerName)
    {
        Type controllerType = this.GetControllerType(requestContext.RouteData, controllerName);
        if (null == controllerType)
        {
            return SessionStateBehavior.Default;
        }
        SessionStateAttribute attribute = controllerType.GetCustomAttributes(true).OfType<SessionStateAttribute>()
           .FirstOrDefault();
        attribute = attribute ?? new SessionStateAttribute(SessionStateBehavior.Default);
        return attribute.Behavior;
    }
}

ASP.NET MVC Controller激活系统详解：总体设计 
ASP.NET MVC Controller激活系统详解：默认实现 
ASP.NET MVC Controller激活系统详解：IoC的应用[上篇] 
ASP.NET MVC Controller激活系统详解：IoC的应用[下篇]

作者：Artech
出处：http://artech.cnblogs.com/
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。