WCF服务的批量寄宿

如果采用自我寄宿的方式，我们需要为每个寄宿的服务创建ServiceHost对象。但是一个应用往往具有很多服务需要被发布，基于单个服务的ServiceHost的创建将会变成一个很繁琐的事情。如果我们能够采用某种机制来读取所有配置的服务，并自动为它们创建相应的ServiceHost对象，这无疑是一种理想的方式。[源代码从这里下载]

我想很多人想到了直接读取表示寄宿服务的<system.serviceModel>/<services>/<service>配置元素列表，通过其name配置属性得到表示服务的“类型”，并据此创建相应的ServiceHost对象。这种做法是不被推荐的，原因有二：

<service>配置元素的name属性并不是寄宿服务的类型全名，而是通过ServiceBehaviorAttribute特性对应的服务配置名称；
即使我们不对服务的配置名称作显式设置，让该名称表示成服务类型全名，但是由于它并包含程序集名称，我们往往不得不加载所有可用的程序集。
我们可以将需要需要批量寄宿的服务类型定义在配置文件中。很多人喜欢直接采用<appSettings>作为自定义的配置，但是我个人是既不推荐这种做法的，我觉得自定义结构化的配置节是更好的选择。批量寄宿的服务类型就定义在具有如下结构的 <artech.batchingHosting>配置节下。

[code]      <artech.batchingHosting>

       <add type="Artech.BatchingHosting.FooService, Artech.BatchingHosting"/>

       <add type="Artech.BatchingHosting.BarService, Artech.BatchingHosting"/>

       <add type="Artech.BatchingHosting.BazService, Artech.BatchingHosting"/>

     </artech.batchingHosting>

[/code]

上面XML表示的自定义配置节通过具有如下定义的BatchingHostingSettings表示。BatchingHostingSettings包含一个通过ServiceTypeElementCollection表示的配置元素集合，而具体的配置元素类型为ServiceTypeElement。而ServiceTypeElement的配置ServiceType表示具体的服务类型。

[code]
     public class BatchingHostingSettings: ConfigurationSection

     {

         [ConfigurationProperty("", IsDefaultCollection = true)]

         public ServiceTypeElementCollection ServiceTypes

         {

             get { return (ServiceTypeElementCollection)this[""]; }

         }

      

         public static BatchingHostingSettings GetSection()

         {

             return ConfigurationManager.GetSection("artech.batchingHosting") 

                         as BatchingHostingSettings;

         }

     }

     public class ServiceTypeElementCollection : ConfigurationElementCollection

     {

         protected override ConfigurationElement CreateNewElement()

         {

             return new ServiceTypeElement();

         }

         protected override object GetElementKey(ConfigurationElement element)

         {

             ServiceTypeElement serviceTypeElement = (ServiceTypeElement)element;

             return serviceTypeElement.ServiceType.MetadataToken;

         }

     }

     public class ServiceTypeElement : ConfigurationElement

     {

         [ConfigurationProperty("type",IsRequired = true)]

         [TypeConverter(typeof(AssemblyQualifiedTypeNameConverter))]

         public Type ServiceType

         {

             get { return (Type)this["type"]; }

             set { this["type"] = value; }

         }

     }

[/code]

ServiceTypeElement的ServiceType属性上应用了一个TypeConverterAttribute特性并将类型转换器类型设置为AssemblyQualifiedTypeNameConverter，这是为了让配置系统能够自动实现以字符串表示的配置属性值与Type对象之间的转换。这个类型转换器是我们自定义的，具体定义如下：

[code]
     public class AssemblyQualifiedTypeNameConverter : ConfigurationConverterBase

     {

         public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)

         {

             string typeName = (string)value;

             if (string.IsNullOrEmpty(typeName))

             {

                 return null;

             }

             Type result = Type.GetType(typeName, false);

             if (result == null)

             {

                 throw new ArgumentException(string.Format("不能加载类型\"{0}\"", typeName));

             }

             return result;

         }

         public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)

         {

             Type type = value as Type;

             if (null == type)

             {

                 throw new ArgumentNullException("value");

             }

             return type.AssemblyQualifiedName;

         }

     }

[/code]

