NetDataContractSerializer Klasa

Odwołanie

Definicja

Przestrzeń nazw:: System.Runtime.Serialization

Zestaw:: System.Runtime.Serialization.dll

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Serializuje i deserializuje wystąpienie typu w strumieniu XML lub dokumencie przy użyciu podanych typów programu .NET Framework. Tej klasy nie można dziedziczyć.

public ref class NetDataContractSerializer sealed : System::Runtime::Serialization::XmlObjectSerializer, System::Runtime::Serialization::IFormatter

public sealed class NetDataContractSerializer : System.Runtime.Serialization.XmlObjectSerializer, System.Runtime.Serialization.IFormatter

type NetDataContractSerializer = class
    inherit XmlObjectSerializer
    interface IFormatter

Public NotInheritable Class NetDataContractSerializer
Inherits XmlObjectSerializer
Implements IFormatter

Dziedziczenie: Object

XmlObjectSerializer
NetDataContractSerializer

Implementuje: IFormatter

Przykłady

Poniższy przykładowy kod przedstawia typ o nazwie Person, który jest serializowany przez NetDataContractSerializer. Atrybut DataContractAttribute jest stosowany do klasy, a DataMemberAttribute jest stosowany do składowych (w tym prywatnego elementu członkowskiego) w celu poinstruowania NetDataContractSerializer, co należy serializować.

// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the NetDataContractSerializer.
[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("NetDataContractSerializerExample.xml");
            ReadObject("NetDataContractSerializerExample.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 fs = new FileStream(fileName, FileMode.Create);
        XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
        NetDataContractSerializer ser =
            new NetDataContractSerializer();
        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());
        NetDataContractSerializer ser = new NetDataContractSerializer();

        // Deserialize the data and read it from the instance.
        Person deserializedPerson =
            (Person)ser.ReadObject(reader, true);
        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 NetDataContractSerializer.
<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("NetDataContractSerializerExample.xml")
            ReadObject("NetDataContractSerializerExample.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 fs As New FileStream(fileName, FileMode.Create)
        Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()

        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 System.Runtime.Serialization.NetDataContractSerializer()
        
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = CType(ser.ReadObject(reader, True), Person)
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.ID))
    
    End Sub 
End Class

Uwagi

Bezpieczeństwo

NetDataContractSerializer jest niepewna. Aby uzyskać więcej informacji, zobacz BinaryFormatter security guide.

NetDataContractSerializer różni się od DataContractSerializer w jeden ważny sposób: NetDataContractSerializer zawiera informacje o typie CLR w serializowanym formacie XML, natomiast DataContractSerializer nie. W związku z tym NetDataContractSerializer można użyć tylko wtedy, gdy końce serializacji i deserializacji współużytkują te same typy CLR.

Serializator może serializować typy, do których zastosowano atrybut DataContractAttribute lub SerializableAttribute. Serializuje również typy implementujące ISerializable.

Aby uzyskać więcej informacji na temat serializacji, zobacz Serializacja i Deserializacja.

Niezgodność z elementem XElement

Klasa XElement służy do pisania kodu XML. Jednak NetDataContractSerializer nie może serializować wystąpienia typu. W związku z tym następujący kod kończy się niepowodzeniem z wyjątkiem: "Typ główny "System.Xml.Linq.XElement" nie jest obsługiwany na najwyższym poziomie przez netDataContractSerializer, ponieważ jest to IXmlSerializable z IsAny=true i musi napisać całą jego zawartość, w tym element główny."

FileStream fs = new FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite);
XElement myElement = new XElement("Parent", new XElement("child1", "form"),
    new XElement("child2", "base"),
    new XElement("child3", "formbase")
    );
NetDataContractSerializer dcs = new NetDataContractSerializer();
dcs.WriteObject(fs, myElement);

Dim fs As New FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite)
Dim myElement As New XElement("Parent", New XElement("child1", "form"), _
    New XElement("child2", "base"), _
    New XElement("child3", "formbase") _
    )
Dim ser As New System.Runtime.Serialization. _
  NetDataContractSerializer()
ser.WriteObject(fs, myElement)

Jeśli jednak XElement jest używany jako typ pola lub właściwości klasy, dane zawarte w polu lub właściwości są serializowane. Jest to spowodowane tym, że jako składowa klasy dane nie są najwyższym poziomem klasy.

Konstruktory

