WCF技术内幕之契约

最新推荐文章于 2023-05-10 10:46:19 发布

原创最新推荐文章于 2023-05-10 10:46:19 发布 · 224 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#WCF

读书笔记专栏收录该内容

10 篇文章

订阅专栏

WCF契约会把.NET类型映射为特定的消息结构。为了说明这个问题，考虑一个订餐的例子，它包括请求、确认和取消服务三项功能。服务由一个地址为http://contoso.com/reseruations的终结点组成。终结点展示了三个操作：RequestReservation、ChangeReservation和CancelReservation。RequestReservation和ChangeReservation操作使用请求/应答消息交换模式，CancelReservation使用数据报消息交换模式。

契约的定义

契约是消息参与者之间的约定。这种约定可为Web服务展示的操作命名、定义和提供地址。在这种情况下，它要描述服务里的每个操作、每个操作的消息交换模式以及操作支持的消息结构。

WCF契约是标注了特定属性的.NET类型，而且这些被标注的类型定义可以用来产生符合行业标准的WSDL和XSD文档。WCF契约会把这些类型映射为服务、操作、消息和消息中的部分。WCF有5中类型的契约：服务契约、操作契约、数据契约、消息契约和错误契约。服务契约映射类型到服务定义，并且映射类型成员到服务操作；数据契约和消息契约映射类型到服务操作的消息定义。与数据契约相比，消息契约提供了对整个消息定义的控制。数据契约会映射为消息类型的消息体成员，而消息契约会映射为消息类型的消息头和消息体成员。

WCF契约剖析

在契约定义中以属性标注来区分服务契约、数据契约和消息契约。

服务契约

服务契约描述的是一个服务。它包括服务定义的各个方面、服务的操作、每个操作的消息交换模式及每个操作使用的消息。创建服务契约的第一步就是建立操作的名字和使用的消息交换模式。以餐馆为例，服务可以定义如下：

[ServiceContract]
public interface IaurantService
{
    [OperationContract]
    int RequestReservation(DateTime? resDateTime, string aurantName, string partyName);
    [OperationContract]
    void ChangeReservation(int? reservationId, DateTime? resDateTime);
    [OperationContract(IsOneWay =true)]
    void CancelReservation(int? reservationId);
}

操作契约

服务契约包含服务中操作的描述信息。当描述服务契约中的操作时，有必要先描述操作的消息交换模式、操作接收的消息结构和操作发送的消息结构。如果服务契约是标注的类型或接口定义，操作也会在标注服务契约的类型或接口中标注。下面来看餐馆服务的例子：

[ServiceContract]
public interface IaurantService
{
    [OperationContract]
    int RequestReservation(DateTime? resDateTime, string aurantName, string partyName);
    [OperationContract]
    void ChangeReservation(int? reservationId, DateTime? resDateTime);
    [OperationContract(IsOneWay =true)]
    void CancelReservation(int? reservationId);
}

数据契约

数据契约会把.NET类型映射到消息体上，而且它是消息序列化和反序列化的关键部分。数据契约可以单独使用，但通常都是在服务契约的操作中使用。与服务契约类型一样，数据契约也是使用属性标注定义。数据契约中重要的属性就是DataContractAttribute和DataMemberAttribute。

    [DataContract]
    class RequestReservationParams
    {
        [DataMember(Name ="resDateTime")]
        private DateTime? _resDateTime;
        [DataMember(Name = "aurantName")]
        private String _aurantName;
        [DataMember(Name = "partyName")]
        private string _partyName;

        public RequestReservationParams(DateTime? resDateTime,string aurantName,string partyName)
        {
            this._resDateTime = resDateTime;
            this._aurantName = aurantName;
            this._partyName = partyName;
        }

        public DateTime? ResDateTime
        {
            get { return _resDateTime; }
        }
        public string aurantName
        {
            get { return _aurantName; }
        }
        public string PartyName
        {
            get { return _partyName; }
        }
    }

消息契约

最后一个WCF契约就是消息契约。与数据契约相比，对于序列化数据的内容，消息契约提供了更多的控制，因为消息契约定义了消息体的消息头。此外，消息契约提供了在序列化期间进行安全机制的功能。创建一个消息契约和创建一个数据契约十分类似，消息契约也是通过标注属性定义的，并且在服务契约的操作里使用。

[MessageContract(WrapperName ="ChangeReservationNewDateTime")]
    public sealed class ChangeReservationNewDateTime
    {
        [MessageHeader(Name ="reservationId",MustUnderstand =true)]
        private int? _reservationId;
        [MessageBodyMember]
        private DateTime? _newDateTime;
        public ChangeReservationNewDateTime() { }
        public ChangeReservationNewDateTime(int? reservationId,DateTime? newDateTime)
        {
            this._newDateTime = newDateTime;
            this._reservationId = reservationId;
        }
        public int? ReservationId
        {
            get { return _reservationId; }
        }
        public DateTime? NewDateTime
        {
            get { return _newDateTime; }
        }

    }

从契约定义到契约对象

WCF契约仅仅是一个带有标注属性的类型。用来标注的类型定义本身没有任何意义，因为这些标注影响的仅仅是元数据本身的变化，契约上的标注属性可以改变契约定义的元数据，而反射又恰恰是运行时读取元数据的方式，因此，要想把WCF契约转化为一种有意义的描述数据，就需要使用反射。WCF基础结构定义了几个可以使用反射读取契约元数据的类型，这些类型决定了构建什么样的终结点。

System.ServiceModel.Description.ContractDescription

System.ServiceModel.Description.OperationDescription

System.ServiceModel.Description.MessageDescription