Classe System.Xml.Serialization.XmlSerializer

  • Artigo

Este artigo fornece observações complementares à documentação de referência para essa API.

A serialização de XML é o processo de conversão das propriedades e campos públicos de um objeto em um formato serial (neste caso, XML) para armazenamento ou transporte. A desserialização recria o objeto em seu estado original a partir da saída XML. Você pode pensar na serialização como uma forma de salvar o estado de um objeto em um fluxo ou buffer. Por exemplo, o ASP.NET usa a classe XmlSerializer para codificar mensagens XML de serviços da Web.

Os dados em seus objetos são descritos com o uso de construções de linguagem de programação, como classes, campos, propriedades, tipos primitivos, matrizes e até mesmo XML inserido na forma de objetos XmlElement ou XmlAttribute. Você tem a opção de criar suas próprias classes, anotadas com atributos, ou usar a Ferramenta de Definição de Esquema XML (Xsd.exe) para gerar as classes com base em um documento de definição de esquema XML (XSD) existente. Se você tiver um esquema XML, poderá executar o Xsd.exe para produzir um conjunto de classes fortemente tipadas para o esquema e anotadas com atributos para aderir ao esquema quando serializadas.

Para transferir dados entre objetos e XML, é necessário um mapeamento das constructos da linguagem de programação para o esquema XML e do esquema XML para as constructos da linguagem de programação. O XmlSerializer e as ferramentas relacionadas, como o Xsd.exe, fazem a ponte entre essas duas tecnologias, tanto em tempo de design quanto em runtime. No momento do design, use o Xsd.exe para produzir um documento de esquema XML (.xsd) a partir de suas classes personalizadas ou para produzir classes a partir de um determinado esquema. Em ambos os casos, as classes são anotadas com atributos personalizados para instruir o XmlSerializer sobre como mapear entre o sistema de esquema XML e o Common Language Runtime. Em runtime, as instâncias das classes podem ser serializadas em documentos XML que seguem o esquema fornecido. Da mesma forma, esses documentos XML podem ser desserializados em objetos de runtime. Observe que o esquema XML é opcional e não é necessário no momento do design ou no runtime.

Controle da linguagem XML gerada

Para controlar a linguagem XML gerada, você pode aplicar atributos especiais a classes e membros. Por exemplo, para especificar um nome de elemento XML diferente, aplique um XmlElementAttribute a um campo ou propriedade pública e defina a propriedade ElementName. Para obter uma lista completa de atributos semelhantes, confira Atributos que controlam a serialização de XML. Você também pode implementar a interface IXmlSerializable para controlar a saída XML.

Se o XML gerado precisar estar em conformidade com a seção 5 do documento do World Wide Consortium, Simple Object Access Protocol (SOAP) 1.1, você deverá construir o XmlSerializer com um XmlTypeMapping. Para controlar ainda mais o XML SOAP codificado, use os atributos listados em Atributos que controlam a serialização SOAP codificada.

Com o XmlSerializer, você pode aproveitar as vantagens de trabalhar com classes fortemente tipadas e ainda ter a flexibilidade da linguagem XML. Usando campos ou propriedades do tipo XmlElement, XmlAttribute ou XmlNode em suas classes fortemente tipadas, você poderá ler partes do documento XML diretamente em objetos XML.

Se você trabalhar com esquemas XML extensíveis, também poderá usar os atributos XmlAnyElementAttribute e XmlAnyAttributeAttribute para serializar e desserializar elementos ou atributos que não são encontrados no esquema original. Para usar os objetos, aplique um XmlAnyElementAttribute a um campo que retorne uma matriz de XmlElement objetos ou aplique um XmlAnyAttributeAttribute a um campo que retorne uma matriz de XmlAttribute objetos.

Se uma propriedade ou um campo retornar um objeto complexo (como uma matriz ou uma instância da classe), XmlSerializer o converterá em elemento aninhado dentro do documento XML principal. Por exemplo, a primeira classe no código a seguir retorna uma instância da segunda classe.

Public Class MyClass
    Public MyObjectProperty As MyObject
End Class

Public Class MyObject
    Public ObjectName As String
End Class

public class MyClass
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

A saída XML serializada tem a seguinte aparência:

<MyClass>
  <MyObjectProperty>
  <ObjectName>My String</ObjectName>
  </MyObjectProperty>
</MyClass>

Se um esquema incluir um elemento que seja opcional (minOccurs = '0') ou se o esquema incluir um valor padrão, você terá duas opções. Uma opção é usar System.ComponentModel.DefaultValueAttribute para especificar o valor padrão, conforme mostrado no código a seguir.

Public Class PurchaseOrder
    <System.ComponentModel.DefaultValueAttribute ("2002")> _
    Public Year As String
End Class

public class PurchaseOrder
{
    [System.ComponentModel.DefaultValueAttribute ("2002")]
    public string Year;
}

Outra opção é usar um padrão especial para criar um campo booleano reconhecido pelo XmlSerializer e aplicar o XmlIgnoreAttribute ao campo. O padrão é criado na forma de propertyNameSpecified. Por exemplo, se houver um campo chamado "MyFirstName", você também criaria um campo chamado "MyFirstNameSpecified" que instrui o XmlSerializer a gerar ou não o elemento XML chamado "MyFirstName". Isso é mostrado no exemplo a seguir.

