DataContractSerializer Sınıf

Tanım

public ref class DataContractSerializer sealed : System::Runtime::Serialization::XmlObjectSerializer

public sealed class DataContractSerializer : System.Runtime.Serialization.XmlObjectSerializer

type DataContractSerializer = class
    inherit XmlObjectSerializer

Public NotInheritable Class DataContractSerializer
Inherits XmlObjectSerializer

Devralma

Object

XmlObjectSerializer

DataContractSerializer

Örnekler

Aşağıdaki örnek kod Person , tarafından seri hale getirilen adlı bir türü gösterir DataContractSerializer .The following example code shows a type named Person that is serialized by the DataContractSerializer. DataContractAttributeÖzniteliği sınıfına uygulanır ve DataMemberAttribute seri hale getirilecek öğeleri bildirmek için üyelere uygulanır DataContractSerializer .The DataContractAttribute attribute is applied to the class, and the DataMemberAttribute is applied to members to instruct the DataContractSerializer what to serialize.

namespace DataContractSerializerExample
{
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.Runtime.Serialization;
    using System.Xml;

    // You must apply a DataContractAttribute or SerializableAttribute
    // to a class to have it serialized by the DataContractSerializer.
    [DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
    class Person : IExtensibleDataObject
    {
        [DataMember()]
        public string FirstName;
        [DataMember]
        public string LastName;
        [DataMember()]
        public int ID;

        public Person(string newfName, string newLName, int newID)
        {
            FirstName = newfName;
            LastName = newLName;
            ID = newID;
        }

        private ExtensionDataObject extensionData_Value;

        public ExtensionDataObject ExtensionData
        {
            get
            {
                return extensionData_Value;
            }
            set
            {
                extensionData_Value = value;
            }
        }
    }

    public sealed class Test
    {
        private Test() { }

        public static void Main()
        {
            try
            {
                WriteObject("DataContractSerializerExample.xml");
                ReadObject("DataContractSerializerExample.xml");
            }

            catch (SerializationException serExc)
            {
                Console.WriteLine("Serialization Failed");
                Console.WriteLine(serExc.Message);
            }
            catch (Exception exc)
            {
                Console.WriteLine(
                "The serialization operation failed: {0} StackTrace: {1}",
                exc.Message, exc.StackTrace);
            }

            finally
            {
                Console.WriteLine("Press <Enter> to exit....");
                Console.ReadLine();
            }
        }

        public static void WriteObject(string fileName)
        {
            Console.WriteLine(
                "Creating a Person object and serializing it.");
            Person p1 = new Person("Zighetti", "Barbara", 101);
            FileStream writer = new FileStream(fileName, FileMode.Create);
            DataContractSerializer ser =
                new DataContractSerializer(typeof(Person));
            ser.WriteObject(writer, p1);
            writer.Close();
        }

        public static void ReadObject(string fileName)
        {
            Console.WriteLine("Deserializing an instance of the object.");
            FileStream fs = new FileStream(fileName,
            FileMode.Open);
            XmlDictionaryReader reader =
                XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
            DataContractSerializer ser = new DataContractSerializer(typeof(Person));

            // Deserialize the data and read it from the instance.
            Person deserializedPerson =
                (Person)ser.ReadObject(reader, true);
            reader.Close();
            fs.Close();
            Console.WriteLine(String.Format("{0} {1}, ID: {2}",
            deserializedPerson.FirstName, deserializedPerson.LastName,
            deserializedPerson.ID));
        }
    }

' You must apply a DataContractAttribute or SerializableAttribute
' to a class to have it serialized by the DataContractSerializer.
<DataContract(Name := "Customer", [Namespace] := "http://www.contoso.com")>  _
Class Person
    Implements IExtensibleDataObject
    <DataMember()>  _
    Public FirstName As String
    <DataMember()>  _
    Public LastName As String
    <DataMember()>  _
    Public ID As Integer
    
    Public Sub New(ByVal newfName As String, ByVal newLName As String, ByVal newID As Integer) 
        FirstName = newfName
        LastName = newLName
        ID = newID
    End Sub 
    
    Private extensionData_Value As ExtensionDataObject
    
    Public Property ExtensionData() As ExtensionDataObject Implements _
       IExtensibleDataObject.ExtensionData
        Get
            Return extensionData_Value
        End Get
        Set
            extensionData_Value = value
        End Set
    End Property
End Class 


NotInheritable Public Class Test
    
    Private Sub New() 
    
    End Sub 
     
    Public Shared Sub Main() 
        Try
            WriteObject("DataContractSerializerExample.xml")
            ReadObject("DataContractSerializerExample.xml")
        
        Catch serExc As SerializationException
            Console.WriteLine("Serialization Failed")
            Console.WriteLine(serExc.Message)
        Catch exc As Exception
            Console.WriteLine("The serialization operation failed: {0} StackTrace: {1}", exc.Message, exc.StackTrace)
        
        Finally
            Console.WriteLine("Press <Enter> to exit....")
            Console.ReadLine()
        End Try
    End Sub 
    
    Public Shared Sub WriteObject(ByVal fileName As String) 
        Console.WriteLine("Creating a Person object and serializing it.")
        Dim p1 As New Person("Zighetti", "Barbara", 101)
        Dim writer As New FileStream(fileName, FileMode.Create)
        Dim ser As New DataContractSerializer(GetType(Person))
        ser.WriteObject(writer, p1)
        writer.Close()
    End Sub 

    Public Shared Sub ReadObject(ByVal fileName As String) 
        Console.WriteLine("Deserializing an instance of the object.")
        Dim fs As New FileStream(fileName, FileMode.Open)
        Dim reader As XmlDictionaryReader = _
            XmlDictionaryReader.CreateTextReader(fs, New XmlDictionaryReaderQuotas())
        Dim ser As New DataContractSerializer(GetType(Person))
        
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = CType(ser.ReadObject(reader, True), Person)
        reader.Close()
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.ID))
    End Sub 
