XML formázása és behúzása

Az XML formázás (más néven XML elrendezés, XML behúzás vagy pretty print) egy tömör vagy minifikált XML dokumentum átrendezését jelenti behúzott, soronként olvasható szerkezetté. A jól formázott XML javítja az emberi olvashatóságot, ami elengedhetetlen SOAP válaszok olvasásakor, RSS csatornák böngészésekor vagy konfigurációs fájlok tartalmának vizsgálatakor.

Konkrétan négy fő okból formázzunk az XML-t:

• Debug: egy be nem zárt tag, egy hiányzó attribútum vagy egy inkonzisztens szerkezet gyors felismerése.
• Manuális integráció: egy töredék tiszta másolása egy konfigurációs fájlba a meglévő behúzás elrontása nélkül.
• Code review: egy XML dokumentum két verziójának összehasonlítása egy Git diff-ben olvashatóvá válik, ha minden tag saját sorban van.
• Dokumentáció és példák: a formázott XML sokkal szemléletesebb egy technikai dokumentációban vagy egy README-ben.

Az XML továbbra is jelen van a szoftverökoszisztémában. Íme azok a formátumok, amelyeknél a fejlesztők leggyakrabban XML formázót használnak:

• SOAP válaszok: a SOAP webszolgáltatások által visszaadott <soap:Envelope> burkolók általában minifikálva érkeznek.
• RSS és Atom csatornák: egy szindikációs csatorna vizsgálatához vagy auditálásához.
• Spring, Maven (pom.xml), Ant, Ivy konfigurációk: Java build és függőségi fájlok.
• AndroidManifest.xml és egy Android projekt egyéb XML erőforrásai.
• SVG fájlok: egy tervezőszoftverből exportált vektorgrafika gyakran egyetlen sorba van tömörítve.
• E-kereskedelmi exportok: Google Shopping termékcsatornák, Magento, Shopify vagy PrestaShop exportok.
• OOXML dokumentumok: a .docx, .xlsx és .pptx fájlok olyan ZIP archívumok, amelyek XML fájlokat tartalmaznak, amiket gyakran vizsgálni kell.
• XML Sitemaps: a keresőmotoroknak kiszolgált sitemap.xml fájlok.

Az XML formázó nem csak véletlenszerűen ad hozzá szóközöket. Két lépést hajt végre:

1. Parsing: a dokumentum beolvasása, majd DOM (Document Object Model) fává alakítása. Ez a lépés azt is ellenőrzi, hogy az XML jól formázott-e (szabályosan beágyazott tag-ek, idézőjelek közötti attribútumok, egyetlen gyökérelem).
2. Behúzott szerializáció: a DOM fa újra kiadásra kerül szöveges formában, az elemek közötti soremelésekkel és a fa mélységével arányos behúzással.

Ez a faalapú megközelítés garantálja, hogy a dokumentum logikai szerkezete szigorúan azonos marad: csak a tag-ek közötti nem jelentős szóközök módosulnak. A CDATA szakaszok, a megjegyzések és a feldolgozási utasítások megmaradnak. A fejlettebb transzformációk (XSLT) vagy lekérdezések (XPath) szintén ezen a DOM fán működnek.

Az eljárás szándékosan egyszerű:

1. Illessze be az XML dokumentumát a szövegmezőbe, vagy töltsön fel egy .xml fájlt.
2. Hagyja jóvá az űrlapot: a dokumentum elemzése és behúzása automatikusan megtörténik.
3. A formázott eredmény megjelenik a kimeneti zónában. Elemzési hiba esetén egy üzenet jelzi a probléma jellegét és hozzávetőleges helyét.
4. Másolja ki az eredményt a dedikált gombbal, vagy töltse le, hogy közvetlenül integrálja a projektjébe.

Néhány konvenció, amelyet be kell tartani a tiszta és tartós XML létrehozásához:

• Behúzás: 2 vagy 4 szóköz a csapata konvenciójától függően. Maradjon következetes az egész projektben.
• Soremelések: soronként egy elem, ami használhatóvá teszi a Git diff-eket.
• CDATA szakaszok: egy jó formázó hiánytalanul megőrzi a <![CDATA[ ... ]]> blokkokat anélkül, hogy újra behúzná azok tartalmát, amelyet nyers szövegként kezel.
• Kódolás: mindig deklarálja a kódolást az első sorban a <?xml version="1.0" encoding="UTF-8"?> segítségével. Az UTF-8 a de facto szabvány.
• Attribútumok: ha egy elemnek sok attribútuma van, egyes csapatok az olvashatóság érdekében új sorba teszik őket; egyébként a nyitó tag-gel azonos sorban maradnak.
• Megjegyzések: a <!-- ... --> szakaszokat a formázónak változatlanul meg kell őriznie.

Íme egy konkrét példa a formázó által megszépített tömör XML-re.

Előtte (egyetlen sor, olvashatatlan):

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

Utána (2 szóközzel formázva):

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

A logikai szerkezet szigorúan azonos: csak a vizuális elrendezés változik.

Egy nagyobb XML dokumentum formázás után így néz ki:

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