第八讲：数据契约版本控制

代码

https://yunpan.cn/cPns5DkGnRGNs   密码：3913

---

 

数据契约是对用于交换的数据结构的描述，是数据序列化和反序列的依据。

在一个WCF应用中，客户端和服务端必须通过等效的数据契约进行有效的数据交换。随着时间的推移，不可避免的，我们会面临着数据契约版本的变化。比如数据成员的添加和删除等。

 

数据契约版本的差异最主要的表现形式是数据成员的添加和删除。如何保证在数据契约中添加一个新的数据成员，或者是从数据契约中删除一个现有的数据成员的情况下，还能保证现有客户端的正常服务调用（对于服务提供者），或者对现有服务的正常调用（针对服务消费者），这是数据契约版本控制要解决的问题。

 

例如：这个  场景描述

 

    /// <summary>
    /// 版本V1
    /// </summary>

    [DataContract]
    public class CustomerV1
    {
        [DataMember]
        public string Name { get; set; }
        [DataMember]
        public string PhoneNo { get; set; }
        [DataMember]
        public string Address { get; set; }
    }

    /// <summary>
    /// 版本V2
    /// </summary>
    [DataContract]
    public class CustomerV2
    {
        [DataMember]
        public string Name { get; set; }
        [DataMember]
        public string PhoneNo { get; set; }

    }

 

数据契约成员的移除导致在发送—回传过程中数据的丢失问题。客户端基于数据契约CustomerV1进行服务调用，而服务的实现却是基于CustomerV2的，那么序列化的CustomerV1对象生成的XML通过消息传到服务端，服务端会按照CustomerV2进行反序列化，毫无疑问Address的数据会丢失。如果Customer的信息需要返回到客户端，服务需要对CustomerV2对象进行序列化，则序列化生成的XML肯定没有Address数据成员存在。当回复消息返回到客户端时，客户端按照CustomerV1进行反序列化生成CustomerV1对象，会发现原本赋了值的Address属性现在变成了null。

对于客户端来说，这是一件怪事也是不可接受的事情：“为何数据经过发送—回传后会无缘无故的丢失呢”？

 

 

为了解决这个问题

WCF定义了一个特殊的接口System.Runtime.Serialization.IExtensibleDataObject,该接口中仅仅定义了一个ExtensionDataObject类型属性成员，对于实现了IExtensibleDataObject的数据契约，WCF在进行序列化时会将ExtensionData属性的值也序列化到XML；在反序列化过程中，如果发现XML包含有数据契约中没有的数据，会将多余的数据进行反序列化，并将其放入ExtensionData属性中保存起来，由此解决数据丢失的问题。

---

 

 

我们可以测试一下，根据第六讲的  1.数据契约基本的使用  的  代码  进行 测试。

打开  ContentTypes 项目下的 ListItem 数据契约类，注释在该类的最后一个属性  Url  

[ 8-01 ]

 

然后我们将整个项目  重新生成一遍，然后 启动 Hosting，启动WinFrom（这里先不不要 更新服务引用 ）  ，在文本框中输入  响应的  字符串

点击 保存 按钮，最后点击 获取 按钮。

这个时候你会发现 你刚才输入的   网站  的 文本框中 的 字符串消失了。

 

这是因为服务器 是按照 你刚才改动的  数据契约  进行响应的处理，而客户端 再你没有 更新服务引用的情况下 ，是用的  之前的 数据契约  进行  传递数据的 ， 之前的 数据契约 有 Url 这个属性，但是  服务器 修改后  的 服务契约 中是 没有 Url 这个属性的。

那客户端 我传了  Url  的值，凭什么 返回来  就没有数据了？难道  你服务器  版本更新了，我就也要  进行版本更新？  那 万一  别的很多已经下载过  你的软件，而因为你的服务器更新，就不能用了吗？这样肯定不行。

 

这样说把，服务器版本更新了，无非就是  数据契约  新增了 属性 或者  删除了属性。  那我客户端没有更新，客户端的版本比服务器版本低。 客户端 传了 某个 服务器已经删除的 属性，服务器你不管，忽略就是了，但是 服务器回传的 时候 一定也要把 我这个被你忽略的 属性 值  给 原样返回就是了。

同理，如果服务器要是增加了 新的属性，我客户端是老版本没有这个最新的数据契约的 属性，那客户端不知道有这个属性，就不传，服务端的这个属性会是个NULL 。

 

如何做呢？

让我们的  数据契约 去继承  IExtensibleDataObject  这个接口，并且实现该接口

 

[ 8-02 ]

 

 

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Runtime.Serialization;

namespace ContentTypes
{
    [DataContract(Namespace = "http://www.HulkXu.com/")]
    //[DataContract]
    public class ListItem : IExtensibleDataObject
    {
        [DataMember(Name = "Id", IsRequired = false, Order = 0)]
        //[DataMember]
        private long m_id;

        public long Id
        {
            get { return m_id; }
            set { m_id = value; }
        }
        //[DataMember]
        [DataMember(Name = "Title", IsRequired = true, Order = 1)]
        private string m_title;

        public string Title
        {
            get { return m_title; }
            set { m_title = value; }
        }
        //[DataMember]
        [DataMember(Name = "Description", IsRequired = true, Order = 2)]
        private string m_description;

        public string Description
        {
            get { return m_description; }
            set { m_description = value; }
        }
        //[DataMember]
        [DataMember(Name = "DateStart", IsRequired = true, Order = 3)]
        private DateTime m_dateStart;

        public DateTime DateStart
        {
            get { return m_dateStart; }
            set { m_dateStart = value; }
        }
        //[DataMember]
        [DataMember(Name = "DateEnd", IsRequired = false, Order = 4)]
        private DateTime m_dateEnd;

        public DateTime DateEnd
        {
            get { return m_dateEnd; }
            set { m_dateEnd = value; }
        }


        //删除
        //[DataMember]
        //[DataMember(Name = "Url", IsRequired = false, Order = 5)]
        //private string m_url;

        //public string Url
        //{
        //    get { return m_url; }
        //    set { m_url = value; }
        //}


        //添加
        //[DataMember(IsRequired=true)]
        //private string address;
        //public string Address
        //{
        //    get { return address; }
        //    set { address = value; }
        //}
        //public ExtensionDataObject ExtensionData
        //{
        //    get;
        //    set;
        //}


        public ExtensionDataObject ExtensionData
        {
            get;
            set;
        }


    }
}

 

 

好的 ，关于  数据契约版本控制  就是这些了，比较简单。