WCF 服务的ABC之契约(七)

契约 Contract

WCF的所有服务都会公开为契约(Contract),契约与平台无关,是描述服务功能的标注方式。

服务契约(Service Contract)

  • 服务契约描述的是一个服务,它定义了 服务向外界公开的功能,这些功能表现为服务操作(Service Operation)。服务契约包括服务定义的各个方面、服务的操作、每个操作的消息交换模式以及每个操作使用的消息。

数据契约(Data Contract)

  • 数据契约定义了与服务交互的数据类型。
  • WCF把内建类型隐式定义为数据契约,也可以将自定义类型定义为数据契约

错误契约(Fault Contract)

  • 错误契约定义了服务抛出的错误,以及服务处理错误和传递错误到客户端的方式

消息契约(Message Contract)

  • 消息契约允许服务直接与消息交互,可以是类型化的,也可以是非类型化的。
  • 倘若消息交互的另一端规定了某些显式(通常是专有的)消息格式,在这种要求互操作性的场景下,消息契约将非常有用。

ServiceContract(服务协定)

全名:System.ServiceModel.ServiceContractAttribute

功能:指示接口或类在应用程序中定义服务协定。

简单一句话:标识此接口是否是服务协定,是否需要公开为服务。

详细:使用接口(或类)上的 ServiceContractAttribute 属性定义服务协定。然后使用一个或多个类(或接口)方法中的 OperationContractAttribute 属性定义协定的服务操作。实现服务协定后并将其与binding和 EndpointAddress 对象一起使用时,此服务协定将公开以供客户端使用。

使用规则:

  • ConfigurationName 属性指定要使用的配置文件中的服务元素的名称。
  • Name 和 Namespace 属性控制 WSDL <portType> 元素中的协定名称和命名空间。
  • SessionMode 属性指定协定是否需要支持会话的绑定。
  • CallbackContract 属性指定双向(双工)对话中的返回协定。
  • HasProtectionLevel 和 ProtectionLevel 属性指示是否所有支持协定的消息都具有一个显式 ProtectionLevel 值,如果有,处于什么级别。

OperationContract(操作协定)

全名: System.ServiceModel.OperationContractAttribute

作用:指示方法定义一个操作,该操作是应用程序中服务协定的一部分。

简单一句话:标识哪些操作属于服务协定一部分。如果不设置该属性,使用者则看不到此方法。

使用 OperationContractAttribute 属性控制该操作的结构以及以元数据表示的值:

  • Action 属性指定唯一标识该操作的操作。 根据请求消息的操作将它们调度至方法。
  • AsyncPattern 属性指示使用 Begin/End 方法对可以实现或异步调用该操作。
  • HasProtectionLevel 属性指示是否已显式设置 ProtectionLevel 属性。
  • IsOneWay 属性指示该操作只包含单个输入消息。该操作没有关联的输出消息。
  • IsInitiating 属性指定该操作是否可以是会话中的初始操作。
  • IsTerminating 属性指定该操作完成后, 是否试图终止当前会话。
  • ProtectionLevel 属性指定运行时操作要求的消息级安全性。
  • ReplyAction 属性指定该操作答复消息的操作。

DataContract(数据协定)

全名:System.Runtime.Serialization.DataContractAttribute

功能:指定该类型要定义或实现一个数据协定,并可由序列化程序(如 DataContractSerializer)进行序列化。若要使其类型可序列化,类型作者必须为其类型定义数据协定。

简单一句话:定义数据协定,用于数据传输。

DataMember(数据成员协定)

全名:  System.Runtime.Serialization.DataMemberAttribute

功能:指定该成员是数据协定的一部分并可由 DataContractSerializer 进行序列化。

简单一句话:标识数据协定的成员

FaultContract(错误契约)

默认情况下,服务抛出传递到客户端的异常均为FaultException类型,即使在服务器抛出FaultException<T>的情况下也是如此。其原因在与服务希望与客户端共享的基于错误之上的任何异常都必须属于服务契约行为的一部分,从而使得服务能够通知WCF它希望能够穿透错误的屏蔽。为此,WCF提供了错误契约,通过它可以列出服务能够抛出的错误类型。这些错误类型的类型参数应该与FaultException<T>使用的类型参数相同。只是他们在错误契约中列出,WCF客户端就能够分辨契约错误与其它错误之间的区别。

上一篇:Codewars练习笔记·1 - 6.23


下一篇:开源库支付库Magicodes.Pay发布