End Class 

Açıklamalar

DataContractSerializerBir türün örneklerini BIR XML akışına veya belgeye seri hale getirmek ve seri durumdan çıkarmak için sınıfını kullanın.Use the DataContractSerializer class to serialize and deserialize instances of a type into an XML stream or document. Örneğin, Person ad ve adres gibi önemli verileri içeren özelliklerle adlı bir tür oluşturabilirsiniz.For example, you can create a type named Person with properties that contain essential data, such as a name and address. Daha sonra sınıfın bir örneğini oluşturup işleyebilir Person ve daha sonra alımı için bir XML belgesinde veya anında aktarım için bir XML akışında tüm özellik değerlerini yazabilirsiniz.You can then create and manipulate an instance of the Person class and write all of its property values in an XML document for later retrieval, or in an XML stream for immediate transport. En önemlileri, DataContractSerializer Windows Communication Foundation (WCF) iletilerinde gönderilen verileri seri hale getirmek ve seri durumdan çıkarmak için kullanılır.Most important, the DataContractSerializer is used to serialize and deserialize data sent in Windows Communication Foundation (WCF) messages. DataContractAttribute DataMemberAttribute Sınıf üyelerine özniteliği ve seri hale getirilen özellikleri ve alanları belirtmek için özniteliğini uygulayın.Apply the DataContractAttribute attribute to classes, and the DataMemberAttribute attribute to class members to specify properties and fields that are serialized.

Seri hale getirilebilen türlerin listesi için bkz. veri sözleşmesi serileştiricisi tarafından desteklenen türler.For a list of types that can be serialized, see Types Supported by the Data Contract Serializer.

