DataContractAttribute 类

定义

public ref class DataContractAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)]
public sealed class DataContractAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)>]
type DataContractAttribute = class
    inherit Attribute

Public NotInheritable Class DataContractAttribute
Inherits Attribute

继承

Object

Attribute

DataContractAttribute

属性

AttributeUsageAttribute

示例

以下示例序列化和反序列化已应用该类的类PersonDataContractAttribute。 请注意，属性NamespaceName已设置为替代默认设置的值。

namespace DataContractAttributeExample
{
    // Set the Name and Namespace properties to new values.
    [DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
    class Person : IExtensibleDataObject
    {
        // To implement the IExtensibleDataObject interface, you must also
        // implement the ExtensionData property.
        private ExtensionDataObject extensionDataObjectValue;
        public ExtensionDataObject ExtensionData
        {
            get
            {
                return extensionDataObjectValue;
            }
            set
            {
                extensionDataObjectValue = value;
            }
        }

        [DataMember(Name = "CustName")]
        internal string Name;

        [DataMember(Name = "CustID")]
        internal int ID;

        public Person(string newName, int newID)
        {
            Name = newName;
            ID = newID;
        }
    }

    class Test
    {
        public static void Main()
        {
            try
            {
                WriteObject("DataContractExample.xml");
                ReadObject("DataContractExample.xml");
                Console.WriteLine("Press Enter to end");
                Console.ReadLine();
            }
            catch (SerializationException se)
            {
                Console.WriteLine
                ("The serialization operation failed. Reason: {0}",
                  se.Message);
                Console.WriteLine(se.Data);
                Console.ReadLine();
            }
        }

        public static void WriteObject(string path)
        {
            // Create a new instance of the Person class and
            // serialize it to an XML file.
            Person p1 = new Person("Mary", 1);
            // Create a new instance of a StreamWriter
            // to read and write the data.
            FileStream fs = new FileStream(path,
            FileMode.Create);
            XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
            DataContractSerializer ser =
                new DataContractSerializer(typeof(Person));
            ser.WriteObject(writer, p1);
            Console.WriteLine("Finished writing object.");
            writer.Close();
            fs.Close();
        }
        public static void ReadObject(string path)
        {
            // Deserialize an instance of the Person class
            // from an XML file. First create an instance of the
            // XmlDictionaryReader.
            FileStream fs = new FileStream(path, FileMode.OpenOrCreate);
            XmlDictionaryReader reader =
                XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());

            // Create the DataContractSerializer instance.
            DataContractSerializer ser =
                new DataContractSerializer(typeof(Person));

            // Deserialize the data and read it from the instance.
            Person newPerson = (Person)ser.ReadObject(reader);
            Console.WriteLine("Reading this object:");
            Console.WriteLine(String.Format("{0}, ID: {1}",
            newPerson.Name, newPerson.ID));
            fs.Close();
        }
    }
}

Namespace DataContractAttributeExample
    ' Set the Name and Namespace properties to new values.
    <DataContract(Name := "Customer", [Namespace] := "http://www.contoso.com")>  _
    Class Person
        Implements IExtensibleDataObject
        ' To implement the IExtensibleDataObject interface, you must also
        ' implement the ExtensionData property.
        Private extensionDataObjectValue As ExtensionDataObject 
        
        Public Property ExtensionData() As ExtensionDataObject _
          Implements IExtensibleDataObject.ExtensionData
            Get
                Return extensionDataObjectValue
            End Get
            Set
                extensionDataObjectValue = value
            End Set
        End Property
        
        <DataMember(Name := "CustName")>  _
        Friend Name As String
        
        <DataMember(Name := "CustID")>  _
        Friend ID As Integer
        
        
        Public Sub New(ByVal newName As String, ByVal newID As Integer) 
            Name = newName
            ID = newID
        
        End Sub 
    End Class 
    
    
    Class Test
        
        Public Shared Sub Main() 
            Try
                WriteObject("DataContractExample.xml")
                ReadObject("DataContractExample.xml")
                Console.WriteLine("Press Enter to end")
                Console.ReadLine()
            Catch se As SerializationException
                Console.WriteLine("The serialization operation failed. Reason: {0}", _
                   se.Message)
                Console.WriteLine(se.Data)
                Console.ReadLine()
            End Try
        
        End Sub 
        
        
        Public Shared Sub WriteObject(ByVal path As String) 
            ' Create a new instance of the Person class and 
            ' serialize it to an XML file.
            Dim p1 As New Person("Mary", 1)
            ' Create a new instance of a StreamWriter
            ' to read and write the data.
            Dim fs As New FileStream(path, FileMode.Create)
            Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
            Dim ser As New DataContractSerializer(GetType(Person))
            ser.WriteObject(writer, p1)
            Console.WriteLine("Finished writing object.")
            writer.Close()
            fs.Close()
        
        End Sub 
        
        Public Shared Sub ReadObject(ByVal path As String) 
            ' Deserialize an instance of the Person class 
            ' from an XML file. First create an instance of the 
            ' XmlDictionaryReader.
            Dim fs As New FileStream(path, FileMode.OpenOrCreate)
            Dim reader As XmlDictionaryReader = XmlDictionaryReader. _
              CreateTextReader(fs, New XmlDictionaryReaderQuotas())
            
            ' Create the DataContractSerializer instance.
            Dim ser As New DataContractSerializer(GetType(Person))
            
            ' Deserialize the data and read it from the instance.
            Dim newPerson As Person = CType(ser.ReadObject(reader), Person)
            Console.WriteLine("Reading this object:")
            Console.WriteLine(String.Format("{0}, ID: {1}", newPerson.Name, newPerson.ID))
            fs.Close()
        
        End Sub 
    End Class 
