XML formatieren

Warum das Neueinrücken von XML riskanter ist, als es aussieht

Leerraum ist in XML standardmäßig bedeutsam – und genau darüber stolpern viele. Anders als bei JSON, wo die Formatierung keine Rolle spielt, muss ein XML-Parser die Leerzeichen und Zeilenumbrüche zwischen Elementen als Textinhalt melden; erst das Schema, sofern es eines gibt, legt fest, dass sie ignoriert werden dürfen. Neues Einrücken verändert ein Dokument also tatsächlich. Bei den meisten Konfigurations- und Datendateien stört das niemanden, bei Dokumenten mit gemischtem Inhalt – Text und Elemente nebeneinander, wie in XHTML oder DocBook – kann es jedoch verändern, was das Dokument aussagt.

Beim Formatieren bleibt hier deshalb unangetastet, was unangetastet bleiben muss. Ein Element mit xml:space="preserve" behält seinen Inhalt genau so, wie er geschrieben ist, denn genau dafür gibt es dieses Attribut. CDATA-Abschnitte werden unverändert durchgereicht: Sie enthalten Text, der nicht interpretiert werden darf, und eine Umformatierung darin würde ihn beschädigen. Entitätsreferenzen bleiben Referenzen und werden nicht in die Zeichen aufgelöst, für die sie stehen.

Namespaces bleiben genau so erhalten, wie sie geschrieben sind – Präfixe, Deklarationen und die Elemente, an die sie gebunden sind. Das klingt selbstverständlich, ist es aber nicht: Ein Formatierer, der Präfixe normalisiert oder Deklarationen dorthin verschiebt, wo sie seiner Meinung nach hingehören, erzeugt ein Dokument, das technisch gleichwertig ist und dennoch an Tools scheitert, die auf wörtliche Präfixe prüfen. Auch die Reihenfolge der Attribute bleibt erhalten, obwohl sie für XML bedeutungslos ist – aus demselben Grund: Ein Diff gegen die vorherige Version ist mehr wert als Ordnung.

Beim Formatieren wird die Wohlgeformtheit geprüft: jedes Tag geschlossen, korrekt verschachtelt, genau ein Wurzelelement, zulässige Zeichen, korrekt maskierte kaufmännische Und-Zeichen und spitze Klammern. Das ist die niedrigere der beiden Hürden von XML. Ein Dokument kann vollkommen wohlgeformt und trotzdem gegen die DTD oder das Schema ungültig sein, dem es unterliegt – und das zeigt keine Formatierung der Welt.

Wenn Sie etwas anderes brauchen

xmllint --format in.xml erledigt dasselbe auf der Kommandozeile und ist auf den meisten Unix-Systemen bereits installiert; xmlstarlet fo --indent-tab bietet mehr Kontrolle über die Einrückung selbst. Beide verarbeiten Dateien, die weit größer sind, als eine Webseite im Speicher halten kann.

Wenn das Dokument verglichen, signiert oder in kanonischer Form gespeichert werden soll, ist Formatieren grundsätzlich der falsche Schritt. Canonical XML – xmllint --c14n – erzeugt die eine normalisierte Form, auf die sich zwei gleichwertige Dokumente beide zurückführen lassen, und genau darauf beruhen digitale Signaturen über XML. Ein signiertes Dokument hübsch zu formatieren, macht seine Signatur ungültig – und das ist die teuerste Art, das zu lernen.