NetDataContractSerializer Classe

Definição

Serializa e desserializa uma instância de um tipo em um fluxo XML ou documento usando os tipos de .NET fornecidos. Essa classe não pode ser herdada.

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 NetDataContractSerializerseguir mostra um tipo chamado Person serializado pelo . O DataContractAttribute atributo é aplicado à classe e é DataMemberAttribute aplicado aos membros (incluindo um membro privado) para instruir o NetDataContractSerializer que serializar.

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

Segurança

NetDataContractSerializer é inseguro. Para saber mais, confira o Guia de segurança do BinaryFormatter.

O NetDataContractSerializer diferencia de DataContractSerializer uma maneira importante: inclui NetDataContractSerializer informações de tipo CLR no XML serializado, enquanto o DataContractSerializer não. Portanto, só NetDataContractSerializer poderá ser usado se as extremidades serializando e desserializando compartilharem os mesmos tipos CLR.

O serializador pode serializar tipos aos quais o atributo ou SerializableAttribute o DataContractAttribute atributo foi aplicado. Ele também serializa tipos que implementam ISerializable.

Para obter mais informações sobre serialização, consulte Serialização e Desserialização.

Incompatibilidade com XElement

A XElement classe é usada para gravar XML. No entanto, não NetDataContractSerializer é possível serializar uma instância do tipo. O código a seguir, portanto, falha com a exceção: "O tipo raiz 'System.Xml.Linq.XElement' não tem suporte no nível superior por NetDataContractSerializer, pois ele é IXmlSerializable com IsAny=true e deve gravar todo o seu conteúdo, incluindo o elemento raiz."

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, se um XElement for usado como o tipo de um campo ou propriedade de uma classe, os dados contidos pelo campo ou propriedade serão serializados. Isso ocorre porque, como membro de uma classe, os dados não são o nível superior da classe.

Construtores

Nome Description
NetDataContractSerializer()

Inicializa uma nova instância da classe NetDataContractSerializer.

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

Inicializa uma nova instância da classe com os dados de NetDataContractSerializer contexto fornecidos; além disso, especifica o número máximo de itens no objeto a serem serializados e parâmetros para especificar se dados extras são ignorados, o método de carregamento do assembly e um seletor substituto.

NetDataContractSerializer(StreamingContext)

Inicializa uma nova instância da NetDataContractSerializer classe com os dados de contexto de streaming fornecidos.

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

Inicializa uma nova instância da classe com os dados de NetDataContractSerializer contexto fornecidos e o nome raiz e o namespace; além disso, especifica o número máximo de itens no objeto a serem serializados e parâmetros para especificar se dados extras são ignorados, o método de carregamento do assembly e um seletor substituto.

NetDataContractSerializer(String, String)

Inicializa uma nova instância da NetDataContractSerializer classe com o elemento raiz XML e o namespace fornecidos.

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

Inicializa uma nova instância da classe com os dados de NetDataContractSerializer contexto fornecidos e o nome raiz e o namespace (como XmlDictionaryString parâmetros); além disso, especifica o número máximo de itens no objeto a serem serializados e parâmetros para especificar se os dados extras encontrados são ignorados, o método de carregamento do assembly e um seletor substituto.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

Inicializa uma nova instância da NetDataContractSerializer classe com dois parâmetros de tipo XmlDictionaryString que contêm o elemento raiz e o namespace usados para especificar o conteúdo.

Propriedades

Nome Description
AssemblyFormat

Obtém um valor que especifica um método para localizar e carregar assemblies.

Binder

Obtém ou define um objeto que controla o carregamento de classe.

Context

Obtém ou define o objeto que permite a passagem de dados de contexto que são úteis durante a serialização ou desserialização.

IgnoreExtensionDataObject

Obtém um valor que especifica se os dados fornecidos por uma extensão do objeto são ignorados.

MaxItemsInObjectGraph

Obtém o número máximo de itens permitidos no objeto a serem serializados.

SurrogateSelector

Obtém ou define um objeto que auxilia o formatador ao selecionar um substituto para serialização.

Métodos

Nome Description
Deserialize(Stream)

Desserializa um documento XML ou transmite para um objeto.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como a função hash predefinida.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
IsStartObject(XmlDictionaryReader)

Determina se o XmlDictionaryReader objeto está posicionado em um objeto que pode ser desserializado usando o leitor especificado.

IsStartObject(XmlReader)

Determina se o XmlReader objeto está posicionado em um objeto que pode ser desserializado usando o leitor especificado.

MemberwiseClone()

Cria uma cópia superficial do Objectatual.

(Herdado de Object)
ReadObject(Stream)

Lê o fluxo XML ou o documento com um Stream e retorna o objeto desserializado.

(Herdado de XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)

Lê o fluxo XML ou documento 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.

ReadObject(XmlDictionaryReader)

Lê o documento XML ou o fluxo com um XmlDictionaryReader e retorna o objeto desserializado.

(Herdado de XmlObjectSerializer)
ReadObject(XmlReader, Boolean)

Lê o fluxo XML ou documento 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.

ReadObject(XmlReader)

Lê o fluxo XML ou documento com um XmlDictionaryReader e retorna o objeto desserializado.

Serialize(Stream, Object)

Serializa o grafo de objeto especificado usando o gravador especificado.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)
WriteEndObject(XmlDictionaryWriter)

Grava o elemento XML de fechamento usando um XmlDictionaryWriter.

WriteEndObject(XmlWriter)

Grava o elemento XML de fechamento usando um XmlWriter.

WriteObject(Stream, Object)

Grava o conteúdo completo (início, conteúdo e término) do objeto no documento XML ou no fluxo com o especificado Stream.

(Herdado de XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)

Grava o conteúdo completo (início, conteúdo e término) do objeto no documento XML ou no fluxo com o especificado XmlDictionaryWriter.

(Herdado de XmlObjectSerializer)
WriteObject(XmlWriter, Object)

Grava o conteúdo completo (início, conteúdo e término) do objeto no documento XML ou no fluxo com o especificado XmlWriter.

WriteObjectContent(XmlDictionaryWriter, Object)

Grava o conteúdo XML usando um XmlDictionaryWriter.

WriteObjectContent(XmlWriter, Object)

Grava o conteúdo XML usando um XmlWriter.

WriteStartObject(XmlDictionaryWriter, Object)

Grava o elemento XML de abertura usando um XmlDictionaryWriter.

WriteStartObject(XmlWriter, Object)

Grava o elemento XML de abertura usando um XmlWriter.

Aplica-se a

Confira também