End Namespace

注解

将 DataContractAttribute 特性应用于由 DataContractSerializer 在序列化和反序列化操作中使用的类型（类、结构或枚举）。 如果使用 Windows Communication Foundation（WCF）基础结构来发送或接收消息，则还应将 DataContractAttribute 应用于保存及操控消息中发送数据的任何类。 有关数据协定的详细信息，请参阅 “使用数据协定”。

您还必须将 DataMemberAttribute 应用于包含您想要序列化的值的任何字段、属性或事件。 通过应用DataContractAttribute，您可以显式启用DataContractSerializer的序列化和反序列化功能。

有关数据协定的详细信息，请参阅 “使用数据协定”中列出的主题。

数据协定

数据协定是一组字段的抽象说明，其中包含每个字段的名称和数据类型。 数据协定存在于任何单个实现之外，以允许不同平台上的服务进行互作。 只要服务之间传递的数据符合同一协定，所有服务都可以处理数据。 此处理也称为 松散耦合系统。 数据协定也类似于接口，该协定指定如何传递数据，以便应用程序可以处理数据。 例如，数据协定可能会调用名为“Person”的数据类型，该数据类型具有两个文本字段，名为“FirstName”和“LastName”。 若要创建数据协定，请将 DataContractAttribute 应用于类，并将 DataMemberAttribute 应用于任何必须序列化的字段或属性。 序列化后，数据符合隐式内置到类型中的数据协定。

XML 架构文档和 SvcUtil 工具

如果要与其他服务交换数据，则必须描述数据协定。 对于当前版本的 DataContractSerializerXML 架构，可用于定义数据协定。 （其他类型的元数据/说明可用于同一目的。若要从应用程序创建 XML 架构，请使用 ServiceModel 元数据实用工具工具（Svcutil.exe） 和 /dconly 命令行选项。 默认情况下，当工具的输入是程序集时，该工具将生成一组 XML 架构，用于定义该程序集中找到的所有数据协定类型。 相反，还可以使用 Svcutil.exe 工具创建 Visual Basic 或 C# 类定义，这些定义符合使用可由数据协定表示的构造的 XML 架构的要求。 在这种情况下，不需要 /dconly 命令行选项。

如果对 Svcutil.exe 工具的输入是 XML 架构，则默认情况下，该工具将创建一组类。 如果您检查这些类，您会发现 DataContractAttribute 已被应用。 可以使用这些类创建新的应用程序来处理必须与其他服务交换的数据。

还可以针对返回 Web 服务描述语言（WSDL）文档的终结点运行该工具，以自动生成代码和配置以创建 Windows Communication Foundation （WCF） 客户端。 生成的代码包括用 DataContractAttribute.. 标记的类型。

重用现有类型

数据协定有两个基本要求：稳定名称和成员列表。 稳定名称由命名空间统一资源标识符（URI）和协定的本地名称组成。 默认情况下，在将类应用于 DataContractAttribute 类时，它将类名用作本地名称，类的命名空间（前缀为 "http://schemas.datacontract.org/2004/07/"）作为命名空间 URI。 可以通过设置 Name 和 Namespace 属性来替代默认值。 您还可以通过将 ContractNamespaceAttribute 应用于命名空间来更改命名空间。 当你有一个现有类型可以完全按照要求处理数据，但它具有与数据契约不同的命名空间和类名时，请使用此功能。 通过重写默认值，可以重复使用现有类型，并使序列化数据符合数据协定。

版本管理

数据协定还可以与其自身的后续版本兼容。 也就是说，当更高版本的协定包含额外的数据时，该数据将存储和返回给未接触的发送方。 为此，请实现 IExtensibleDataObject 接口。

有关版本控制的详细信息，请参阅 数据协定版本控制。

另请参阅

• IExtensibleDataObject
• ExtensionDataObject
• DataContractSerializer
• DataMemberAttribute
• ISerializable
• KnownTypeAttribute
• 使用数据协定