第六讲：数据契约

代码

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

---

再将数据契约之前，我们想说一下  序列化

大部分的系统都是以数据为中心的，功能的实现表现在对相关数据的正确处理方面。一个分布式的互联网系统关注于数据的交换，而数据正常交换的根本前提是参与数据交换的双方对于数据的结构一致性理解，这就为数据的表现提出了要求，为了保证处于不同平台，不同厂商的应用能够正常进行数据交换，交换的数据必须采用一种大家都能够理解的展现方式。在这种方面，XML无疑是最好的选择。所以WCF下的序列化解决的就是如何将数据从对象的变现形式转变成XML的表现形式，以确保数据的正常交换。WCF主要通过数据契约来定义通过服务操作进行交换的数据。WCF 的序列化和反序列化解决的是托管对象与XML之间的转换，以实现与厂商无关，跨平台的数据交换。所以基于XML的数据表示能够实现跨平台的数据交换，在于XML是一种被不同的厂商普遍接受和易于理解的数据表示。WCF以XML的形式进行数据交换，一方传输的XML能够被另一方正确理解，同样需要交换双方就传递的XML结构达成一致的理解。具体采用怎样地实现描述XML的结构呢？XSD无疑是最好的选择。在WCF中，服务契约借助WSDL的形式实现对服务的描述，同理，数据契约通过XSD实现对数据的描述.

数据契约

一个正常的服务调用要求客户端和服务端对服务操作有一致的理解，WCF通过服务契约对服务操作进行抽象，以一种与平台无关的，能够被不同的厂商理解的方式对服务进行描述。同理，客户端和服务端进行有效的数据交换，同样要求交换双方对交换数据的结构达成共识。WCF通过数据契约来对交换的数据进行描述。与数据契约的定义相匹配，WCF采用新的序列化器---数据契约序列化器(DataContractSerializer)进行基于数据契约的序列化与反序列化.数据契约是描述数据的结构，数据交换只有在双方对数据结构具有相同的理解下才能正常进行。对于数据的接受方来讲，当它接收到数据时，只有借助于数据结构的描述，才能理解数据的每个元素所承载的信息。由于数据交换通过XML表示，XSD用于定义XML的结构，所以XSD可以看作是数据契约在SOA下的表现形式.

数据契约的定义

同服务契约类似，WCF采用了基于特性的数据契约定义方式。基于数据契约的自定义特性主要包含以下两个DataContractAttribute和DataMemberAttribute。

1.DataContractAttribute：将目标类型定义成一个数据契约

2.DataMemberAttribute:将字段或属性变成数据契约的数据成员

接下来 我们做个关于 数据契约的 小Demo，  网盘 自己找

首先我们看下 项目的结构

[ 6-01 ]

ContentTypes:数据契约层

GigEntry：客户端

GigManager：服务契约层  （ 这里 把服务契约的 实现 也写到了 这里。当然 也可以把它分开 ）

Hosting：服务器寄宿

在看下我们的 服务契约：

[ 6-02 ]

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using ContentTypes;

namespace GigManager
{

    [ServiceContract(Name = "GigManagerServiceContract", Namespace = "http://www.HulkXu.com/")]
    public interface IGigManagerService
    {
        //注意 如果不实用数据契约，无法传入复杂的对象，就如下面的 SaveGig 方法的 参数 是一个  ListItem 类型的参数
        [OperationContract]
        void SaveGig(ListItem item);
        [OperationContract]
        ListItem GetGig();
    }

    /// <summary>
    /// 这里为实现了 IGigManagerService 这个服务契约
    /// </summary>
    public class GigManagerService : IGigManagerService
    {
        private ListItem m_listItem;
        /// <summary>
        /// 将我们得到的 对象传给   m_listItem
        /// </summary>
        /// <param name="item"></param>
        public void SaveGig(ListItem item)
        {
            m_listItem = item;
        }

