WCF配置文件全攻略

最新推荐文章于 2020-04-21 23:41:51 发布

wangboxian

最新推荐文章于 2020-04-21 23:41:51 发布

阅读量2.8k

点赞数

当今的软件系统开发，如果没有配置文件几乎是不可想象的事。没有配置文件，软件如何按照用户的要求对功能进行定制？没有配置文件，在对软件进行配置安装的时候如何根据具体的硬软件环境进行修改？最重要的是没有配置文件，该如何应对软件系统的可扩展要求？不知不觉地，配置文件的编写与管理竟然成了软件开发的重中之重。

WCF作为分布式开发的基础框架，在定义服务以及定义消费服务的客户端时，都使用了配置文件的方法。虽然WCF也提供硬编程的方式，通过在代码中直接设置相关对象的属性来完成服务端与客户端的配置，然而这种方式并不利于后期的更改。无疑，配置文件为WCF带来了软件开发的灵活性，它的使用也是WCF开发过程中最频繁的。

WCF的配置文件共分为两部分：服务端配置与客户端配置。两者由于功能的不同，在配置文件的使用上也略有不同。

1．WCF的服务端配置

服务端的配置文件主要包括endpoint、binding、behavior的配置。一个标准的服务端配置文件所包含的主要xml配置节如下所示：

<system.ServiceModel>

   <services>
      <service>
         <endpoint/>
      </service>
   </services>

   <bindings>
   <!—定义一个或多个系统提供的binding元素，例如<basicHttpBinding> --> 
   <!—也可以是自定义的binding元素，如<customBinding>. -->
      <binding>
      <!—例如<BasicHttpBinding>元素. -->
      </binding>
   </bindings>

   <behaviors>
   <!—一个或多个系统提供的behavior元素. -->
      <behavior>
      <!—例如<throttling>元素. -->
      </behavior>
   </behaviors>

</system.ServiceModel>

1.1 <services>配置节
在<services>配置节中可以定义多个服务，每一个服务都被放到<service>配置节中，WCF的宿主程序可以通过配置文件找到这些定义的服务并发布这些服务。

<service>配置节包含name和behaviorConfiguration属性。其中，name配置了实现Service Contract的类型名。类型名必须是完整地包含了命名空间和类型名。而behaviorConfiguration的配置值则与其后的<behaviors>配置节的内容有关。<endpoint>是<service>配置节的主体，其中，<endpoint>配置节包含了endpoint的三个组成部分：Address、Binding和Contract。由于具体的binding配置是在<bindings>配置节中完成，因而，在<endpoint>中配置了bindingConfiguration属性，指向具体的binding配置。如下所示：

<services>
  <service name="BruceZhang.MyService" behaviorConfiguration="MyBehavior">
    <endpoint address=""
             binding="netTcpBinding"
             bindingConfiguration="DuplexBinding"
             contract="BruceZhang.IHello" />
  </service>
</services>

我们也可以定义多个endpoint，例如：

<services>
  <service 
      name="Microsoft.ServiceModel.Samples.CalculatorService"
      behaviorConfiguration="CalculatorServiceBehavior">
    <endpoint address=""
             binding="wsHttpBinding"
             contract="Microsoft.ServiceModel.Samples.ICalculator" />
    <endpoint address="mex"
             binding="mexHttpBinding"
             contract=" Microsoft.ServiceModel.Samples.IMetadataExchange" />
  </service>
</services>

如果address值为空，那么endpoint的地址就是默认的基地址（Base Address）。例如ICalculator服务的地址就是 http://localhost/servicemodelsamples/service.svc ，而IMetadataExchange服务的地址则为 http://localhost/servicemodelsamples/service.svc/mex 。这里所谓的基地址可以在<service>中通过配置<host>来定义：

<service 
      name="Microsoft.ServiceModel.Samples.CalculatorService"
      behaviorConfiguration="CalculatorServiceBehavior">
<host>
    <baseAddresses>
        <add baseAddress=
"http://localhost/ServiceModelSamples/service.svc"/>
    </baseAddresses>
</host>
<endpoint … />
</service>

1.2 <behaviors>配置节

当我们在定义一个实现了Service Contract的类时， binding和address信息是客户端必须知道的，否则无法调用该服务。然而，如果需要指定服务在执行方面的相关特性时，就必须定义服务的behavior。在WCF中，定义behavior就可以设置服务的运行时属性，甚至于通过自定义behavior插入一些自定义类型。例如通过指定ServiceMetadataBehavior，可以使WCF服务对外公布Metadata。配置如下：

<behaviors>
    <serviceBehaviors>
    <behavior name="metadataSupport">
      <serviceMetadata httpGetEnabled="true" httpGetUrl=""/>
    </behavior>
    <serviceBehaviors>
<behaviors>

在WCF中，behavior被定义为Attribute，其中，System.ServiceModel.ServiceBehaviorAttribute和System.ServiceModel.OperationBehaviorAttribute是最常用的behavior。虽然，behavior作为Attribute可以通过编程的方式直接施加到服务上，但出于灵活性的考虑，将behavior定义到配置文件中才是最好的设计方式。
利用ServiceBehavior与OperationBehavior可以控制服务的如下属性：
1、对象实例的生命周期；
2、并发与异步处理；
3、配置行为；
4、事务行为；
5、序列化行为；
6、元数据转换；
7、会话的生命周期；
8、地址过滤以及消息头的处理；
9、模拟（Impersonation）；