Öğesini kullanmak için DataContractSerializer , önce bir sınıf örneği ve biçimi yazmak veya okumak için uygun bir nesne oluşturun; örneğin, bir örneği XmlDictionaryWriter .To use the DataContractSerializer, first create an instance of a class and an object appropriate to writing or reading the format; for example, an instance of the XmlDictionaryWriter. Sonra WriteObject verileri kalıcı hale getirmek için yöntemini çağırın.Then call the WriteObject method to persist the data. Verileri almak için, veri biçimini okumak için uygun bir nesne oluşturun (örneğin, bir XmlDictionaryReader XML belgesi için) ve ReadObject yöntemini çağırın.To retrieve data, create an object appropriate to reading the data format (such as an XmlDictionaryReader for an XML document) and call the ReadObject method.

Kullanma hakkında daha fazla bilgi için DataContractSerializer bkz. serileştirme ve seri durumundan çıkarma.For more information about using the DataContractSerializer, see Serialization and Deserialization.

Bir istemci uygulama yapılandırma dosyasındaki < DataContractSerializer > öğesini kullanarak bir veri sözleşmesi serileştiricisi türünü ayarlayabilirsiniz.You can set the type of a data contract serializer using the <dataContractSerializer> element in a client application configuration file.

Sınıfları Serileştirme veya Seri Durumundan Çıkarma İçin HazırlamaPreparing Classes for Serialization or Deserialization

, DataContractSerializer DataContractAttribute Ve sınıflarıyla birlikte kullanılır DataMemberAttribute .The DataContractSerializer is used in combination with the DataContractAttribute and DataMemberAttribute classes. Serileştirme için bir sınıf hazırlamak üzere, DataContractAttribute sınıfını sınıfına uygulayın.To prepare a class for serialization, apply the DataContractAttribute to the class. Seri hale getirmek istediğiniz verileri döndüren sınıfın her üyesi için, uygulayın DataMemberAttribute .For each member of the class that returns data that you want to serialize, apply the DataMemberAttribute. Erişilebilirliği ne olursa olsun, alanları ve özellikleri seri hale getirebilirsiniz: özel, korumalı, dahili, korunan iç veya ortak.You can serialize fields and properties, regardless of accessibility: private, protected, internal, protected internal, or public.

Örneğin, şemanız bir Customer özelliği ile belirtir ID , ancak Person bir özelliği ile adlı bir tür kullanan mevcut bir uygulamanız zaten var Name .For example, your schema specifies a Customer with an ID property, but you already have an existing application that uses a type named Person with a Name property. Sözleşmeye uyan bir tür oluşturmak için, önce öğesini DataContractAttribute sınıfına uygulayın.To create a type that conforms to the contract, first apply the DataContractAttribute to the class. Ardından öğesini DataMemberAttribute seri hale getirmek istediğiniz her alan veya özelliğe uygulayın.Then apply the DataMemberAttribute to every field or property that you want to serialize.

XML 'nin son biçiminin metin olması gerekmez.The final format of the XML need not be text. Bunun yerine, verileri DataContractSerializer BIR XML bilgi kümesi olarak yazar ve bu, verileri ve tarafından tanınan herhangi bir biçime yazmanıza olanak tanır XmlReader XmlWriter .Instead, the DataContractSerializer writes the data as an XML infoset, which allows you to write the data to any format recognized by the XmlReader and XmlWriter. XmlDictionaryReader XmlDictionaryWriter Her ikisi ile çalışmak üzere iyileştirildiğinden, okumak ve yazmak için ve sınıflarını kullanmanız önerilir DataContractSerializer .It is recommended that you use the XmlDictionaryReader and XmlDictionaryWriter classes to read and write, because both are optimized to work with the DataContractSerializer.

Serileştirme veya seri durumdan çıkarma gerçekleşmeden önce doldurulması gereken alanlar veya özelliklere sahip bir sınıf oluşturuyorsanız, Sürüm dayanıklı serileştirme geri çağırmalarıbölümünde açıklandığı gibi geri çağırma özniteliklerini kullanın.If you are creating a class that has fields or properties that must be populated before the serialization or deserialization occurs, use callback attributes, as described in Version-Tolerant Serialization Callbacks.

Bilinen Türlerin Koleksiyonuna EklemeAdding to the Collection of Known Types

