Formater et indenter du XML

Le formatage XML (aussi appelé mise en forme XML, indentation XML ou pretty print) consiste à réorganiser un document XML compact ou minifié en une structure indentée, lisible ligne par ligne. Un XML bien formaté améliore la lisibilité humaine, ce qui est indispensable lorsqu'on doit lire une réponse SOAP, parcourir un flux RSS ou inspecter le contenu d'un fichier de configuration.

Concrètement, on formate son XML pour quatre raisons principales :

• Debug : repérer rapidement une balise non fermée, un attribut manquant ou une structure incohérente.
• Intégration manuelle : copier proprement un fragment dans un fichier de configuration sans casser l'indentation existante.
• Code review : comparer deux versions d'un document XML dans un diff Git devient lisible quand chaque balise est sur sa propre ligne.
• Documentation et exemples : un XML formaté est beaucoup plus pédagogique dans une doc technique ou un README.

Le XML reste omniprésent dans l'écosystème logiciel. Voici les formats sur lesquels les développeurs utilisent le plus souvent un formateur XML :

• Réponses SOAP : les enveloppes <soap:Envelope> retournées par des web services SOAP arrivent généralement minifiées.
• Flux RSS et Atom : pour inspecter ou auditer un flux de syndication.
• Configurations Spring, Maven (pom.xml), Ant, Ivy : fichiers de build et de dépendances Java.
• AndroidManifest.xml et autres ressources XML d'un projet Android.
• Fichiers SVG : un graphique vectoriel exporté depuis un logiciel de design est souvent compressé sur une seule ligne.
• Exports e-commerce : flux produits Google Shopping, exports Magento, Shopify ou PrestaShop.
• Documents OOXML : les fichiers .docx, .xlsx et .pptx sont des archives ZIP contenant des fichiers XML qu'il faut souvent inspecter.
• Sitemaps XML : les sitemap.xml servis aux moteurs de recherche.

Un formateur XML ne se contente pas d'ajouter des espaces au hasard. Il effectue deux étapes :

1. Parsing : le document est lu puis transformé en arbre DOM (Document Object Model). Cette étape valide aussi que le XML est bien formé (balises correctement imbriquées, attributs entre guillemets, un seul élément racine).
2. Sérialisation indentée : l'arbre DOM est ré-émis sous forme de texte avec des sauts de ligne entre les éléments et une indentation proportionnelle à la profondeur dans l'arbre.

Cette approche par arbre garantit que la structure logique du document reste strictement identique : seuls les espaces non significatifs entre balises sont modifiés. Les sections CDATA, les commentaires et les instructions de traitement sont préservés. Les transformations plus poussées (XSLT) ou les requêtes (XPath) opèrent d'ailleurs sur ce même arbre DOM.

La procédure est volontairement simple :

1. Collez votre document XML dans la zone de texte, ou téléversez un fichier .xml.
2. Validez le formulaire : le document est analysé et indenté automatiquement.
3. Le résultat formaté apparaît dans la zone de sortie. En cas d'erreur de parsing, un message indique la nature et la position approximative du problème.
4. Copiez le résultat avec le bouton dédié, ou téléchargez-le pour l'intégrer directement à votre projet.

Quelques conventions à respecter pour produire un XML propre et durable :

• Indentation : 2 ou 4 espaces selon la convention de votre équipe. Restez cohérent dans tout le projet.
• Sauts de ligne : un élément par ligne, ce qui rend les diffs Git exploitables.
• Sections CDATA : un bon formateur conserve intégralement les blocs <![CDATA[ ... ]]> sans réindenter leur contenu, qui est traité comme texte brut.
• Encodage : déclarez toujours l'encodage en première ligne avec <?xml version="1.0" encoding="UTF-8"?>. UTF-8 est le standard de fait.
• Attributs : si un élément a beaucoup d'attributs, certaines équipes les passent à la ligne pour la lisibilité ; sinon ils restent sur la même ligne que la balise ouvrante.
• Commentaires : <!-- ... --> doivent être conservés tels quels par le formateur.

Voici un exemple concret d'un XML compact embelli par le formateur.

Avant (une seule ligne, illisible) :

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

Après (formaté avec 2 espaces) :

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

La structure logique est strictement identique : seul l'agencement visuel change.

Un document XML plus volumineux après formatage ressemble à ceci :

<?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>