例如，通过ServiceBehavior设置对象实例的生命周期：

<behaviors>
    <serviceBehaviors>
    <behavior name="metadataSupport">
      <instanceContextMode httpGetEnabled="true" httpGetUrl=""/>
    </behavior>
    <serviceBehaviors>
<behaviors>

WCF配置文件详解

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <!-- <system.ServiceModel> section -->
    <system.ServiceModel>
        <!-- services 元素包含应用中驻留的所有service的配置要求 -->
        <services>
            <!-- 每个服务的配置
             属性说明: 
             name - 指定这个service配置是针对的那个服务,为一个实现了某些Contract的服务类的完全限定名
                   (名称空间.类型名),ServiceHost载入一个服务后，会到配置文件中的<services>下找有没有
                   name属性跟服务匹配的<service>的配置 
             behaviorConfiguration - 指定在<serviceBehaviors>下的一个<behavior>的name,这个特定<behavior>
                                     给这个service制定了一些行为,比如服务是否允许身份模拟-->
            <service name="名称空间.类型名" behaviorConfiguration="behavior名">
                <!-- 每个服务可以有多个Endpoint，下面<endpoint>元素对每个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实现 
                 bindingConfiguration - 指定一个binding的配置名称，跟<bindings>下面同类<binding>的name匹配
                 name - Endpoint的名称，可选属性，每个Contract都可以有多个Endpoint，但是每个Contract对应的
                        多个Endpoint名必须是唯一的-->
                <endpoint address="URI" binding="basicHttpBinding" contract="Contract全限定名" bindingConfiguration="binding名" name="">
                    <!-- 用户定义的xml元素集合，一般用作SOAP的header内容-->
                    <headers>
                        <!-- 任何xml内容 -->
                    </headers>
                    <identity>
                        <!-- <identity>下的元素都是可选的-->
                        <userPrincipalName></userPrincipalName>
                        <servicePrincipalName></servicePrincipalName>
                        <dns></dns>
                        <rsa></rsa>
                        <certificate encodedValue=""></certificate>
                        <!-- <certificateReference>的属性都是可选的
                         属性说明：
                         storeName - 证书的存储区，可能值为：AddressBook，AuthRoot，CertificateAuthority
                                     Disallowed，My，Root，TrustedPeople，TrustedPublisher
                         storeLocation - 证书存储位置，可能值为：CurrentUser，LocalMachine-->
                        <certificateReference storeName="" storeLocation="">
                        </certificateReference>
                    </identity>
                </endpoint>
                <host>
                    <baseAddresses>
                        <!-- 在此可以定义每种传输协议的baseAddress，用于跟使用同样传输协议Endpoint定义的相对地
                    址组成完整的地址，但是每种传输协议只能定义一个baseAddress。HTTP的baseAddress同时是service
                    对外发布元数据的URL-->
                        <add baseAddress="http://address" />
                    </baseAddresses>
                    <timeouts></timeouts>
                </host>
            </service>
        </services>

        <bindings>
            <!-- 指定一个或多个系统预定义的binding，比如<basicHttpBinding>，当然也可以指定自定义的customBinding，
             然后在某个指定的binding下建立一个或多个配置，以便被Endpoint来使用这些配置 -->
            <basicHttpBinding>
                <!-- 某一类的binding的下面可能有多个配置，binding元素的name属性标识某个binding-->
                <binding name="binding名">
                </binding>
            </basicHttpBinding>
        </bindings>
        <!-- 定义service和Endpiont行为-->
        <behaviors>
            <!-- 定义service的行为-->
            <serviceBehaviors>
                <!-- 一个或多个系统提供的或定制的behavior元素
                 属性说明：
                 name - 一个behavior唯一标识,<service>元素的behaviorConfiguration属性指向这个name-->
                <behavior name="">
                    <!-- 指定service元数据发布和相关信息
                     属性说明：
                     httpGetEnabled - bool类型的值，表示是否允许通过HTTP的get方法获取sevice的WSDL元数据
                     httpGetUrl - 如果httpGetEnabled为true，这个属性指示使用哪个URL地址发布服务的WSDL，
                                  如果这个属性没有设置，则使用服务的HTTP类型的baseAddress后面加上?WSDL-->
                    <serviceMetadata httpGetEnabled="true" httpGetUrl="http://URI:port/address" />
                </behavior>
            </serviceBehaviors>
            <!-- 定义Endpiont的行为-->
            <endpointBehaviors>
            </endpointBehaviors>
        </behaviors>
        <!-- 包含客户端跟服务端连接使用到的Endpoint的配置 -->
        <client>
            <!-- 每个客户端Endpoint设置
             属性说明：
             address - 对应到服务端这个Endpoint的address
             binding - 指定这个Endpoint使用的binding，这个banding可以是系统预定义的9个binding之一，
                       比如是basicHttpBinding
             contract - 指定这个Endpoint对应的Contract的全限定名(名称空间.类型名)
             name - Endpoint的配置名，客户端代理类的构造方法中的endpointConfigurationName对应到这个name
             bindingConfiguration - 指定客户端binding的具体设置，指向<bindings>元素下同类型binding的name -->
            <endpoint address="URI"
                binding="basicHttpBinding" bindingConfiguration="binding名"
                contract="Contract全限定名" name="endpoint配置名" />
        </client>
    </system.ServiceModel>
</configuration>