[WCF 学习笔记] 2. 服务契约

 

契约(Contract)是 WCF 的消息标准，告知客户端如何与服务器联系交互。契约是平台中立的，也就说我们可以使用其它平台(包括开发和系统平台)来调用服务。WCF 中包含 4 种契约，分别是用于定义服务操作(Operations)的 Service Contract，定义自定义数据结构的 Data Contract，定义错误异常的 Fault Contract，以及直接控制消息格式的 Message Contract。本文只是简要说明一下 Service Contract 和 Data Contract，其他几种的使用方式将在后面的章节中进行。

一般情况下，我们用接口(Interface)来定义服务契约(Service Contract)。虽然我们也可以使用 Class，但使用接口的好处更明显一些。

• 便于契约的继承，不同根的类型可以自由实现相同的契约。
• 同一服务类型可以实现多个契约。
• 和接口隔离原则相同，我们随时可以修改服务类型。
• 便于制定版本升级策略，让新老版本的服务契约同时使用。

WCF 使用特性 ServiceContractAttribute 标定服务契约，OperationContractAttribute 标定服务方法。

[ServiceContract]
public interface ICalculate
{
  [OperationContract]
  double Add(double a, double b);
}

OperationContract 只能用于 Method，只有添加了此特性的方法才能被客户端调用。它甚至可以用来标注私有方法，这显然超出了面向对象的规则，而更多的是 SOA 的方式。SOA 只是分布式系统的架构体系，在架构体系内部我们依然采取面向对象的原则来编码，所以标注私有方法是不被推荐的，这也是使用接口作为服务契约的一个好处(接口中无法定义私有方法)。

我们还可以使用 DataContractAttribute、DataMemberAttribute 来标注自定义数据类型，这样我们就可以在服务方法中传递复杂的数据体了。使用之前，我们需要添加 System.Runtime.Serialization.dll 引用。由此我们可以看出其基本的开发模式，那就是使用 ServiceContract、OperationContract 执行运算，而使用 DataContract、DataMember 作为可序列化的数据载体。当然，我们也可以使用 "[Serializable]" 代替 "[DataContract]"。

[DataContract]
public struct Number
{
  [DataMember]
  public double Num1;

  [DataMember]
  public double Num2;

  public Number(double num1, double num2)
  {
    this.Num1 = num1;
    this.Num2 = num2;
  }
}

[ServiceContract]
public interface ICalculate
{
  [OperationContract]
  double Add(Number number);
}

以下是相关特性参数的简单说明，在后面的章节中在详细探讨其使用方法。

ServiceContract

• ConfigurationName： 其设置信息在配置文件中的名称。
• Name / Namespace：自定义该服务契约的名称和命名空间。建议设置服务契约的 Name 和 Namespace，这样生成的客户端的代理文件会使用自定义名称来命名相关代理类型，即便我们日后对服务器端的契约名称进行重构也不会影响到客户端。
• SessionMode：设置服务契约的 Session 方式，包括 Allowe、NotAllowed、Required。SessionMode 需要相应的 Binding 支持，默认情况下会自动启用，另外我们还会和 ServiceBehaviorAttribute.InstanceContextMode 配合使用来管理服务对象的生命周期。
• CallbackContract：设置 duplex 模式时的回调类型。
• ProtectionLevel：指定消息保护方式，可以对消息进行加密和签名处理。

OperationContract

• AsyncPattern：用于定义异步服务方法。
• IsInitiating：指示服务方法能否启动一个 Session。
• IsTerminating：指示服务方法调用完成是否结束 Session。

DataContract

• Name / Namespace：自定义名称和命名空间。

DataMember

• Name：自定义名称。
• IsRequired：指示该成员序列化前必须被赋值。