        /// <summary>
        /// 获取我们上面的 得到的 m_listItem 
        /// </summary>
        /// <returns></returns>
        public ListItem GetGig()
        {
            return m_listItem;
        }
    }
}

注意看 上面的  ListItem 参数，这个参数是一个复杂类型的参数，因为是我们自己定义的参数。

在来看我们的 服务器寄宿：

代码 （ 没有什么变化 ）

[ 6-03 ]

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;

namespace Hosting
{
    class Program
    {
        static void Main(string[] args)
        {
            using (ServiceHost host = new ServiceHost(typeof(GigManager.GigManagerService)))
            {
                host.Open();
                Console.WriteLine();
                Console.WriteLine("服务已经启动");
                Console.ReadLine();
            }
        }
    }
}

Appconfig的配置

[ 6-04 ]

 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.serviceModel>
    <services>
      <service name="GigManager.GigManagerService" behaviorConfiguration="serviceBehavior">
        <!--配置一个TCP协议的相对地址-->
        <endpoint address="GigManagerService" contract="GigManager.IGigManagerService" binding="netTcpBinding"></endpoint>
        <!--这里是一个固定的写法，用于发布TCP协议的 服务契约  （使用HTTP协议的方式展现出来）-->
        <endpoint contract="IMetadataExchange" binding="mexHttpBinding" address="mex"></endpoint>
        <host>
          <baseAddresses>
            <!--WSDL呈现地址-->
            <add baseAddress="http://127.0.0.1:8000"/>
            <add baseAddress="net.tcp://127.0.0.1:9000"/>
          </baseAddresses>
        </host>
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <behavior name="serviceBehavior">
          <serviceMetadata httpGetEnabled="true"/>
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

<endpoint contract="IMetadataExchange" binding="mexHttpBinding" address="mex"></endpoint> 这个节点呢  是 用于我们  在浏览器中  去查看  元数据（WSDL） 的，注意它是一个固定的写法，也就是看服务契约以WSDL形式发布出来的呈现

它通过我们配置的地址来访问

<add baseAddress="http://127.0.0.1:8000"/>

为什么这么做？因为TCP协议的 方式  你怎么查看  WSDL的文档，只有通过 HTTP方式  在浏览器上  去查看。

再接下来看我们的  数据契约了：

之前我们看到 服务契约 的  SaveGig 方法，需要传入  一个 复杂类型 ListItem，而这个复杂类型就是我们自己定义的类。

这里我们需要将这个复杂类型变成我们的 数据契约

再之前我们通过查看描述数据契约的WSDL文档中的XSD（定义WSDL的文档）发现，每一个数据成员的命名习惯同类型定义中的属性相同。而且，序列中的每一个元素的顺序是字母顺序，与其在类型定义中出现的顺序相反。另一件值得注意的事

情就是，该类型的命名空间同服务契约目标命名空间不匹配。 它使用的是shemas.datacontract.org

这些都可以在数据契约中解决：

DataMember:相应的属性

Name:控制生成的模式元素名称。默认时使用CLR中定义的名称。

IsRequired:为模式元素控制minOccurs属性。默认时所有的元素都是可选的(minOccurs=0)

Order:控制模式中每一个元素的次序。默认时无序的数据成员按照字母顺序排序。

[ 6-05 ]

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

namespace ContentTypes
{

    /// <summary>
    /// 这里主要是WCF 序列化 该类
    /// 这么想，客户端直接引用 ContentTypes 层 然后 直接 调用 服务端的方法传递 这个复杂的参数（ListItem） ，WCF 会根据这里定义好的数据契约 直接序列化成对应的XML传送到服务端。
    /// </summary>
    [DataContract(Namespace = "http://www.HulkXu.com/")]
    //[DataContract]
    public class ListItem
    {
        [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; }
        }

    }
}

最后我们看我们的客户端：

客户端是一个 Form 的  应用程序

界面

[ 6-06 ]

 

代码：

[ 6-07 ]  

 

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using GigEntry.localhost;

