Como especificar um nome de elemento alternativo para um fluxo XML

  • Artigo

Usando o XmlSerializer, você pode gerar mais de um fluxo de XML com o mesmo conjunto de classes. Você deve querer fazer isso porque dois diferentes serviços Web XML exigem as mesmas informações básicas, com apenas poucas diferenças. Por exemplo, imagine dois serviços Web XML que processam pedidos para livros e, portanto, exigem números ISBN. Um serviço usa a marca <ISBN>, enquanto o segundo usa a marca <BookID>. Você tem uma classe nomeada Book que contém um campo nomeado ISBN. Quando uma instância da classe Book é serializada, ela, por padrão, usará o nome de membro (ISBN) como o nome de elemento da marca. Para o primeiro serviço Web XML, esse é o esperado. Mas, para enviar o fluxo XML para o segundo serviço Web XML, você deverá sobrescrever a serialização para que o nome do elemento da marca seja BookID.

Para criar um fluxo XML com um nome de elemento alternativo

  1. Criar uma instância da classe XmlElementAttribute.

  2. Defina o ElementName do XmlElementAttribute como "BookID".

  3. Criar uma instância da classe XmlAttributes.

  4. Adicione o objeto XmlElementAttribute à coleção acessada por meio da propriedade XmlElements de XmlAttributes.

  5. Criar uma instância da classe XmlAttributeOverrides.

  6. Adicione o XmlAttributes ao XmlAttributeOverrides, passando o tipo do objeto para sobrescrever e o nome do membro que está sendo sobrescrito.

  7. Crie uma instância da classe XmlSerializer com XmlAttributeOverrides.

  8. Crie uma instância da classe Book e serialize-a ou desserialize-a.

Exemplo

Public Function SerializeOverride()  
    ' Creates an XmlElementAttribute with the alternate name.  
    Dim myElementAttribute As XmlElementAttribute = _  
    New XmlElementAttribute()  
    myElementAttribute.ElementName = "BookID"  
    Dim myAttributes As XmlAttributes = New XmlAttributes()  
    myAttributes.XmlElements.Add(myElementAttribute)  
    Dim myOverrides As XmlAttributeOverrides = New XmlAttributeOverrides()  
    myOverrides.Add(typeof(Book), "ISBN", myAttributes)  
    Dim mySerializer As XmlSerializer = _  
    New XmlSerializer(GetType(Book), myOverrides)  
    Dim b As Book = New Book()  
    b.ISBN = "123456789"  
    ' Creates a StreamWriter to write the XML stream to.  
    Dim writer As StreamWriter = New StreamWriter("Book.xml")  
    mySerializer.Serialize(writer, b);  
End Class  

public void SerializeOverride()  
{  
    // Creates an XmlElementAttribute with the alternate name.  
    XmlElementAttribute myElementAttribute = new XmlElementAttribute();  
    myElementAttribute.ElementName = "BookID";  
    XmlAttributes myAttributes = new XmlAttributes();  
    myAttributes.XmlElements.Add(myElementAttribute);  
    XmlAttributeOverrides myOverrides = new XmlAttributeOverrides();  
    myOverrides.Add(typeof(Book), "ISBN", myAttributes);  
    XmlSerializer mySerializer =
    new XmlSerializer(typeof(Book), myOverrides);
    Book b = new Book();  
    b.ISBN = "123456789";
    // Creates a StreamWriter to write the XML stream to.  
    StreamWriter writer = new StreamWriter("Book.xml");  
    mySerializer.Serialize(writer, b);  
}

O fluxo XML pode ter a seguinte aparência.

<Book>  
    <BookID>123456789</BookID>  
</Book>

Confira também