WCF系列（二） -- 使用配置文件构建和使用WCF服务

当然，配置一个ServiceHost除了上面说的完全使用代码的方式，更好的方式是使用配置文件，把一些可能需要修改的属性跟代码分离，放到配置文件中，这样可以提供服务配置的灵活性，也更容易维护。

看看前面那个不用配置文件的WCF的例子改成使用配置文件会是怎样配置的。

1、服务端

1.1.    准备Contract和实现Contract的服务

这部分是功能接口和功能实现部分，不需要配置，所以这部分跟前面一样。

[ServiceContract()]

 public interface IService

 {

     [OperationContract]

     string MyOperation1(string myValue);

 }

 public class Service : IService

 {

     public string MyOperation1(string myValue)

     {

         return "Hello: " + myValue;

     }

}

 

1.2.    建立ServiceHost

前面使用public ServiceHost(Type serviceType, params Uri[] baseAddresses)构造方法建立ServicesHost。

这里建立ServiceHost实例也必须使用代码，但是可以使用简单些的构造方法：

 

ServiceHost myServiceHost = new ServiceHost(typeof(Service))

 

只要给ServiceHost指定你要运行服务的类型，就是告诉要驻留在ServiceHost里的哪个WCF服务（实现某个或某些Contract的类）。BaseAddress部分这里不需要指定了，可以放在配置文件里。

 

编码部分就这些，剩下的部分都只要通过配置文件进行设置即可。

 

1.3.    WCF配置

WCF的配置使用.NET Framework的System.Configuration配置系统。在Visual Studio中配置一个WCF服务时，如果宿主是一般的windows应用或console应用，则配置文件为App.confing，，如果宿主是IIS应用，则配置文件为Web.config。

 

跟WCF相关的配置主要有三个元素：

<system.serviceModel>

<system.serviceModel.activation>

<system.runtime.serialization>

这三个元素都是.NET Framework配置文件的根元素<configuration>下的元素，其中<system.serviceModel>元素最为基本，WCF的基本设置集中在这个元素中。

 

看一下<system.serviceModel>元素的简单结构：

<configuration>

    <system.serviceModel>

        <!-- services 元素包含应用中驻留的所有service的配置要求 -->

        <services>

        </services>

        <!--定义service和Endpiont行为-->

        <behaviors>

        </behaviors>

        <bindings>

        </bindings>

        <!--定义客户端的配置-->

        <client>

        </client>

    </system.serviceModel>

</configuration>

 

1.4.    建立跟ServiceHost相配的service配置

前面已经在代码中建立了ServiceHost，并指定了这个ServiceHost中要驻留的服务类型。

在<services>标签下加一个<service>标签，注意，service的name属性应该是ServiceHost中驻留那个服务的全限定名，即名称空间加类名，表示这个service元素下的设置是针对这个服务的。

<services>

    <servicename="WCFService.Service">

        <host>

            <baseAddresses>

                <addbaseAddress="http://localhost:8080/WCFService/Service" />

            </baseAddresses>

        </host>

    </service>

</services>

在<service>元素下加<host>元素，这里要增加的是baseAddress，跟使用代码一样，baseAddress可以有多个，用add标签增加，但是同样的通讯协议只能有一个baseAddress，比如http的只能有一个，https的只能有一个。

 

1.5.    给service增加Endpoint

本例中WCF服务对外只有一个Endpoint，在<service>元素下增加<endpoint>元素，Endpoint的三个基本要素address、binding、contract都是<endpoint>元素属性，当然它还有其他属性，这里先不提及，只描述完成这个简单实例相关的设置。

address - 指定这个Endpoint对外的URI,这个URI可以是个绝对地址，也可以是个相对于baseAddress的相对地址。如果此属性为空，则这个Endpoint的地址就是baseAddress。

binding - 指定这个Endpoint使用的binding，这个banding可以是系统预定义的9个binding之一，比如是basicHttpBinding，也可以是自定义的customBinding。binding决定了通讯的类型、安全、如何编码、是否基于session、是否基于事务等等。

