CodeGym /Cursos /C# SELF /Trabalhando avançado com XML: XmlDocument e XPath

Trabalhando avançado com XML: XmlDocument e XPath

C# SELF
Nível 48, Lição 2
Disponível

1. Introdução

Imagine um XML gigante que algum serviço SOAP ou API bancária te enviou. Nele há centenas de elementos aninhados, estruturas heterogêneas, e você precisa achar apenas um único valor: a soma dos pagamentos do mês passado. Serializar aqui não serve — é pesado e você não sabe de antemão onde olhar. Você precisa de uma "lupa" para a árvore XML e saber como percorrer seus ramos rápido.

Exatamente para esses casos no .NET existe há muitos anos uma ferramenta poderosa — a classe XmlDocument, complementada pela linguagem de consultas XPath. Hoje você vai aprender:

  • Carregar XML numa árvore DOM;
  • Percorrer e encontrar elementos manualmente e com XPath;
  • Modificar o conteúdo do documento XML;
  • Adicionar, remover e alterar nós;
  • Usar XPath para seleções complexas.

2. O que é XmlDocument?

XmlDocument — classe do namespace System.Xml. É uma implementação do DOM (Document Object Model) — representação de todo o arquivo XML como uma árvore de objetos na memória.

Um pouco de teoria e analogias

Se XmlSerializer é como um construtor LEGO, onde você transforma um objeto num conjunto de pecinhas e de volta, então XmlDocument é como trabalhar com uma árvore real: tem raíz, ramos (elementos), folhas (nós de texto), e você pode andar por essa árvore, adicionar ramos, cortar folhas e transplantar onde quiser.

Carregando um documento XML simples

Suponha que temos este XML:

<users>
  <user id="1">
    <name>Olga</name>
    <age>28</age>
  </user>
  <user id="2">
    <name>Igor</name>
    <age>35</age>
  </user>
</users>

Vamos carregá-lo na memória:

using System.Xml;

string xml = @"
<users>
  <user id='1'>
    <name>Olga</name>
    <age>28</age>
  </user>
  <user id='2'>
    <name>Igor</name>
    <age>35</age>
  </user>
</users>";

XmlDocument doc = new XmlDocument();
doc.LoadXml(xml); // ou doc.Load("caminho_para_arquivo.xml");

Após chamar LoadXml (ou Load, se o XML vier de arquivo) você tem acesso completo ao conteúdo do documento.

3. Navegação pela árvore DOM

Estrutura da árvore DOM

Cada documento XML depois de carregado vira uma árvore composta por nós de tipos diferentes:

Tipo de nó Classe em .NET Exemplo
Document XmlDocument
<users>...</users>
Element XmlElement
<user>, <name>
Attribute XmlAttribute
id="1"
Text XmlText Olga, 28
Comment XmlComment
<!-- comentário -->

Para acessar elementos necessários você vai "andar pela árvore" usando propriedades como ChildNodes, Attributes, ParentNode etc.

Pegando o elemento raiz

XmlElement root = doc.DocumentElement;
Console.WriteLine(root.Name); // users

Iterando elementos filhos

foreach (XmlNode node in root.ChildNodes)
{
    if (node is XmlElement user)
    {
        // user — é <user id="...">...</user>
        string id = user.GetAttribute("id");
        string name = user["name"].InnerText;
        string age = user["age"].InnerText;
        Console.WriteLine($"Usuário {id}: {name}, idade {age}");
    }
}

IMPORTANTE: O acesso user["name"] funciona apenas se entre os filhos diretos existir o elemento <name>.

Acesso a atributos e texto

var firstUser = root.FirstChild as XmlElement;
string id = firstUser.GetAttribute("id"); // "1"
string name = firstUser["name"].InnerText; // "Olga"

4. Modificando o documento XML

Alterando um valor

Suponha que Olga decidiu "rejuvenescer":

