Formatarea și indentarea XML

Formatarea XML (numită și punere în formă XML, indentare XML sau pretty print) constă în reorganizarea unui document XML compact sau minifiat într-o structură indentată, lizibilă linie cu linie. Un XML bine formatat îmbunătățește lizibilitatea umană, ceea ce este indispensabil când trebuie să citești un răspuns SOAP, să parcurgi un flux RSS sau să inspectezi conținutul unui fișier de configurare.

Concret, se formatează XML-ul pentru patru motive principale:

• Debug: a identifica rapid o etichetă neînchisă, un atribut lipsă sau o structură incoerentă.
• Integrare manuală: a copia curat un fragment într-un fișier de configurare fără a sparge indentarea existentă.
• Code review: a compara două versiuni ale unui document XML într-un diff Git devine lizibil când fiecare etichetă este pe propria linie.
• Documentație și exemple: un XML formatat este mult mai pedagogic într-o documentație tehnică sau un README.

XML-ul rămâne omniprezent în ecosistemul software. Iată formatele pe care dezvoltatorii utilizează cel mai adesea un formatator XML:

• Răspunsuri SOAP: plicurile <soap:Envelope> returnate de web service-uri SOAP sosesc în general minifiate.
• Fluxuri RSS și Atom: pentru a inspecta sau audita un flux de sindicare.
• Configurări Spring, Maven (pom.xml), Ant, Ivy: fișiere de build și dependențe Java.
• AndroidManifest.xml și alte resurse XML ale unui proiect Android.
• Fișiere SVG: un grafic vectorial exportat dintr-un software de design este adesea comprimat pe o singură linie.
• Exporturi e-commerce: fluxuri produse Google Shopping, exporturi Magento, Shopify sau PrestaShop.
• Documente OOXML: fișierele .docx, .xlsx și .pptx sunt arhive ZIP conținând fișiere XML pe care trebuie adesea să le inspectezi.
• Sitemap-uri XML: sitemap.xml-urile servite motoarelor de căutare.

Un formatator XML nu se mulțumește să adauge spații la întâmplare. Efectuează două etape:

1. Parsing: documentul este citit apoi transformat într-un arbore DOM (Document Object Model). Această etapă validează de asemenea că XML-ul este bine format (etichete corect imbricate, atribute între ghilimele, un singur element rădăcină).
2. Serializare indentată: arborele DOM este re-emis sub formă de text cu salturi de linie între elemente și o indentare proporțională cu adâncimea în arbore.

Această abordare prin arbore garantează că structura logică a documentului rămâne strict identică: doar spațiile nesemnificative între etichete sunt modificate. Secțiunile CDATA, comentariile și instrucțiunile de procesare sunt păstrate. Transformările mai avansate (XSLT) sau interogările (XPath) operează de altfel pe același arbore DOM.

Procedura este intenționat simplă:

1. Lipește documentul tău XML în zona de text, sau încarcă un fișier .xml.
2. Validează formularul: documentul este analizat și indentat automat.
3. Rezultatul formatat apare în zona de ieșire. În caz de eroare de parsing, un mesaj indică natura și poziția aproximativă a problemei.
4. Copiază rezultatul cu butonul dedicat, sau descarcă-l pentru a-l integra direct în proiectul tău.

Câteva convenții de respectat pentru a produce un XML curat și durabil:

• Indentare: 2 sau 4 spații în funcție de convenția echipei tale. Rămâi coerent în tot proiectul.
• Salturi de linie: un element pe linie, ceea ce face diff-urile Git exploatabile.
• Secțiuni CDATA: un bun formatator păstrează integral blocurile <![CDATA[ ... ]]> fără a reindenta conținutul lor, care este tratat ca text brut.
• Codare: declară întotdeauna codarea în prima linie cu <?xml version="1.0" encoding="UTF-8"?>. UTF-8 este standardul de facto.
• Atribute: dacă un element are multe atribute, anumite echipe le trec pe linia următoare pentru lizibilitate; altfel rămân pe aceeași linie cu eticheta deschizătoare.
• Comentarii: <!-- ... --> trebuie păstrate ca atare de formatator.

Iată un exemplu concret al unui XML compact înfrumusețat de formatator.

Înainte (o singură linie, ilizibil):

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

După (formatat cu 2 spații):

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

Structura logică este strict identică: doar aranjamentul vizual se schimbă.

Un document XML mai voluminos după formatare arată astfel:

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