NetDataContractSerializer Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Serialisiert und deserialisiert eine Instanz eines Typs mithilfe der bereitgestellten .NET-Typen in XML-Datenstrom oder -Dokument. Diese Klasse kann nicht vererbt werden.
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
- Vererbung
- Implementiert
Beispiele
Der folgende Beispielcode zeigt einen Typ mit dem Namen Person , der von der NetDataContractSerializerDatei serialisiert wird. Das DataContractAttribute Attribut wird auf die Klasse angewendet und auf DataMemberAttribute Member (einschließlich eines privaten Mitglieds) angewendet, um die Serialisierung anzuweisen NetDataContractSerializer .
// 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
Hinweise
Sicherheit
NetDataContractSerializer ist unsicher. Weitere Informationen finden Sie im Sicherheitsleitfaden für BinaryFormatter.
Die Unterschiede unterscheiden sich von der DataContractSerializer in einer wichtigen Weise: Die NetDataContractSerializerNetDataContractSerializer enthält CLR-Typinformationen in der serialisierten XML, während dies DataContractSerializer nicht der Fall ist. Daher kann die NetDataContractSerializer Funktion nur verwendet werden, wenn sowohl die Serialisierung als auch die Deserialisierung mit denselben CLR-Typen übereinstimmen.
Der Serialisierer kann Typen serialisieren, auf die entweder das Attribut oder SerializableAttribute das DataContractAttribute Attribut angewendet wurde. Außerdem serialisiert sie Typen, die implementiert werden ISerializable.
Weitere Informationen zur Serialisierung finden Sie unter Serialisierung und Deserialisierung.
Inkompatibilität mit XElement
Die XElement Klasse wird zum Schreiben von XML verwendet. Die NetDataContractSerializer Instanz des Typs kann jedoch nicht serialisiert werden. Der folgende Code schlägt daher mit der Ausnahme fehl: "Der Stammtyp 'System.Xml.Linq.XElement' wird von NetDataContractSerializer nicht auf oberster Ebene unterstützt, da es IXmlSerializable mit IsAny=true und muss den gesamten Inhalt einschließlich des Stammelements schreiben."
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)
Wenn ein XElement Feld oder eine Eigenschaft einer Klasse jedoch als Typ verwendet wird, werden die daten, die im Feld oder der Eigenschaft enthalten sind, serialisiert. Dies liegt daran, dass die Daten als Mitglied einer Klasse nicht die oberste Ebene der Klasse sind.
Konstruktoren
| Name | Beschreibung |
|---|---|
| NetDataContractSerializer() |
Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse. |
| NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector) |
Initialisiert eine neue Instanz der NetDataContractSerializer Klasse mit den angegebenen Kontextdaten. Darüber hinaus wird die maximale Anzahl von Elementen im objekt serialisiert, und Parameter, um anzugeben, ob zusätzliche Daten ignoriert werden, die Assemblylademethode und eine Ersatzauswahl. |
| NetDataContractSerializer(StreamingContext) |
Initialisiert eine neue Instanz der NetDataContractSerializer Klasse mit den bereitgestellten Streamingkontextdaten. |
| NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector) |
Initialisiert eine neue Instanz der NetDataContractSerializer Klasse mit den bereitgestellten Kontextdaten und Stammnamen und Namespace. Darüber hinaus gibt die maximale Anzahl von Elementen im Objekt serialisiert werden soll, und Parameter, um anzugeben, ob zusätzliche Daten ignoriert werden, die Assemblylademethode und eine Ersatzauswahl. |
| NetDataContractSerializer(String, String) |
Initialisiert eine neue Instanz der NetDataContractSerializer Klasse mit dem bereitgestellten XML-Stammelement und -Namespace. |
| NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector) |
Initialisiert eine neue Instanz der NetDataContractSerializer Klasse mit den bereitgestellten Kontextdaten sowie dem Stammnamen und dem Namespace (als XmlDictionaryString Parameter). Darüber hinaus wird die maximale Anzahl von Elementen im Objekt serialisiert, und Parameter, um anzugeben, ob zusätzliche Gefundene ignoriert werden, Assemblylademethode und ein Ersatzmarkierer. |
| NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString) |
Initialisiert eine neue Instanz der NetDataContractSerializer Klasse mit zwei Parametern vom Typ XmlDictionaryString , die das Stammelement und den Namespace enthalten, mit dem der Inhalt angegeben wird. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| AssemblyFormat |
Ruft einen Wert ab, der eine Methode zum Suchen und Laden von Assemblys angibt. |
| Binder |
Dient zum Abrufen oder Festlegen eines Objekts, das das Laden der Klasse steuert. |
| Context |
Dient zum Abrufen oder Festlegen des Objekts, das das Übergeben von Kontextdaten ermöglicht, die beim Serialisieren oder Deserialisieren nützlich sind. |
| IgnoreExtensionDataObject |
Ruft einen Wert ab, der angibt, ob Daten, die von einer Erweiterung des Objekts bereitgestellt werden, ignoriert werden. |
| MaxItemsInObjectGraph |
Ruft die maximale Anzahl von Elementen ab, die im Objekt serialisiert werden dürfen. |
| SurrogateSelector |
Dient zum Abrufen oder Festlegen eines Objekts, das den Formatierer beim Auswählen eines Ersatzes für die Serialisierung unterstützt. |
Methoden
| Name | Beschreibung |
|---|---|
| Deserialize(Stream) |
Deserialisiert ein XML-Dokument oder -Datenstrom in ein Objekt. |
| Equals(Object) |
Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object) |
| GetHashCode() |
Dient als Standardhashfunktion. (Geerbt von Object) |
| GetType() |
Ruft die Type der aktuellen Instanz ab. (Geerbt von Object) |
| IsStartObject(XmlDictionaryReader) |
Bestimmt, ob die XmlDictionaryReader Position eines Objekts, das mithilfe des angegebenen Readers deserialisiert werden kann. |
| IsStartObject(XmlReader) |
Bestimmt, ob die XmlReader Position eines Objekts, das mithilfe des angegebenen Readers deserialisiert werden kann. |
| MemberwiseClone() |
Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object) |
| ReadObject(Stream) |
Liest den XML-Datenstrom oder das Dokument mit einem Stream und gibt das deserialisierte Objekt zurück. (Geerbt von XmlObjectSerializer) |
| ReadObject(XmlDictionaryReader, Boolean) |
Liest den XML-Datenstrom oder das Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. Überprüft außerdem, ob die Objektdaten dem Namen und namespace entsprechen, der zum Erstellen des Serialisierers verwendet wird. |
| ReadObject(XmlDictionaryReader) |
Liest das XML-Dokument oder den Datenstrom mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. (Geerbt von XmlObjectSerializer) |
| ReadObject(XmlReader, Boolean) |
Liest den XML-Datenstrom oder das Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. Überprüft außerdem, ob die Objektdaten dem Namen und namespace entsprechen, der zum Erstellen des Serialisierers verwendet wird. |
| ReadObject(XmlReader) |
Liest den XML-Datenstrom oder das Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. |
| Serialize(Stream, Object) |
Serialisiert das angegebene Objektdiagramm mithilfe des angegebenen Writers. |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |
| WriteEndObject(XmlDictionaryWriter) |
Schreibt das schließende XML-Element mithilfe eines XmlDictionaryWriter. |
| WriteEndObject(XmlWriter) |
Schreibt das schließende XML-Element mithilfe eines XmlWriter. |
| WriteObject(Stream, Object) |
Schreibt den vollständigen Inhalt (Start, Inhalt und Ende) des Objekts in das XML-Dokument oder den Datenstrom mit dem angegebenen Stream. (Geerbt von XmlObjectSerializer) |
| WriteObject(XmlDictionaryWriter, Object) |
Schreibt den vollständigen Inhalt (Start, Inhalt und Ende) des Objekts in das XML-Dokument oder den Datenstrom mit dem angegebenen XmlDictionaryWriter. (Geerbt von XmlObjectSerializer) |
| WriteObject(XmlWriter, Object) |
Schreibt den vollständigen Inhalt (Start, Inhalt und Ende) des Objekts in das XML-Dokument oder den Datenstrom mit dem angegebenen XmlWriter. |
| WriteObjectContent(XmlDictionaryWriter, Object) |
Schreibt den XML-Inhalt mithilfe eines XmlDictionaryWriter. |
| WriteObjectContent(XmlWriter, Object) |
Schreibt den XML-Inhalt mithilfe eines XmlWriter. |
| WriteStartObject(XmlDictionaryWriter, Object) |
Schreibt das öffnende XML-Element mithilfe eines XmlDictionaryWriter. |
| WriteStartObject(XmlWriter, Object) |
Schreibt das öffnende XML-Element mithilfe eines XmlWriter. |