var olga = root.FirstChild as XmlElement;
olga["age"].InnerText = "22"; // agora <age>22</age>

Adicionando um novo usuário

XmlElement newUser = doc.CreateElement("user");
newUser.SetAttribute("id", "3");

XmlElement name = doc.CreateElement("name");
name.InnerText = "Vasilisa";
XmlElement age = doc.CreateElement("age");
age.InnerText = "19";

newUser.AppendChild(name);
newUser.AppendChild(age);
root.AppendChild(newUser);

Removendo um elemento

Vamos remover o segundo usuário ("Igor"):

XmlNode userToDelete = root.SelectSingleNode("user[@id='2']");
if (userToDelete != null)
    root.RemoveChild(userToDelete);

Salvando alterações

doc.Save("users_updated.xml");
// Ou doc.OuterXml — para obter a string com o XML

5. XPath — linguagem de busca e seleção em XML

Trabalhar com a árvore DOM fica cansativo quando é preciso procurar elementos "por condição" — por exemplo, todos os usuários com mais de 25 anos. Para isso existe XPath — uma linguagem de navegação na árvore XML.

Uso básico de XPath

Consultas XPath podem ser executadas com os métodos SelectSingleNode (retorna o primeiro nó encontrado) e SelectNodes (retorna uma coleção de nós).

Exemplo: achar o usuário com id = 1

XmlNode user = root.SelectSingleNode("user[@id='1']");
Console.WriteLine(user["name"].InnerText); // Olga

Exemplo: achar todos os usuários com mais de 25 anos

XmlNodeList nodes = root.SelectNodes("user[age>25]");
foreach (XmlNode u in nodes)
{
    Console.WriteLine(u["name"].InnerText); // Vai imprimir Olga e Igor (se Igor ainda não tiver sido removido)
}

XPath — sintaxe curta

Expressão XPath O que faz
/users/user
Todos os elementos <user> dentro da raiz <users>
user[@id='3']
Usuário com id=3
user[age>25]
Usuários com mais de 25 anos
user/name
Todos os elementos <name> de todos os usuários
user[last()]
Último <user>
user[position()<3]
Os dois primeiros <user>

Mais exemplos e sintaxe: Documentação de XPath.

Outro exemplo: seleção por elementos aninhados

Suponha que o XML seja mais complexo:

<library>
  <book>
    <title>O Senhor das Moscas</title>
    <author>
      <firstname>William</firstname>
      <lastname>Golding</lastname>
    </author>
  </book>
  <book>
    <title>A Onda</title>
    <author>
      <firstname>Marcel</firstname>
      <lastname>Proust</lastname>
    </author>
  </book>
</library>
XmlDocument doc = new XmlDocument();
doc.LoadXml(libraryXml);
XmlNodeList authors = doc.SelectNodes("/library/book/author/lastname");
foreach (XmlNode lastName in authors)
    Console.WriteLine(lastName.InnerText);

O que será impresso:

Golding
Proust

6. XPath: filtragem, lógica, cálculos

Filtros lógicos

Imprimir os nomes de todos os usuários cuja idade está entre 18 e 30:

// [age>=18 and age<=30]
XmlNodeList youngUsers = root.SelectNodes("user[age>=18 and age<=30]");
foreach (XmlNode u in youngUsers)
    Console.WriteLine(u["name"].InnerText);

Trabalhando com atributos

Atributos são selecionados com @. Vamos achar usuários cujo id começa com "1":

XmlNodeList nodes = root.SelectNodes("user[starts-with(@id, '1')]");

Contando nós

Diretamente no método SelectNodes em C# não dá para usar a função count() — ele retorna uma coleção, não um número. Mas você pode fazer:

int count = root.SelectNodes("user").Count;

Filtros aninhados

XmlNodeList nodes = doc.SelectNodes("/library/book[author/lastname='Golding']");

7. XPath e namespaces