Bir nesneyi serileştirmek veya seri durumdan çıkarmak için, türün "bilinen" olması gerekir DataContractSerializer .When serializing or deserializing an object, it is required that the type is "known" to the DataContractSerializer. ' İ uygulayan bir sınıfın örneğini oluşturarak başlayın IEnumerable<T> (gibi List<T> ) ve bilinen türleri koleksiyona ekleyin.Begin by creating an instance of a class that implements IEnumerable<T> (such as List<T>) and adding the known types to the collection. Sonra DataContractSerializer (örneğin,) kullanan aşırı yüklemelerin birini kullanarak bir örneğini oluşturun IEnumerable<T> DataContractSerializer(Type, IEnumerable<Type>) .Then create an instance of the DataContractSerializer using one of the overloads that takes the IEnumerable<T> (for example, DataContractSerializer(Type, IEnumerable<Type>).

İleriye Dönük UyumlulukForward Compatibility

DataContractSerializerSözleşmenin gelecek sürümleriyle uyumlu olacak şekilde tasarlanan veri sözleşmelerini anladık.The DataContractSerializer understands data contracts that have been designed to be compatible with future versions of the contract. Bu tür türler IExtensibleDataObject arabirimini uygular.Such types implement the IExtensibleDataObject interface. Arabirim, ExtensionData bir nesneyi döndüren özelliği Özellikler ExtensionDataObject .The interface features the ExtensionData property that returns an ExtensionDataObject object. Daha fazla bilgi için bkz. Ileri uyumlu veri sözleşmeleri.For more information, see Forward-Compatible Data Contracts.

Kısmi Güven Altında ÇalışmaRunning under Partial Trust

Seri durumdan çıkarma sırasında hedef nesnenin örneği oluşturulurken, DataContractSerializer hedef nesnenin oluşturucusunu çağırmaz.When instantiating the target object during deserialization, the DataContractSerializer does not call the constructor of the target object. Kısmi güvenle erişilebilen bir [DataContract] türü yazarsanız (yani, ortak ve AllowPartiallyTrustedCallers özniteliği uygulanmış bir derlemede) ve güvenlikle ilgili bazı eylemler gerçekleştirdiğinde, oluşturucunun çağrılmadığından haberdar olmanız gerekir.If you author a [DataContract] type that is accessible from partial trust (that is, it is public and in an assembly that has the AllowPartiallyTrustedCallers attribute applied) and that performs some security-related actions, you must be aware that the constructor is not called. Özellikle, aşağıdaki teknikler çalışmaz:In particular, the following techniques do not work:

• Oluşturucuyu iç veya özel hale getirerek veya oluşturucuya bir a ekleyerek kısmi güven erişimini kısıtlamayı denerseniz, LinkDemand bunlardan hiçbiri kısmi güven altında seri durumundan çıkarma sırasında herhangi bir etkiye sahip değildir.If you try to restrict partial trust access by making the constructor internal or private, or by adding a LinkDemand to the constructor -- neither of these have any effect during deserialization under partial trust.

• Oluşturucunun çalıştırıldığını varsayan sınıfı kodkaldırırsanız, sınıf, açıktan yararlanıcı geçersiz bir iç durumu alabilir.If you code the class that assumes the constructor has run, the class may get into an invalid internal state that is exploitable.

Oluşturucular

Özellikler

Yöntemler

Uzantı Metotları

Şunlara uygulanır

İş Parçacığı Güvenliği

Örneği veya uygulamasıyla kullanılması dışında, bu sınıfın örnekleri iş parçacığı güvenlidir IDataContractSurrogate DataContractResolver .Instances of this class are thread safe except when the instance is used with an implementation of the IDataContractSurrogate or DataContractResolver.

Ayrıca bkz.

• DataMemberAttribute
• DataContractAttribute
• IExtensibleDataObject
• ExtensionDataObject
• Veri Sözleşmelerini KullanmaUsing Data Contracts
• Seri Hale Getirme ve Seri Durumdan ÇıkarmaSerialization and Deserialization