理解WCF中的Contracts

WCF中的Contracts

WCF通过Contract来说明服务和操作，一般包含五种类型的Contract：ServiceContract，OperationContract，FaultContract，DataContract，MessageContract。

 

1.ServiceContract

ServiceContract向外部暴漏了可以提供的服务接口，它可以包含服务名称、命名空间等服务器端的配置信息。

[ServiceContract]
interface IMyContract
{
 [OperationContract]
 string MyMethod();
}

class MyService : IMyContract
{
 public string MyMethod()
 {
 return "Hello World";
 }
}

 

2.OperationContract

OperationContract定义在ServiceContract的内部，定义了具体的服务操作。在此基础上，可以对操作的事务，绑定（One-way,Two-way等）和FaultContract信息。

 

[ServiceContract]
interface IMyContract
{
[FaultContract(typeof(MyFaultContract))]
[OperationContract]
string MyMethod();
}

 

3.Data Contract

定义了服务器和客户端交互的内容，它可以标识类，以便作为OperationContract的参数或者返回类型。

[DataContract]
class Person
{
 [DataMember]
 public string ID;
 [DataMember]
 public string Name;
}

[ServiceContract]
interface IMyContract
{
 [OperationContract]
 Person GetPerson(int ID);
}

 

4.MessageContract

当OperationContract需要传递参数或者返回值时，可以使用MessageContract。它可以定义消息的Header和Body，以及安全性等。

[ServiceContract]
public interface IRentalService
{
 [OperationContract]
 double CalPrice(PriceCalculate request);
}

[MessageContract]
public class PriceCalculate
{
 [MessageHeader]
 public MyHeader SoapHeader { get; set; }
 [MessageBodyMember]
 public PriceCal PriceCalculation { get; set; }
}

[DataContract]
public class MyHeader
{
 [DataMember]
 public string UserID { get; set; }
}

[DataContract]
public class PriceCal
{
 [DataMember]
 public DateTime PickupDateTime { get; set; }
 [DataMember]
 public DateTime ReturnDateTime { get; set; }
 [DataMember]
 public string PickupLocation { get; set; }
 [DataMember]
 public string ReturnLocation { get; set; }
 }

 

5.FaultContract

FaultContract定义了服务可能出现的异常信息，以及服务队错误的处理和错误信息抛出到客户端的内容。一个OperationContact可以包含0个或多个FaultContract。

[ServiceContract]
interface IMyContract
{
 [FaultContract(typeof(MyFaultContract1))]
 [FaultContract(typeof(MyFaultContract2))]
 [OperationContract]
 string MyMethod();

 [OperationContract]
 string MyShow();
 }

 

MessageContract和DataContract的比较

区别

DataContract提供了一种将.net的CLR类型映射为可以被其他应用程序识别的基于W3C的Xml的方法，使得不同的应用间无须考虑对应使用的是什么类型的数据，而只需关注这些被抽象的Xml信息。

MessageContract则描述了SOAP消息的结构，最终在服务器和客户端进行传递，因此能够对SOAP信息的Header和Bodies进行直接的访问和处理，可以对复杂的类型进行处理。

 

为什么需要或者什么时候使用MessageContract

MessageContract一般只在你需要对消息体进行直接控制的时候使用，例如添加特定的Header，Footer等信息。在一些场合，如果需要在消息中包含Session相关的信息时，通过Header进行传递，则无需像消息体中增加额外的参数。或者有时你需要提供一个自定义的安全协议或者在应用间传递身份令牌。

当然，使用MessageContract时需要从SOAP Header中检索信息，而不是直接序列化后进行处理。

 

不要混用MessageContract和DataContract

对于一个OperationContract来说，不要在参数和返回值中分别使用MessageContract和DataContract，否则在生成WSDL时会引起运行时错误。