Se o seu XML usa namespaces (xmlns), as coisas ficam um pouco mais divertidas! Nestes casos use XmlNamespaceManager:

<catalog xmlns="http://books.example.com">
  <book>
    <title>Algoritmos</title>
  </book>
</catalog>
doc.LoadXml(xml);
XmlNamespaceManager nsmgr = new XmlNamespaceManager(doc.NameTable);
nsmgr.AddNamespace("b", "http://books.example.com");

XmlNodeList books = doc.SelectNodes("/b:catalog/b:book", nsmgr);
foreach (XmlNode book in books)
    Console.WriteLine(book.SelectSingleNode("b:title", nsmgr)?.InnerText);

8. Modificação de XML com DOM

Adicionando nós "on the fly"

Vamos adicionar um novo elemento <email> ao primeiro usuário:

XmlElement email = doc.CreateElement("email");
email.InnerText = "olga@gmail.com";
olga.AppendChild(email);

Alterando atributos

olga.SetAttribute("id", "99"); // Agora id="99"

Removendo nós com XPath

XmlNodeList nodesToRemove = root.SelectNodes("user[age<20]");
foreach (XmlNode node in nodesToRemove)
    root.RemoveChild(node);

9. Dicas úteis

Busca e alteração em massa da estrutura

Imagine que você recebe um XML grande com vários elementos <record type="...">. Precisa deixar apenas os que têm no atributo type o valor "customer", e adicionar a cada um um filho <status>active</status>.

XmlNodeList customerNodes = root.SelectNodes("record[@type='customer']");
foreach (XmlElement record in customerNodes)
{
    XmlElement status = doc.CreateElement("status");
    status.InnerText = "active";
    record.AppendChild(status);
}

Árvore de nós XML (DOM)


users
├─ user (id="1")
│   ├─ name ("Olga")
│   └─ age ("28")
├─ user (id="2")
│   ├─ name ("Igor")
│   └─ age ("35")

Exemplo de seleção com XPath

Consulta XPath O que retorna
/users/user[1]
Primeiro usuário (id="1")
/users/user[last()]
Último usuário (id="2")
/users/user[age>30]
Todos com mais de 30 anos (Igor)
/users/user[@id='2']
Usuário com id="2"

Aplicação prática

  • Integrações com APIs "legadas". Em muitas corporações estatais e bancos SOAP/XML ainda dominam. A habilidade de achar e mudar algo rapidamente num XML grande pode economizar dezenas de horas.
  • Migração de dados. Ao migrar entre sistemas muitas vezes é necessário parsear XML, fazer seleções complexas, transformar e alterar em massa.
  • Import/export para Excel. Em muitos produtos B2B a entrada ainda vem em XML. Lá XPath é uma forma rápida de extrair o que precisa sem criar um grande modelo de dados.

10. Erros, nuances e armadilhas típicas

NullReferenceException: Se você tentar acessar um elemento inexistente, por exemplo el["something"].InnerText, e esse filho não existir, vai rolar null. Sempre verifique se é null.

XPath e nível de aninhamento: Lembre que expressão sem a barra inicial / busca entre os descendentes do nó atual, e com / — a partir da raiz do documento. Pontos de referência diferentes podem levar a nenhum resultado, mesmo existindo dados.

Trabalhar com namespaces: Se você não usar XmlNamespaceManager, consultas XPath em XML com xmlns vão retornar vazio.

Modificar enquanto itera: Se quiser remover nós com base no resultado de SelectNodes, primeiro salve-os num array e só depois itere — caso contrário a coleção muda durante a iteração e podem surgir erros.

Diferença entre nós de texto e elementos: Entre elementos podem existir nós de texto — espaços e quebras de linha que o XML considera conteúdo. Para seleção mais rigorosa use apenas XmlElement ou filtre por NodeType.

2
Tarefa
C# SELF, nível 48, lição 2
Bloqueado
Buscando elementos com XPath
Buscando elementos com XPath
Comentários
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION