NetDataContractSerializer Classe

Definição

Serializa e desserializa uma instância de um tipo em um fluxo ou documento XML usando os tipos do .NET Framework fornecidos.Serializes and deserializes an instance of a type into XML stream or document using the supplied .NET Framework types. Essa classe não pode ser herdada.This class cannot be inherited.

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
Herança
NetDataContractSerializer
Implementações

Exemplos

O código de exemplo a seguir mostra um Person tipo chamado que é serializado NetDataContractSerializerpelo.The following example code shows a type named Person that is serialized by the NetDataContractSerializer. O DataContractAttribute atributo é aplicado à classe e o DataMemberAttribute é aplicado aos membros (incluindo um membro privado) para instruir o NetDataContractSerializer que serializar.The DataContractAttribute attribute is applied to the class, and the DataMemberAttribute is applied to members (including a private member) to instruct the NetDataContractSerializer what to serialize.

// 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 

Comentários

O NetDataContractSerializer difere DataContractSerializer de uma maneira importante: a NetDataContractSerializer inclui informações de tipo CLR no XML serializado, enquanto o DataContractSerializer não.The NetDataContractSerializer differs from the DataContractSerializer in one important way: the NetDataContractSerializer includes CLR type information in the serialized XML, whereas the DataContractSerializer does not. Portanto, o NetDataContractSerializer pode ser usado somente se a serialização e a desserialização terminarem de compartilhar os mesmos tipos CLR.Therefore, the NetDataContractSerializer can be used only if both the serializing and deserializing ends share the same CLR types.

O serializador pode serializar tipos aos quais DataContractAttribute o SerializableAttribute atributo ou foi aplicado.The serializer can serialize types to which either the DataContractAttribute or SerializableAttribute attribute has been applied. Ele também serializa os tipos que implementam ISerializable.It also serializes types that implement ISerializable.

Para obter mais informações sobre serialização, consulte serialização edesserialização.For more information about serialization, see Serialization and Deserialization.

Incompatibilidade com XElementIncompatibility with XElement

A XElement classe é usada para gravar XML.The XElement class is used to write XML. No entanto NetDataContractSerializer , o não pode serializar uma instância do tipo.However, the NetDataContractSerializer cannot serialize an instance of the type. O código a seguir, portanto, falha com a exceção: "Não há suporte para o tipo de raiz ' System. xml. Linq. XElement ' no nível superior pelo NetDataContractSerializer, pois ele IsAny é IXmlSerializable com = true e deve gravar todo o seu conteúdo, incluindo o elemento raiz."The following code, therefore, fails with the exception: "Root type 'System.Xml.Linq.XElement' is not supported at the top level by NetDataContractSerializer since it is IXmlSerializable with IsAny=true and must write all its contents including the root element."

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)

No entanto, XElement se um for usado como o tipo de um campo ou propriedade de uma classe, os dados contidos no campo ou na propriedade serão serializados.However, if an XElement is used as the type of a field or property of a class, the data contained by the field or property is serialized. Isso ocorre porque, como um membro de uma classe, os dados não são o nível superior da classe.This is because as a member of a class, the data is not the top level of the class.

Construtores

NetDataContractSerializer()

Inicializa uma nova instância da classe NetDataContractSerializer.Initializes a new instance of the NetDataContractSerializer class.

NetDataContractSerializer(StreamingContext)

Inicializa uma nova instância da classe NetDataContractSerializer com os dados de contexto de fluxo fornecidos.Initializes a new instance of the NetDataContractSerializer class with the supplied streaming context data.

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

Inicializa uma nova instância da classe NetDataContractSerializer com os dados de contexto fornecidos; além disso, especifica o número máximo de itens no objeto a serem serializados e os parâmetros para especificar se os dados extras serão ignorados, o método de carregamento do assembly e um seletor substituto.Initializes a new instance of the NetDataContractSerializer class with the supplied context data; in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data is ignored, the assembly loading method, and a surrogate selector.

NetDataContractSerializer(String, String)

Inicializa uma nova instância da classe NetDataContractSerializer com o namespace e o elemento raiz XML fornecidos.Initializes a new instance of the NetDataContractSerializer class with the supplied XML root element and namespace.

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

Inicializa uma nova instância da classe NetDataContractSerializer com o namespace e o nome de raiz e dados de contexto fornecidos; além disso, especifica o número máximo de itens no objeto a serem serializados e os parâmetros para especificar se os dados extras serão ignorados, o método de carregamento do assembly e um seletor substituto.Initializes a new instance of the NetDataContractSerializer class with the supplied context data and root name and namespace; in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data is ignored, the assembly loading method, and a surrogate selector.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

Inicializa uma nova instância da classe NetDataContractSerializer com dois parâmetros do tipo XmlDictionaryString que contêm o elemento raiz e o namespace usado para especificar o conteúdo.Initializes a new instance of the NetDataContractSerializer class with two parameters of type XmlDictionaryString that contain the root element and namespace used to specify the content.

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