真正的服务批量寄宿是通过具有如下定义的ServiceHostCollection来实现的。ServiceHostCollection本质上就是一个ServiceHost的集合，我们可以通过构造函数和自定义的Add方法为指定的一组服务类型创建ServiceHost。在构造函数中，我们通过加载BatchingHostingSettings配置节的方式获取需要批量寄宿的服务类型，并为之创建ServiceHost。

[code]
     public class ServiceHostCollection : Collection<ServiceHost>, IDisposable

     {

         public ServiceHostCollection(params Type[] serviceTypes)

         {

             BatchingHostingSettings settings = BatchingHostingSettings.GetSection();

             foreach (ServiceTypeElement element in settings.ServiceTypes)

             {

                 this.Add(element.ServiceType);

             }

      

             if (null != serviceTypes)

             { 

                 Array.ForEach<Type>(serviceTypes, serviceType=> this.Add(new ServiceHost(serviceType)));

             }

         }

         public void Add(params Type[] serviceTypes)

         {

             if (null != serviceTypes)

             {

                 Array.ForEach<Type>(serviceTypes, serviceType => this.Add(new ServiceHost(serviceType)));

             }

         }

         public void Open()

         {

             foreach (ServiceHost host in this)

             {

                 host.Open();

             }

         }

         public void Dispose()

         {

             foreach (IDisposable host in this)

             {

                 host.Dispose();

             }

         }

     }

[/code]

定义在ServiceHostCollection中的Open方法实现了对所有ServiceHost对象的批量开启。ServiceHostCollection还实现了IDisposable接口，并在Dispose方法中实现了对ServiceHost的批量关闭。

现在我们定义了FooService、BarService和BazService三个服务类型，它们分别实现了契约接口IFoo、IBar和IBar。三个服务以及包含的终结点定义在如下的配置中，而三个服务类型同时被定义在了我们自定义的<artech.batchingHosting>配置节下。

[code]
     <configuration>

       <configSections>

     <section name="artech.batchingHosting"  

         type="Artech.BatchingHosting.Configuration.BatchingHostingSettings, 

                Artech.BatchingHosting"/>

       </configSections>

       <system.serviceModel>

         <services>

           <service name="Artech.BatchingHosting.FooService">

             <endpoint address="http://127.0.0.1:3721/fooservice"

                         binding="ws2007HttpBinding"

                         contract="Artech.BatchingHosting.IFoo"/>

           </service>

           <service name="Artech.BatchingHosting.BarService">

             <endpoint address="http://127.0.0.1:3721/barservice"

                         binding="ws2007HttpBinding"

                         contract="Artech.BatchingHosting.IBar"/>

           </service>

           <service name="Artech.BatchingHosting.BazService">

             <endpoint address="http://127.0.0.1:3721/bazservice"

                         binding="ws2007HttpBinding"

                         contract="Artech.BatchingHosting.IBaz"/>

           </service>

         </services>

       </system.serviceModel>

       <artech.batchingHosting>

         <add type="Artech.BatchingHosting.FooService, Artech.BatchingHosting"/>

         <add type="Artech.BatchingHosting.BarService, Artech.BatchingHosting"/>

         <add type="Artech.BatchingHosting.BazService, Artech.BatchingHosting"/>

       </artech.batchingHosting>

     </configuration>

[/code]

要实现针对三个服务的批量寄宿，我们只需要创建ServiceHostCollection对象并开启它即可。为了确认三个服务对应的ServiceHost确实被创建并被开启，我通过如下的代码注册了ServiceHostCollection中每个ServiceHost的Opened事件。当该事件触发时，会在控制台上打印一段文字。

[code]
     using (ServiceHostCollection hosts = new ServiceHostCollection())

     {

         foreach (ServiceHost host in hosts)

         {

             host.Opened += (sender, arg) => Console.WriteLine("服务{0}开始监听", 

                 (sender as ServiceHost).Description.ServiceType);

         }

         hosts.Open();

         Console.Read();

     }

[/code]

上面这段代码执行之后，控制台上将会具有如下一段输出文字，这充分证明了我们对三个服务成功地进行了批量寄宿。

[code]
     服务Artech.BatchingHosting.FooService开始监听

     服务Artech.BatchingHosting.BarService开始监听

     服务Artech.BatchingHosting.BazService开始监听

[/code]