XML hoje: bem formado versus válido, namespaces e quando ainda é a escolha certa

O que é

A recomendação XML 1.0 (citada) distingue as restrições de boa formação (well-formedness), que todo documento XML deve satisfazer (um único elemento raiz, elementos corretamente aninhados e fechados, valores de atributos entre aspas, & e < escapados no conteúdo), das restrições de validade, que só se aplicam a documentos verificados contra uma definição de tipo de documento (DTD) ou, na prática, uma linguagem de schema. A recomendação de Namespaces (citada) acrescenta os nomes expandidos: o nome de cada elemento ou atributo é um par formado por um nome de namespace (uma URI) e um nome local. Os prefixos são associados com xmlns:p="uri" e são apenas uma conveniência local; um namespace padrão xmlns="uri" aplica-se a nomes de elementos sem prefixo, e a recomendação afirma que as declarações de namespace padrão não se aplicam diretamente a nomes de atributos. As declarações valem para o elemento em que aparecem e para tudo o que está abaixo dele.

Por que importa

Os namespaces são o ponto em que o tratamento de XML mais falha: comparar prefixos em vez de URIs, esquecer que um namespace padrão altera silenciosamente a identidade de todos os elementos abaixo dele, ou serializar com outro prefixo e quebrar um consumidor que compara strings. Saber onde está a identidade (a URI mais o nome local) elimina toda uma classe de bugs. Saber a diferença entre bem formado e válido indica o que um parser sem schema realmente verificou: apenas a sintaxe.

Como aplicar

• Escolha XML para dados com perfil de documento e conteúdo misto (texto corrido com marcação embutida), para vocabulários que já são XML (gráficos vetoriais, feeds, formatos de escritório e de publicação) e para trocas com parceiros cujas ferramentas de validação e assinatura são baseadas em XML.
• Prefira JSON para registros trocados entre programas sem marcação embutida, onde o modelo de dados mais simples e o suporte de bibliotecas pesam mais.
• Compare nomes como (URI do namespace, nome local). Ao consultar com XPath ou DOM, associe um prefixo à URI na consulta, mesmo que o documento use um namespace padrão, porque um nome sem prefixo numa consulta não significa "seja qual for o namespace padrão".
• Valide contra um schema na fronteira do sistema e desative a resolução de entidades externas em todos os parsers (veja o artigo relacionado).
• Declare a codificação e garanta que os bytes correspondam a ela; trate o espaço em branco entre elementos como dados, a menos que o schema diga o contrário.

Armadilhas

O nome do namespace é comparado como string: http://example.org/ns e http://example.org/ns/ são namespaces diferentes. Um prefixo sem declaração no escopo é um erro, não um aviso. Redeclarar o namespace padrão dentro de um fragmento muda o significado de tudo o que está abaixo. Os nós de texto guardam o conteúdo já decodificado das entidades; escapar na saída é tarefa do serializador, e fazê-lo duas vezes produz &.