Inicializa uma nova instância da classe NetDataContractSerializer com o namespace e o nome de raiz e dados de contexto fornecidos (como parâmetros XmlDictionaryString); além disso, especifica o número máximo de itens no objeto a serem serializados e os parâmetros para especificar se os dados extras encontrados serão ignorados, o método de carregamento de assembly e um seletor substituto.Initializes a new instance of the NetDataContractSerializer class with the supplied context data, and root name and namespace (as XmlDictionaryString parameters); in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data found is ignored, assembly loading method, and a surrogate selector.

Propriedades

AssemblyFormat

Obtém um valor que especifica um método para localizar e carregar assemblies.Gets a value that specifies a method for locating and loading assemblies.

Binder

Obtém ou define um objeto que controla o carregamento de classe.Gets or sets an object that controls class loading.

Context

Obtém ou define o objeto que permite a passagem de dados de contexto úteis ao serializar ou desserializar.Gets or sets the object that enables the passing of context data that is useful while serializing or deserializing.

IgnoreExtensionDataObject

Obtém um valor que especifica se os dados fornecidos por uma extensão do objeto são ignorados.Gets a value that specifies whether data supplied by an extension of the object is ignored.

MaxItemsInObjectGraph

Obtém o número máximo de itens permitidos no objeto a ser serializado.Gets the maximum number of items allowed in the object to be serialized.

SurrogateSelector

Obtém ou define um objeto que auxilia o formatador ao selecionar um substituto para serialização.Gets or sets an object that assists the formatter when selecting a surrogate for serialization.

Métodos

Deserialize(Stream)

Desserializa um documento ou fluxo XML em um objeto.Deserializes an XML document or stream into an object.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsStartObject(XmlDictionaryReader)

Determina se o XmlDictionaryReader está posicionado em um objeto que pode ser desserializado usando o leitor especificado.Determines whether the XmlDictionaryReader is positioned on an object that can be deserialized using the specified reader.

IsStartObject(XmlReader)

Determina se o XmlReader está posicionado em um objeto que pode ser desserializado usando o leitor especificado.Determines whether the XmlReader is positioned on an object that can be deserialized using the specified reader.

MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ReadObject(Stream)

Lê o fluxo XML ou o documento com um Stream e retorna o objeto desserializado.Reads the XML stream or document with a Stream and returns the deserialized object.

(Herdado de XmlObjectSerializer)
ReadObject(XmlDictionaryReader)

Lê o documento ou o fluxo XML com um XmlDictionaryReader e retorna o objeto desserializado.Reads the XML document or stream with an XmlDictionaryReader and returns the deserialized object.

(Herdado de XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)

Lê o fluxo ou documento XML com um XmlDictionaryReader e retorna o objeto desserializado; também verifica se os dados do objeto estão em conformidade com o nome e o namespace usados para criar o serializador.Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; also checks whether the object data conforms to the name and namespace used to create the serializer.

ReadObject(XmlReader)

Lê o fluxo ou documento XML com um XmlDictionaryReader e retorna o objeto desserializado.Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object.

ReadObject(XmlReader, Boolean)

Lê o fluxo ou documento XML com um XmlDictionaryReader e retorna o objeto desserializado; também verifica se os dados do objeto estão em conformidade com o nome e o namespace usados para criar o serializador.Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; also checks whether the object data conforms to the name and namespace used to create the serializer.

Serialize(Stream, Object)

Serializa o grafo do objeto especificado usando o gravador especificado.Serializes the specified object graph using the specified writer.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)
WriteEndObject(XmlDictionaryWriter)

Grava o elemento XML de fechamento usando um XmlDictionaryWriter.Writes the closing XML element using an XmlDictionaryWriter.

WriteEndObject(XmlWriter)

Grava o elemento XML de fechamento usando um XmlWriter.Writes the closing XML element using an XmlWriter.

WriteObject(Stream, Object)

Grava o conteúdo completo (início, conteúdo e final) do objeto no documento XML ou fluxo com o Stream especificado.Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified Stream.

(Herdado de XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)

Grava o conteúdo completo (início, conteúdo e final) do objeto no documento XML ou fluxo com o XmlDictionaryWriter especificado.Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlDictionaryWriter.

(Herdado de XmlObjectSerializer)
WriteObject(XmlWriter, Object)

Grava o conteúdo completo (início, conteúdo e final) do objeto no documento XML ou fluxo com o XmlWriter especificado.Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlWriter.

WriteObjectContent(XmlDictionaryWriter, Object)

Grava o conteúdo de XML usando um XmlDictionaryWriter.Writes the XML content using an XmlDictionaryWriter.

WriteObjectContent(XmlWriter, Object)

Grava o conteúdo de XML usando um XmlWriter.Writes the XML content using an XmlWriter.

WriteStartObject(XmlDictionaryWriter, Object)

Grava o elemento XML de abertura usando um XmlDictionaryWriter.Writes the opening XML element using an XmlDictionaryWriter.

WriteStartObject(XmlWriter, Object)

Grava o elemento XML de abertura usando um XmlWriter.Writes the opening XML element using an XmlWriter.

Aplica-se a

Veja também