WCF服务端开发和客户端引用小结

Posted 2020-09-08 钢笔水

1.服务端开发

1.1 WCF服务创建方式

       创建一个WCF服务，总是会创建一个服务接口和一个服务接口实现。通常根据服务宿主的不同，有两种创建方式。

       （1）创建WCF应用程序

        通过创建WCF服务应用程序，可生成一个带.svc后缀名的文件。该文件与webform中的aspx文件类似，有后置代码，这些后置代码是服务接口的实现。这种方式创建的WCF服务都承载在IIS或WAS上。

       （2）创建WCF服务库

         WCF服务库是一个类库，如前所述包含一个服务接口和服务实现，此种方式创建的WCF服务可根据需要寄宿在windows客户端、windows服务、控制台程序等宿主上。

1.2 WCF服务的协议

       协定定义了服务端可以提供的功能和客户端可以使用的功能，它独立于服务实现代码，可分为如下5种协定类型。

（1）数据协定

        主要用于定义在服务端和客户端之间传输的复杂数据类型。对复杂数据类型定义数据协定，主要适用于客户端与服务端共享协定程序集的情况，而如果客户端是添加引用的方式来创建服务代理，则未必要专门定义数据协定。数据协定的类用[DataContract]特性标记，其内部要序列化的属性必须用[DataMember]特性标记。

注：webservice采用XML序列化，此种序列化只序列化公共字段和属性，因此如对复杂数据类型不特别定义数据协定，则会采用这种序列化方式。

（2）服务协定和操作协定

         服务协定和操作协定是最重要的两个协定，创建一个WCF服务肯定有这两个协定。

         服务协定用于定义描述了服务的WSDL，它通常为一个接口（也可以为一个类），用[ServiceContract]特性标明。操作协定在服务协定里面，定义了服务的操作，并用[OperationContract]特性标明。

         ServiceContract和OperationContract有几个比较重要的属性，如下

协 定	属 性	描 述
ServiceContract	SessionMode	定义该服务协定是否允许有会话，其值用SessionMode枚举定义，包括Allowed、NotAllowed、Required。
OperationContract	IsOneWay	是否单向操作，单向操作时，客户端不会等待服务端的回应，一般可用于无返回值的操作。
	IsInitiating	当前操作是否启动一个新会话。
	IsTerminating	当前操作是否关闭会话。

 

（3）消息协定

        可以指定传输的数据哪些是放在soap的标题中，哪些是在正文中。消息协定的数据类用[MessageContract]标明，类中放在soap标题和正文中的成员用[MessageHeader]和[MessageBodyMember]标明。

（4）错误协定

        默认情况下，为了安全性，在服务端出现的错误不返回客户端，但也可以把包含有用信息的错误返回给调用者。若要将错误返回客户端，可在webConfig中将serviceDebug小节的includeExceptionDetailInFaults属性设为true。强类型化的soap错误协定可以用数据协定定义，并在相应操作协定中用[FaultContract]特性标明，并在该特性的属性中标明错误的类型。

1.3 WCF服务宿主

        WCF的服务宿主比较丰富，可以是WAS（Windows Activation Service，Windows激活服务）、IIS、Windows应用程序、Windows服务、控制台应用程序等。

在创建WCF服务时，若创建的是WCF应用程序，则其服务后缀名带.svc，其宿主为IIS或WAS。若创建的是WCF服务库，则其通过实例化ServiceHost，并调用其对象的open()方法，可以寄宿在任意宿主上，且其相关绑定、端点等配置可以用写代码实现（给ServiceHost对象属性赋值），而不必在webConfig中进行配置（）。       

1.4 WCF服务的服务端配置文件

       WCF服务端和客户端的配置都可以在其应用程序配置文件的“system.serviceModel”小节。该小节下的配置项主要由bindings、behaviors和services，其中bindings和behaviors是为services小节服务的。

（1）bindings

　　　bindings小节用来定义绑定，所定义的绑定可添加到service的endpoint小节的bindingConfiguration属性中。当然，该节也可以直接去掉，因为.net预定义了一些绑定，所以endpoint小节中直接使用这些预定义的绑定就可以了。

（2）behaviors

       behaviors小节可定义客户端是否允许通过添加引用获取元数据，服务端报错时，客户端是否也允许看到报错等。

 

（3）services

      services小节定义了所提供的服务，其下可以有多个service，每个service下主要有两个子节点：host和endpoint。host可定义服务的基地址，且如果服务要支持多种传输协议的话，也可以有多个基地址。服务端点需要配置服务的相对地址、绑定和服务协定（如果定义了特殊的绑定和行为，则还需将这些特殊的绑定和行为加进来）。而如果服务是自宿主的话，还需另加一个mex端点，用来客户端获取元数据。

     *Wcf的配置，除了手动在应用程序的配置文件里配置外，VS还专门提供了一个可视化工具（WCF服务配置编辑器，在工具菜单下）来进行配置。

2.客户端开发

2.1 客户端引用

      客户端通过生成WCF服务的代理，来调用服务所提供的一些方法。客户端生成代理的方式有两种：

     （1）通过获取wsdl生成代理类：客户端通过vs添加引用，去访问服务端的WSDL文档，并生成一个代理类。      

     （2）通过共享协定程序集生成代理：客户端引用服务协定的程序集，通过使用ChanelFactory<TChanel>类写代码来生成服务代理，从而调用服务的方法。ChanelFactory<TChanel>类的构造函数需要传绑定信息和端点地址来进行实例化并创建信道，服务用完后，其对象还要调用close()方法关闭信道。

2.2 客户端配置

      客户端需配置一个与服务端保持一致的端点（在client小节下），端点中需配置的属性包括服务地址、服务绑定、服务协定等。