namespace GigEntry
{
    public partial class Form1 : Form
    {
        //创建代理对象
        localhost.GigManagerServiceContractClient proxy = new GigManagerServiceContractClient();

        public Form1()
        {
            InitializeComponent();
            
        }

        /// <summary>
        /// 保存 
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void cmdSave_Click(object sender, EventArgs e)
        {
            //这里WCF不再需要序列化 ListItem 这个参数了，因为 在  ContentTypes 层的 ListItem.cs 类中。我们已经定义好 这个类的序列化规则了
            ListItem item = new ListItem();
            item.Id = int.Parse(this.txtId.Text);
            item.Title = this.txtTitle.Text;
            item.Description = this.txtDescription.Text;
            item.DateStart = this.dtpStart.Value;
            item.DateEnd = this.dtpEnd.Value;
            item.Url = this.txtUrl.Text;
            proxy.SaveGig(item);
        }

        /// <summary>
        /// 获取
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void cmdGet_Click(object sender, EventArgs e)
        {
            ListItem item = proxy.GetGig();
            if (item != null)
            {
                this.txtId.Text = item.Id.ToString();
                this.txtTitle.Text = item.Title;
                this.txtDescription.Text = item.Description;
                this.dtpStart.Value = item.DateStart;
                this.dtpEnd.Value = item.DateEnd;
                this.txtUrl.Text = item.Url;

            }
        }

      
    }
}

appconfig 配置：

这里的配置  是我们 添加了  服务引用  自动生成 的 ，可以不管

[ 06-08 ]

 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <system.serviceModel>
        <bindings>
            <netTcpBinding>
                <binding name="NetTcpBinding_GigManagerServiceContract" closeTimeout="00:01:00"
                    openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"
                    transactionFlow="false" transferMode="Buffered" transactionProtocol="OleTransactions"
                    hostNameComparisonMode="StrongWildcard" listenBacklog="10"
                    maxBufferPoolSize="524288" maxBufferSize="65536" maxConnections="10"
                    maxReceivedMessageSize="65536">
                    <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="16384"
                        maxBytesPerRead="4096" maxNameTableCharCount="16384" />
                    <reliableSession ordered="true" inactivityTimeout="00:10:00"
                        enabled="false" />
                    <security mode="Transport">
                        <transport clientCredentialType="Windows" protectionLevel="EncryptAndSign" />
                        <message clientCredentialType="Windows" />
                    </security>
                </binding>
            </netTcpBinding>
        </bindings>
        <client>
            <endpoint address="net.tcp://127.0.0.1:9000/GigManagerService"
                binding="netTcpBinding" bindingConfiguration="NetTcpBinding_GigManagerServiceContract"
                contract="localhost.GigManagerServiceContract" name="NetTcpBinding_GigManagerServiceContract">
                <identity>
                    <userPrincipalName value="20080904-1145Administrator" />
                </identity>
            </endpoint>
        </client>
    </system.serviceModel>
</configuration>

运行程序后 Hosting 服务器寄宿  然后在浏览器中 输入  http://127.0.0.1:8000  我们配置好的 WSDL呈现地址

[ 06-09 ]

 

[ 06-10 ]

 

[ 06-11 ]

 

[ 06-12 ]

看 06-12 图，我们很清楚的看到了  将 ListItem 类型 序列化成 XML 的形式

---

根据上面的 代码 ，我们将  数据契约 ListItem类的成员上面的 特性  [DataMember(Name = "Id", IsRequired = false, Order = 0)]  都去掉 ，换成 [DataMember]

[ 6-13 ]

再次 根据 运行 Hosting 服务器寄宿  然后在浏览器中 输入  http://127.0.0.1:8000   从图片  06-09 开始  到 06-12  的操作步奏 进行一次。

仔细观察 与之前 的 是否不太一样？

例如 这里的名字？

[ 6-14 ]

例如 这些字段的排序顺序？

[ 6-15 ]

等等，这里我就不贴 测试的图片了。自己下去试一试。