Public Class OptionalOrder
    ' This field's value should not be serialized
    ' if it is uninitialized.
    Public FirstOrder As String

    ' Use the XmlIgnoreAttribute to ignore the
    ' special field named "FirstOrderSpecified".
    <System.Xml.Serialization.XmlIgnoreAttribute> _
    Public FirstOrderSpecified As Boolean
End Class

public class OptionalOrder
{
    // This field should not be serialized
    // if it is uninitialized.
    public string FirstOrder;

    // Use the XmlIgnoreAttribute to ignore the
    // special field named "FirstOrderSpecified".
    [System.Xml.Serialization.XmlIgnoreAttribute]
    public bool FirstOrderSpecified;
}

Substituir a serialização padrão

Você também pode substituir a serialização de qualquer conjunto de objetos e seus campos e propriedades criando um dos atributos apropriados e adicionando-o a uma instância da classe XmlAttributes. A substituição da serialização dessa forma tem dois usos: primeiro, você pode controlar e aumentar a serialização de objetos encontrados em uma DLL, mesmo que não tenha acesso à fonte; segundo, você pode criar um conjunto de classes serializáveis, mas serializar os objetos de várias maneiras. Para obter mais detalhes, confira a classe XmlAttributeOverrides e Instruções: Controlar a Serialização de Classes Derivadas.

Para serializar um objeto, chame o método Serialize. Para desserializar um objeto, chame o método Deserialize.

Para adicionar namespaces XML a um documento XML, confira XmlSerializerNamespaces.

Observação

O XmlSerializer dá tratamento especial às classes que implementam IEnumerable ou ICollection. Uma classe que implementa IEnumerable deve implementar um método Add público que aceita um único parâmetro. O parâmetro do método Add deve ser do mesmo tipo retornado pela propriedade Current no valor retornado por GetEnumerator ou em uma das bases desse tipo. Uma classe que implemente ICollection (como CollectionBase) além de IEnumerable deve ter uma propriedade pública Item indexada (indexador em C#) que recebe um número inteiro e deve ter uma propriedade pública Count do tipo inteiro. O parâmetro do método Add deve ser do mesmo tipo que é retornado pela propriedade Item ou uma das bases desse tipo. Para classes que implementam ICollection, os valores a serem serializados são recuperados da propriedade Item indexada, e não chamando GetEnumerator.

Você deve ter permissão para gravar no diretório temporário (conforme definido pela variável de ambiente TEMP) para desserializar um objeto.

Assemblies gerados dinamicamente

Para aumentar o desempenho, a infraestrutura de serialização de XML gera dinamicamente assemblies para serializar e desserializar os tipos especificados. A infraestrutura encontra e reutiliza esses conjuntos. Esse comportamento ocorre somente ao usar os seguintes construtors:

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

Se você usar qualquer um dos outros construtors, várias versões do mesmo assembly serão geradas e nunca serão descarregadas, o que resultará em um vazamento de memória e baixo desempenho. A solução mais fácil é usar um dos dois construtors mencionados anteriormente. Caso contrário, você deve armazenar em cache os conjuntos em um Hashtable, conforme mostrado no exemplo a seguir.

Hashtable serializers = new Hashtable();

// Use the constructor that takes a type and XmlRootAttribute.
XmlSerializer s = new XmlSerializer(typeof(MyClass), myRoot);

// Implement a method named GenerateKey that creates unique keys
// for each instance of the XmlSerializer. The code should take
// into account all parameters passed to the XmlSerializer
// constructor.
object key = GenerateKey(typeof(MyClass), myRoot);

// Check the local cache for a matching serializer.
XmlSerializer ser = (XmlSerializer)serializers[key];
if (ser == null)
{
    ser = new XmlSerializer(typeof(MyClass), myRoot);
    // Cache the serializer.
    serializers[key] = ser;
}

// Use the serializer to serialize or deserialize.

Dim serializers As New Hashtable()

' Use the constructor that takes a type and XmlRootAttribute.
Dim s As New XmlSerializer(GetType([MyClass]), myRoot)

' Implement a method named GenerateKey that creates unique keys
' for each instance of the XmlSerializer. The code should take
' into account all parameters passed to the XmlSerializer
' constructor.
Dim key As Object = GenerateKey(GetType([MyClass]), myRoot)

' Check the local cache for a matching serializer.
Dim ser As XmlSerializer = CType(serializers(key), XmlSerializer)

If ser Is Nothing Then
    ser = New XmlSerializer(GetType([MyClass]), myRoot)
    ' Cache the serializer.
    serializers(key) = ser
End If

' Use the serializer to serialize or deserialize.

Serialização da ArrayList e lista genérica

O XmlSerializer não pode serializar ou desserializar o seguinte:

Serialização de enumerações de Long sem sinal

O XmlSerializer não pode ser instanciado para serializar uma enumeração se as seguintes condições forem verdadeiras: a enumeração é do tipo unsigned long (ulong em C#) e a enumeração contém qualquer membro com um valor maior que 9.223.372.036.854.775.807. Por exemplo, o seguinte não pode ser serializado.

public enum LargeNumbers: ulong
{
    a = 9223372036854775808
}
// At run time, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));

Tipos obsoletos

A XmlSerializer classe não serializa objetos marcados como [Obsolete].