NetDataContractSerializer()	Inicjuje nowe wystąpienie klasy NetDataContractSerializer.
NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)	Inicjuje nowe wystąpienie klasy NetDataContractSerializer z podanymi danymi kontekstowymi; ponadto określa maksymalną liczbę elementów w obiekcie, które mają być serializowane, oraz parametry określające, czy dodatkowe dane są ignorowane, metoda ładowania zestawu i selektor zastępczy.
NetDataContractSerializer(StreamingContext)	Inicjuje nowe wystąpienie klasy NetDataContractSerializer z podanymi danymi kontekstu przesyłania strumieniowego.
NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)	Inicjuje nowe wystąpienie klasy NetDataContractSerializer z podanymi danymi kontekstu oraz nazwą katalogu głównego i przestrzenią nazw; ponadto określa maksymalną liczbę elementów w obiekcie, które mają być serializowane, oraz parametry określające, czy dodatkowe dane są ignorowane, metoda ładowania zestawu i selektor zastępczy.
NetDataContractSerializer(String, String)	Inicjuje nowe wystąpienie klasy NetDataContractSerializer z podanym elementem głównym XML i przestrzenią nazw.
NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)	Inicjuje nowe wystąpienie klasy NetDataContractSerializer z podanymi danymi kontekstu oraz nazwą katalogu głównego i przestrzenią nazw (jako parametry XmlDictionaryString); ponadto określa maksymalną liczbę elementów w obiekcie, które mają być serializowane, i parametry, aby określić, czy znalezione dodatkowe dane są ignorowane, metoda ładowania zestawu i selektor zastępczy.
NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)	Inicjuje nowe wystąpienie klasy NetDataContractSerializer z dwoma parametrami typu XmlDictionaryString zawierającym element główny i przestrzeń nazw używaną do określania zawartości.

Właściwości

AssemblyFormat	Pobiera wartość określającą metodę lokalizowania i ładowania zestawów.
Binder	Pobiera lub ustawia obiekt, który kontroluje ładowanie klas.
Context	Pobiera lub ustawia obiekt, który umożliwia przekazywanie danych kontekstowych, które są przydatne podczas serializacji lub deserializacji.
IgnoreExtensionDataObject	Pobiera wartość określającą, czy dane dostarczane przez rozszerzenie obiektu są ignorowane.
MaxItemsInObjectGraph	Pobiera maksymalną liczbę elementów dozwolonych w obiekcie do serializacji.
SurrogateSelector	Pobiera lub ustawia obiekt, który pomaga formatować podczas wybierania zastępczego dla serializacji.

Metody

Deserialize(Stream)	Deserializuje dokument XML lub strumień do obiektu.
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
IsStartObject(XmlDictionaryReader)	Określa, czy XmlDictionaryReader jest umieszczony na obiekcie, który można deserializować przy użyciu określonego czytnika.
IsStartObject(XmlReader)	Określa, czy XmlReader jest umieszczony na obiekcie, który można deserializować przy użyciu określonego czytnika.
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
ReadObject(Stream)	Odczytuje strumień XML lub dokument z Stream i zwraca zdeserializowany obiekt. (Odziedziczone po XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)	Odczytuje strumień XML lub dokument z XmlDictionaryReader i zwraca obiekt deserializowany; Sprawdza również, czy dane obiektu są zgodne z nazwą i przestrzenią nazw użytą do utworzenia serializatora.
ReadObject(XmlDictionaryReader)	Odczytuje dokument XML lub strumień za pomocą XmlDictionaryReader i zwraca zdeserializowany obiekt. (Odziedziczone po XmlObjectSerializer)
ReadObject(XmlReader, Boolean)	Odczytuje strumień XML lub dokument z XmlDictionaryReader i zwraca obiekt deserializowany; Sprawdza również, czy dane obiektu są zgodne z nazwą i przestrzenią nazw użytą do utworzenia serializatora.
ReadObject(XmlReader)	Odczytuje strumień XML lub dokument z XmlDictionaryReader i zwraca zdeserializowany obiekt.
Serialize(Stream, Object)	Serializuje określony graf obiektu przy użyciu określonego składnika zapisywania.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
WriteEndObject(XmlDictionaryWriter)	Zapisuje zamykający element XML przy użyciu XmlDictionaryWriter.
WriteEndObject(XmlWriter)	Zapisuje zamykający element XML przy użyciu XmlWriter.
WriteObject(Stream, Object)	Zapisuje pełną zawartość (początek, zawartość i koniec) obiektu do dokumentu XML lub strumienia z określonym Stream. (Odziedziczone po XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)	Zapisuje pełną zawartość (początek, zawartość i koniec) obiektu do dokumentu XML lub strumienia z określonym XmlDictionaryWriter. (Odziedziczone po XmlObjectSerializer)
WriteObject(XmlWriter, Object)	Zapisuje pełną zawartość (początek, zawartość i koniec) obiektu do dokumentu XML lub strumienia z określonym XmlWriter.
WriteObjectContent(XmlDictionaryWriter, Object)	Zapisuje zawartość XML przy użyciu XmlDictionaryWriter.
WriteObjectContent(XmlWriter, Object)	Zapisuje zawartość XML przy użyciu XmlWriter.
WriteStartObject(XmlDictionaryWriter, Object)	Zapisuje otwierający element XML przy użyciu XmlDictionaryWriter.
WriteStartObject(XmlWriter, Object)	Zapisuje otwierający element XML przy użyciu XmlWriter.

Dotyczy

Produkt	Wersje
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Udostępnij za pośrednictwem