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

Примеры

В следующем примере сериализуется и десериализируется класс с именем Person , к которому DataContractAttribute применен этот класс. Обратите внимание, что Namespace для свойств Name заданы значения, которые переопределяют параметры по умолчанию.

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

При обмене данными с другими службами необходимо описать контракт данных. Для текущей DataContractSerializerверсии схемы XML можно использовать для определения контрактов данных. (Другие формы метаданных и описания могут использоваться для той же цели.) Чтобы создать xml-схему из приложения, используйте средство служебной программы метаданных ServiceModel (Svcutil.exe) с параметром командной строки /dconly . Если входные данные средства являются сборкой, по умолчанию средство создает набор xml-схем, определяющих все типы контрактов данных, найденные в этой сборке. И наоборот, можно также использовать средство Svcutil.exe для создания определений классов Visual Basic или C#, которые соответствуют требованиям xml-схем, использующих конструкции, которые могут быть выражены контрактами данных. В этом случае параметр командной строки /dconly не требуется.

Если входные данные для инструмента Svcutil.exe являются XML-схемой, по умолчанию средство создает набор классов. При изучении этих классов вы обнаружите, что DataContractAttribute было применено. Эти классы можно использовать для создания нового приложения для обработки данных, которые необходимо обмениваться с другими службами.

Вы также можете запустить средство на конечной точке, которая возвращает документ языка описания веб-служб WSDL, чтобы автоматически создать код и конфигурацию для генерации клиента Windows Communication Foundation (WCF). Созданный код включает типы, помеченные атрибутом DataContractAttribute.

Повторное использование существующих типов

Контракт данных имеет два основных требования: стабильное имя и список членов. Стабильное имя состоит из универсального идентификатора ресурса пространства имен (URI) и локального имени контракта. По умолчанию, при применении DataContractAttribute к классу, в качестве локального имени используется имя класса, а пространство имен класса, с префиксом "http://schemas.datacontract.org/2004/07/", используется в качестве URI пространства имен. Вы можете переопределить значения по умолчанию, задав свойства Name и Namespace. Вы также можете изменить пространство имен, применяя ContractNamespaceAttribute к нему. Используйте эту возможность, если у вас есть существующий тип, который обрабатывает данные точно так же, как требуется, но имеет другое пространство имен и имя класса из контракта данных. Переопределив значения по умолчанию, можно повторно использовать существующий тип и иметь сериализованные данные в соответствии с контрактом данных.

Versioning

Контракт данных также может поддерживать последующие версии самого себя. То есть, когда более поздняя версия контракта включает дополнительные данные, эти данные хранятся и возвращаются отправителю, нетронутому. Для этого реализуйте IExtensibleDataObject интерфейс.

Дополнительные сведения об использовании версий см. в разделе "Управление версиями контракта данных".

См. также раздел

• IExtensibleDataObject
• ExtensionDataObject
• DataContractSerializer
• DataMemberAttribute
• ISerializable
• KnownTypeAttribute
• Использование контрактов данных