[ASP.NET Web API]如何Host定义在独立程序集中的Controller

[ASP.NET Web API]如何Host定义在独立程序集中的Controller

通过《ASP.NET Web API的Controller是如何被创建的？》的介绍我们知道默认ASP.NET Web API在Self Host寄宿模式下用于解析程序集的AssembliesResolver是一个DefaultAssembliesResolver对象，它只会提供当前应用程序域已经加载的程序集。如果我们将HttpController定义在非寄宿程序所在的程序集中（实际上在采用Self Host寄宿模式下，我们基本上都会选择在独立的项目定义HttpController类型），即使我们将它们部属在宿主程序运行的目录中，宿主程序启动的时候也不会主动去加载这些程序集。由于当前应用程序域中并不曾加载这些程序集，HttpController类型解析将会失败，HttpController的激活自然就无法实现。[本文已经同步到《How ASP.NET Web API Works?》]

我们可以通过一个简单的实例来证实这个问题。我们在一个解决方案中定义了如右图所示的4个项目，其中Foo、Bar和Baz为类库项目，相应的HttpController类型就定义在这3个项目之中。Hosting是一个作为宿主的控制台程序，它具有对上述3个项目的引用。我们分别在项目Foo、Bar和Baz中定义了三个继承自ApiController的HttpController类型FooController、BarController和BazController。如下面的代码片断所示，我们在这3个HttpController类型中定义了唯一的Action方法Get并让它返回当前HttpController类型的AssemblyQualifiedName。

public class FooController : ApiController
{
    public string Get()
    {
        return this.GetType().AssemblyQualifiedName;
    }
}

public class BarController : ApiController
{
    public string Get()
    {
        return this.GetType().AssemblyQualifiedName;
    }
}

public class BarController : ApiController
{
    public string Get()
    {
        return this.GetType().AssemblyQualifiedName;
    }
}

我们在作为宿主的Hosting程序中利用如下的代码以Self Host模式实现了针对Web API的寄宿。我们针对基地址“http://127.0.0.1:3721”创建了一个HttpSelfHostServer，在开启之前我们注册了一个URL模板为“api/{controller}/{id}”的路由。

class Program
{
    static void Main(string[] args)
    {
        Uri baseAddress = new Uri("http://127.0.0.1:3721");
        using (HttpSelfHostServer httpServer = new HttpSelfHostServer(new HttpSelfHostConfiguration(baseAddress)))
        {
            httpServer.Configuration.Routes.MapHttpRoute(
                name             : "DefaultApi",
                routeTemplate    : "api/{controller}/{id}",
                defaults         : new { id = RouteParameter.Optional });

            httpServer.OpenAsync().Wait();
            Console.Read();
        }
    }
}

在启动宿主程序后，我们试图通过浏览器对分别定义在FooController、BarController和BazController中的Action方法Get发起调用，不幸的是我们会得到如图4-4所示的结果。从显示在浏览器中的消息我们很清楚问题的症结所在：根据路由解析得到HttpController名称并不能得到匹配的类型。

导致上述这个问题的原因我们在上面已经分析过了：默认注册的DefaultAssembliesResolver仅仅提供当前应用程序域加载的程序集。我们可以通过自定义的AssembliesResolver来解决这个问题。我们的解决思路是让需要预先加载的程序集可配置，具体来说可以采用具有如下结构的配置来设置需要预先加载的程序集。

<configuration>
   <configSections>
     <section name="preLoadedAssemblies"
              type="Hosting.PreLoadedAssembliesSettings, Hosting"/>
   </configSections>
<preLoadedAssemblies>
  <add assemblyName ="Foo.dll"/>
  <add assemblyName ="Bar.dll"/>
  <add assemblyName ="Baz.dll"/>
</preLoadedAssemblies>
</configuration>

在创建自定义的AssembliesResolver之前我们先得为这段配置定义相应的配置节和配置元素类型。相关的类型（PreLoadedAssembliesSettings、AssemblyElementCollection和AssemblyElement）定义如下所示，由于配置结构比较简单，在这里我们不对它们作详细介绍了。

public class PreLoadedAssembliesSettings: ConfigurationSection
{
    [ConfigurationProperty("", IsDefaultCollection = true)]
    public AssemblyElementCollection AssemblyNames
    {
        get { return (AssemblyElementCollection)this[""]; }
    }

    public static PreLoadedAssembliesSettings GetSection()
    {
        return ConfigurationManager.GetSection("preLoadedAssemblies")
            as PreLoadedAssembliesSettings;
    }
}

public class AssemblyElementCollection : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        return new AssemblyElement();
    }
    protected override object GetElementKey(ConfigurationElement element)
    {
        AssemblyElement serviceTypeElement = (AssemblyElement)element;
        return serviceTypeElement.AssemblyName;
    }
}

public class AssemblyElement : ConfigurationElement
{
    [ConfigurationProperty("assemblyName", IsRequired = true)]
    public string AssemblyName
    {
        get { return (string)this["assemblyName"]; }
        set { this["assemblyName"] = value; }
    }
}

由于我们自定义的AssembliesResolver是对现有DefaultAssembliesResolver的扩展（尽管其程序集提供机制仅仅通过一句代码来实现），我们将类型命名为ExtendedDefaultAssembliesResolver。如下面的代码片断所示，ExtendedDefaultAssembliesResolver继承自DefaultAssembliesResolver，在重写的GetAssemblies方法中我们先通过分析上述的配置并主动加载尚未加载的程序集，然后调用基类的同名方法来提供最终的程序集。

public class ExtendedDefaultAssembliesResolver : DefaultAssembliesResolver
{
    public override ICollection<Assembly> GetAssemblies()
    {
        PreLoadedAssembliesSettings settings = PreLoadedAssembliesSettings.GetSection();
        if (null != settings)
        {
            foreach (AssemblyElement element in settings.AssemblyNames)
            {
                AssemblyName assemblyName = AssemblyName.GetAssemblyName(element.AssemblyName);
                if(!AppDomain.CurrentDomain.GetAssemblies().Any(assembly=>AssemblyName.ReferenceMatchesDefinition(assembly.GetName(),assemblyName)))
                {
                    AppDomain.CurrentDomain.Load(assemblyName);
                }
            }
        }
        return base.GetAssemblies();
    }
}

我们在作为宿主的Hosting程序中利用如下的代码将一个ExtendedDefaultAssembliesResolver对象注册到当前HttpConfiguration的ServicesContainer上。

class Program
{
    static void Main(string[] args)
    {
        Uri baseAddress = new Uri("http://127.0.0.1:3721");
        using (HttpSelfHostServer httpServer = new HttpSelfHostServer(new HttpSelfHostConfiguration(baseAddress)))
        {
            httpServer.Configuration.Services.Replace(typeof(IAssembliesResolver),new ExtendedDefaultAssembliesResolver());
            //其他操作
        }
    }
}

重新启动宿主程序后再次在浏览器输入对应的地址来访问分别定义在FooController、BarController和BazController中的Action方法Get，我们会得到如下图所示的输出结果，这正是目标Action方法执行的结果。

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

 

分类: [02] 编程技巧