NetDataContractSerializer Класс

Определение

Сериализует и десериализирует экземпляр типа в XML-поток или документ с помощью предоставленных .NET типов. Этот класс не наследуется.

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
Наследование
NetDataContractSerializer
Реализации

Примеры

В следующем примере кода показан тип с именем Person , сериализованным в объекте NetDataContractSerializer. Атрибут DataContractAttribute применяется к классу, и DataMemberAttribute он применяется к членам (включая частный член), чтобы указать 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

Комментарии

Безопасность

NetDataContractSerializer небезопасно. Дополнительные сведения см. в статье Руководство по безопасности BinaryFormatter.

Отличается NetDataContractSerializer от одного важного DataContractSerializer способа: NetDataContractSerializer включает сведения о типе СРЕДЫ CLR в сериализованном XML, в то время как они DataContractSerializer не имеют значения. Поэтому его можно использовать только в том случае, NetDataContractSerializer если сериализация и десериализация заканчиваются одинаковыми типами CLR.

Сериализатор может сериализовать типы, к которым DataContractAttribute применены либо SerializableAttribute атрибуты. Он также сериализует типы, реализующие ISerializable.

Дополнительные сведения о сериализации см. в разделе Сериализация и десериализация.

Несовместимость с XElement

Класс XElement используется для записи XML. Однако не NetDataContractSerializer удается сериализовать экземпляр типа. Таким образом, следующий код завершается ошибкой с исключением: "Корневой тип System.Xml.Linq.XElement" не поддерживается на верхнем уровне netDataContractSerializer, так как он является IXmlSerializable с IsAny=true и должен записывать все его содержимое, включая корневой элемент".

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)

Однако если используется XElement в качестве типа поля или свойства класса, данные, содержащиеся в поле или свойстве, сериализуются. Это связано с тем, что в качестве члена класса данные не являются верхним уровнем класса.

Конструкторы

Имя Описание
NetDataContractSerializer()

Инициализирует новый экземпляр класса NetDataContractSerializer.

NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

Инициализирует новый экземпляр NetDataContractSerializer класса с предоставленными данными контекста. Кроме того, указывает максимальное количество элементов в объекте, а также параметры, чтобы указать, игнорируются ли дополнительные данные, метод загрузки сборки и суррогатный селектор.

NetDataContractSerializer(StreamingContext)

Инициализирует новый экземпляр NetDataContractSerializer класса с предоставленными данными контекста потоковой передачи.

NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

Инициализирует новый экземпляр NetDataContractSerializer класса с предоставленными данными контекста и корневым именем и пространством имен. Кроме того, указывает максимальное количество элементов в объекте, а также параметры, указывающие, игнорируются ли дополнительные данные, метод загрузки сборки и суррогатный селектор.

NetDataContractSerializer(String, String)

Инициализирует новый экземпляр NetDataContractSerializer класса с предоставленным корневым элементом XML и пространством имен.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

Инициализирует новый экземпляр NetDataContractSerializer класса с предоставленными данными контекста, а также корневым именем и пространством имен (в качестве XmlDictionaryString параметров). Кроме того, указывает максимальное количество элементов в объекте, а также параметры, указывающие, игнорируются ли дополнительные данные, метод загрузки сборок и суррогатный селектор.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

Инициализирует новый экземпляр NetDataContractSerializer класса с двумя параметрами типа XmlDictionaryString , которые содержат корневой элемент и пространство имен, используемые для указания содержимого.

Свойства

Имя Описание
AssemblyFormat

Возвращает значение, указывающее метод для поиска и загрузки сборок.

Binder

Возвращает или задает объект, который управляет загрузкой класса.

Context

Возвращает или задает объект, который позволяет передавать данные контекста, которые полезны при сериализации или десериализации.

IgnoreExtensionDataObject

Возвращает значение, указывающее, игнорируются ли данные, предоставленные расширением объекта.

MaxItemsInObjectGraph

Возвращает максимальное количество элементов, разрешенных для сериализации объекта.

SurrogateSelector

Возвращает или задает объект, который помогает форматировщику при выборе суррогата для сериализации.

Методы

Имя Описание
Deserialize(Stream)

Десериализация XML-документа или потока в объект.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает Type текущего экземпляра.

(Унаследовано от Object)
IsStartObject(XmlDictionaryReader)

Определяет, размещается ли объект XmlDictionaryReader на объекте, который можно десериализировать с помощью указанного средства чтения.

IsStartObject(XmlReader)

Определяет, размещается ли объект XmlReader на объекте, который можно десериализировать с помощью указанного средства чтения.

MemberwiseClone()

Создает неглубокую копию текущей Object.

(Унаследовано от Object)
ReadObject(Stream)

Считывает XML-поток или документ с помощью десериализированного Stream объекта и возвращает десериализированный объект.

(Унаследовано от XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)

Считывает XML-поток или документ с XmlDictionaryReader десериализированным объектом и возвращает десериализированный объект. Кроме того, проверяет, соответствуют ли данные объекта имени и пространству имен, используемым для создания сериализатора.

ReadObject(XmlDictionaryReader)

Считывает XML-документ или поток с десериализированным XmlDictionaryReader объектом.

(Унаследовано от XmlObjectSerializer)
ReadObject(XmlReader, Boolean)

Считывает XML-поток или документ с XmlDictionaryReader десериализированным объектом и возвращает десериализированный объект. Кроме того, проверяет, соответствуют ли данные объекта имени и пространству имен, используемым для создания сериализатора.

ReadObject(XmlReader)

Считывает XML-поток или документ с десериализированным XmlDictionaryReader объектом и возвращает его.

Serialize(Stream, Object)

Сериализует указанный граф объектов с помощью указанного модуля записи.

ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)
WriteEndObject(XmlDictionaryWriter)

Записывает закрывающий XML-элемент с помощью элемента XmlDictionaryWriter.

WriteEndObject(XmlWriter)

Записывает закрывающий XML-элемент с помощью элемента XmlWriter.

WriteObject(Stream, Object)

Записывает полное содержимое (начало, содержимое и конец) объекта в XML-документ или поток с указанным Stream.

(Унаследовано от XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)

Записывает полное содержимое (начало, содержимое и конец) объекта в XML-документ или поток с указанным XmlDictionaryWriter.

(Унаследовано от XmlObjectSerializer)
WriteObject(XmlWriter, Object)

Записывает полное содержимое (начало, содержимое и конец) объекта в XML-документ или поток с указанным XmlWriter.

WriteObjectContent(XmlDictionaryWriter, Object)

Записывает XML-содержимое с помощью .XmlDictionaryWriter

WriteObjectContent(XmlWriter, Object)

Записывает XML-содержимое с помощью .XmlWriter

WriteStartObject(XmlDictionaryWriter, Object)

Записывает открывающий XML-элемент с помощью элемента XmlDictionaryWriter.

WriteStartObject(XmlWriter, Object)

Записывает открывающий XML-элемент с помощью элемента XmlWriter.

Применяется к

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