contract - 指定这个Endpoint对应的Contract的全限定名(名称空间.类型名)，这个Contract应该被service元素的name指定的那个service实现。

<services>

    <servicebehaviorConfiguration="NewBehavior"name="WCFService.Service">

        <endpointaddress=""binding="basicHttpBinding"contract="WCFService.IService" />

    </service>

</services>

 

1.6.    设置允许发布元数据

设置允许通过WSDL对外暴露对服务的Metadata。

是通过设置服务端行为的<serviceBehaviors>标签下增加一个<behavior>，一个可以定义<behavior>一组服务端的行为设置，可以设置一个或多个系统提供的或定制的表示服务端行为的元素。

Name属性，一个behavior唯一标识,<service>元素的behaviorConfiguration属性指向这个name，即表示这个service使用这个behavior的配置。

<serviceMetadata>标签，指定service元数据发布和相关信息。

httpGetEnabled 属性是bool类型的值，表示是否允许通过HTTP的get方法获取sevice的WSDL元数据。

httpGetUrl 属性，如果httpGetEnabled为true，这个属性指示使用哪个URL地址发布服务的WSDL，如果这个属性没有设置，则使用服务的HTTP类型的baseAddress后面加上?WSDL。

<behaviors>

    <serviceBehaviors>

        <behaviorname="NewBehavior">

            <serviceMetadatahttpGetEnabled="true"httpGetUrl="http://localhost:8001/" />

        </behavior>

    </serviceBehaviors>

</behaviors>

 

2、客户端

2.1.    引用service

客户端要访问服务端的服务，首先要知道服务端的服务提供了什么方法，就是要知道服务的Contract。如何取得服务端的Contract有几种方法，前一篇文章有讲述，这里不再赘述，这里同样采用最方便的在项目中添加Service reference来引用service。

在vs2005中安装了WCF的extention后，在项目的References上点击右键，会多出来一个“Add Service Reference”的选项，这就是用来引用WCF服务的，引用地址就是服务端设置的http的baseAddress。

在这里引用WCF服务，跟使用Svcutil.exe命令一样，会在项目中生成同样的两个文件。

2.2.    生成客户端service代理实例和配置文件

引用服务后，客户端生成了配置文件和包含了Contract和本地代理类的cs文件。

引用WCF服务后，还会在同时给每个Contract不同的Endpoint生成一个继承自System.ServiceModel.ClientBase的本地代理类。

客户端可以直接使用多个重载的代理类构造方法实例化这些代理类。如果要使用配置文件，有这么几个构造方法可用：

1、public ServiceClient()

2、public ServiceClient(string endpointConfigurationName)

3、public ServiceClient(string endpointConfigurationName, string remoteAddress)

4、public ServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)

看一下，引用WCF后生成的配置文件中Client部分的内容，这部分包含客户端跟服务端连接使用到的Endpoint的配置：

 

<client>

    <endpointaddress="http://localhost:8080/WCFService/Service"

        binding="basicHttpBinding"bindingConfiguration="BasicHttpBinding_IService"

        contract="WCFClient.localhost.IService"name="BasicHttpBinding_IService" />

</client>

 

实际上，客户端代理类是从某个它对应的那个Contract继承的，所以客户端代理类本身一定是跟某个Contract相关的。

如果客户端配置文件中这个代理类对应的Contract只有一个Endpoint配置，那么可以使用第一个构造方法，运行时，会根据代理类的Contract在配置文件中相应的配置。

如果客户端配置文件这个代理类对应的Contract有多个Endpoint配置，可以使用第二个构造方法，通过endpointConfigurationName参数指定使用哪一个Endpoint的配置。

 

对于本例，只有一个Contract，引用WCF服务后也只生成一个Endpoint配置，使用最简单的构造方法即可：

localhost.ServiceClient proxy = new localhost.ServiceClient();

string result = proxy.MyOperation1("myFirstWCF");

 

使用配置文件的例子代码下载：

http://files.cnblogs.com/chnking/ConfigWCF.rar