Formatear e indentar XML

El formateo XML (también llamado puesta en forma XML, indentación XML o pretty print) consiste en reorganizar un documento XML compacto o minificado en una estructura indentada, legible línea a línea. Un XML bien formateado mejora la legibilidad humana, lo que es indispensable cuando hay que leer una respuesta SOAP, recorrer un flujo RSS o inspeccionar el contenido de un fichero de configuración.

En concreto, se formatea el XML por cuatro razones principales:

• Depuración: detectar rápidamente una etiqueta sin cerrar, un atributo que falta o una estructura incoherente.
• Integración manual: copiar limpiamente un fragmento en un fichero de configuración sin romper la indentación existente.
• Revisión de código: comparar dos versiones de un documento XML en un diff Git se vuelve legible cuando cada etiqueta está en su propia línea.
• Documentación y ejemplos: un XML formateado es mucho más pedagógico en una documentación técnica o un README.

El XML sigue siendo omnipresente en el ecosistema del software. Estos son los formatos en los que los desarrolladores utilizan más a menudo un formateador XML:

• Respuestas SOAP: los sobres <soap:Envelope> devueltos por los web services SOAP suelen llegar minificados.
• Flujos RSS y Atom: para inspeccionar o auditar un flujo de sindicación.
• Configuraciones Spring, Maven (pom.xml), Ant, Ivy: ficheros de build y de dependencias Java.
• AndroidManifest.xml y otros recursos XML de un proyecto Android.
• Ficheros SVG: un gráfico vectorial exportado desde un software de diseño suele estar comprimido en una sola línea.
• Exportaciones de comercio electrónico: flujos de productos de Google Shopping, exportaciones de Magento, Shopify o PrestaShop.
• Documentos OOXML: los ficheros .docx, .xlsx y .pptx son archivos ZIP que contienen ficheros XML que a menudo es necesario inspeccionar.
• Sitemaps XML: los sitemap.xml servidos a los motores de búsqueda.

Un formateador XML no se contenta con añadir espacios al azar. Realiza dos pasos:

1. Parsing: el documento se lee y, después, se transforma en árbol DOM (Document Object Model). Esta etapa también valida que el XML esté bien formado (etiquetas correctamente anidadas, atributos entre comillas, un solo elemento raíz).
2. Serialización indentada: el árbol DOM se vuelve a emitir como texto con saltos de línea entre los elementos y una indentación proporcional a la profundidad en el árbol.

Este enfoque por árbol garantiza que la estructura lógica del documento permanece estrictamente idéntica: solo se modifican los espacios no significativos entre etiquetas. Las secciones CDATA, los comentarios y las instrucciones de procesamiento se preservan. Las transformaciones más profundas (XSLT) o las consultas (XPath) operan, además, sobre ese mismo árbol DOM.

El procedimiento es deliberadamente sencillo:

1. Pegue su documento XML en la zona de texto, o suba un fichero .xml.
2. Valide el formulario: el documento se analiza y se indenta automáticamente.
3. El resultado formateado aparece en la zona de salida. En caso de error de parsing, un mensaje indica la naturaleza y la posición aproximada del problema.
4. Copie el resultado con el botón correspondiente, o descárguelo para integrarlo directamente en su proyecto.

Algunas convenciones que respetar para producir un XML limpio y duradero:

• Indentación: 2 o 4 espacios según la convención de su equipo. Manténgase coherente en todo el proyecto.
• Saltos de línea: un elemento por línea, lo que hace que los diffs Git sean utilizables.
• Secciones CDATA: un buen formateador conserva íntegramente los bloques <![CDATA[ ... ]]> sin reindentar su contenido, que se trata como texto en bruto.
• Codificación: declare siempre la codificación en la primera línea con <?xml version="1.0" encoding="UTF-8"?>. UTF-8 es el estándar de hecho.
• Atributos: si un elemento tiene muchos atributos, algunos equipos los pasan a la línea siguiente para mejorar la legibilidad; si no, permanecen en la misma línea que la etiqueta de apertura.
• Comentarios: <!-- ... --> deben conservarse tal cual por el formateador.

Este es un ejemplo concreto de un XML compacto embellecido por el formateador.

Antes (una sola línea, ilegible):

<root><item id="1">val</item><item id="2">val2</item></root>

Después (formateado con 2 espacios):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <item id="1">val</item>
  <item id="2">val2</item>
</root>

La estructura lógica es estrictamente idéntica: solo cambia la disposición visual.

Un documento XML más voluminoso tras el formateo se parece a esto:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <user id="12345">
    <name>John Doe</name>
    <email>johndoe@example.com</email>
    <address>
      <street>123 Main St</street>
      <city>Springfield</city>
      <state>IL</state>
      <postalCode>62704</postalCode>
      <country>USA</country>
    </address>
    <phoneNumbers>
      <phoneNumber type="home">555-1234</phoneNumber>
      <phoneNumber type="work">555-5678</phoneNumber>
    </phoneNumbers>
    <preferences>
      <newsletter>true</newsletter>
      <theme>dark</theme>
    </preferences>
    <lastLogin>2024-06-14T09:30:00Z</lastLogin>
  </user>
</root>