Als XML meinen Nachmittag zum ersten Mal beinahe ruinierte, war es eine SOAP-Antwort von einem Zahlungsgateway Eine Zeile Elf tausend Zeichen Keine Zeilen, keine Einrückung, nur eine ununterbrochene Wand aus spitzen Klammern, die mein Terminal in einen unlesbaren Ziegelstein gewickelt hatte Irgendwo drin war ein einziges falsches Element, das eine Signatur-Fehlübereinstimmung verursacht, und ich sollte es nach Augenmaß finden Seitdem habe ich viele Dinge gebaut - WordPress-Plugins, Laravel-APIs, das React-Tooling dahinter [Toolz.dev] (/ - und ich kann Ihnen sagen, dass ein guter XML-Formatierer eines dieser leisen Dienstprogramme ist, die Sie erst in dem Moment zu schätzen wissen, wenn Sie auf eine Wand aus Tags mit einer Frist hinter sich blicken lassen.
Diese Anleitung ist die, die ich an diesem Nachmittag gerne hatte Sie behandelt, was ein XML-Formatierer tatsächlich macht, warum Verschönern und Minifizieren zwei Seiten derselben Medaille sind, die Leerzeichenregel, die die Formatierung sicher macht, und die Handvoll Validierungsfehler, die für fast jedes & quot; why won' t this parse" Moment. Sie können im Browser mit dem kostenlosen mitverfolgen XML-Formater - es läuft vollständig auf Ihrem Computer, sodass selbst eine Zahlungslast Ihren Laptop nie verlässt.
tl; dr: Ein XML-Formatierer schreibt ein Dokument neu. & #39;s unbedeutender Leerraum - der Raum zwischen Tags - ohne seine Bedeutung zu berühren Verschönern fügt Zeilenumbrüche und Einrückungen hinzu, damit Sie die Hierarchie lesen können; minifizieren Sie Streifen davon, damit die Datei so klein wie möglich ist Ein guter Formatierer bewahrt Kommentare, CDATA, die XML-Deklaration und die Attributreihenfolge und validiert unterwegs die Wohlgeformtheit (passende Tags, geschlossene Elemente, beendete Abschnitte).Das tut es nicht Überprüfen Sie Ihr Dokument anhand eines DTD- oder XSD-Schemas - das ist ein anderer Job.
Was macht eigentlich ein XML-Formatierer?
Im Leerraum wird die Formatierung interessant, weil XML 1.0 erfordert, dass ein Parser jedes Zeichen innerhalb eines Elements an die Anwendung durchgibt - weshalb ein Formatierer wissen muss, was er sicher anfassen kann Im Kern analysiert ein XML-Formatierer Ihr Dokument in einen Baum von Knoten - Elemente, Text, Kommentare, CDATA-Abschnitte, Verarbeitungsanweisungen - und serialisiert diesen Baum dann mit konsistenten Abständen wieder heraus. Dieser Hin- und Rückweg ist der ganze Trick. Da das Tool die Struktur versteht und kein blindes Finden und Ersetzen durchführt, kann es ein tief verschachteltes Gerät einrücken <order><items><item> Kette richtig, jedes Geschwister auf eine eigene Zeile setzen, und wissen, dass der Text im Inneren <price>44.95</price> Auf der gleichen Linie wie seine Tags bleiben sollte, anstatt sich über drei zu erstrecken.
Der Grund dafür liegt in einer in der XML-Spezifikation vergrabenen Regel: Der größte Teil des Leerraums zwischen Elementen beträgt Unwesentlich. Wenn ein Parser liest <a>\n <b/>\n</a>Die Zeilenumbrüche und Räume um <b/> Sind für den Menschen da und tragen keine Daten Ein Formatierer darf diesen Leerraum frei hinzufügen, entfernen oder ändern Was er niemals berühren darf ist Signifikant Leerzeichen - die Zeichen innerhalb eines Textknotens wie <note>Call me at 9am</note>, oder irgendetwas innerhalb eines CDATA-Blocks - weil dieser Inhalt echte Daten sind Jede Formatierungsentscheidung die XML-Formater Strom fließt, indem er diese Linie respektiert.
Verschönern ist also kein kosmetischer Flaum. Wenn Sie diesen elftausendstelligen SOAP-Stein erneut einrücken, wird die Elementhierarchie sichtbar und plötzlich wird sie verlegt <Amount> Knoten drei Ebenen zu tief ist offensichtlich Formatieren ist ein Debugging-Tool so viel wie ein lesbares.
Warum sollte ich XML minifizieren, anstatt es zu verschönern?
Verschönern und minifizieren sind die gleiche Engine, die in entgegengesetzte Richtungen zeigt Verschönern fügt Leerraum für Menschen hinzu; minify entfernt es für Maschinen. Sie greifen zu minifizieren, wenn es um Größe oder Transport geht: Verkleinern einer Konfigurationsdatei, die in einem mobilen App-Bundle versendet wird, Beschneiden eines Anforderungskörpers, bevor er über eine langsame Verbindung geht, oder Normalisieren eines Dokuments, damit zwei Versionen Byte für Byte verglichen werden können, ohne dass Einrückungsgeräusche im Weg sind.
Die Einsparung ist real, aber selten dramatisch. XML' s Ausführlichkeit lebt in seinen wiederholten Tag-Namen, nicht in seinem Leerraum, so dass das Minifizieren normalerweise zwischen fünf und zwanzig Prozent schneidet, je nachdem, wie stark eingerückt das Original war Das lohnt sich, aber wenn Sie eine ernsthafte Komprimierung benötigen, gzip auf dem Draht macht weit mehr - Minifizieren und dann gzippen ist der Gürtel-und-Streben-Ansatz, den viele APIs verwenden.
Hier ist das mentale Modell, das ich verwende, wenn ich entscheide, in welche Richtung ich das Tool zeigen soll:
| Situation | verschönern | minimieren |
|---|---|---|
| Lesen oder Debuggen einer Antwort nach Augenmaß | ja | kein |
| Übertragen einer Konfigurationsdatei an die Versionskontrolle | Ja (saubere Diffs) | kein |
| Versand von XML innerhalb eines App-Bundles oder über das Netzwerk | kein | ja |
| Speicherung vieler kleiner Dokumente in einer Datenbankspalte | kein | ja |
| Vorbereiten eines Dokuments für ein Byte-für-Byte-Diff | Entweder, konsequent | Entweder, konsequent |
| XML an einen anderen Entwickler übergeben | ja | kein |
Die Schlüsseldisziplin ist Konsistenz Wenn Sie zwei Dokumente verbreiten, laufen Sie beide Durch den gleichen Modus mit den gleichen Optionen zuerst - sonst vergleichen Sie Einrückungsstile, nicht Inhalte.
Wie wird durch Formatierung vermieden, dass sich meine Daten ändern?
Das ist die Angst, die jeder Formatierer hat, um sich seinen Weg über: & quot; wenn dieses Tool mein XML neu schreibt, woher weiß ich dann, dass es nicht stillschweigend etwas kaputt gemacht hat? " Die ehrliche Antwort ist, dass ein gut gebauter Formatierer immer nur den Leerraum zwischen Tags ändert und vier Dinge strikt in Ruhe lässt.
Der erste ist Textinhalt. Die Zeichen innerhalb eines Elements werden wörtlich kopiert Dazu gehören Entitäten - ein wörtliches & Aufenthalte &Es wird niemals hilfreich entschlüsselt & (was ungültiges XML erzeugen würde) oder doppelt codiert &amp;drohen der XML-Formater Behandelt Ihren Text als undurchsichtig, was genau das ist, was Sie wollen.
Der zweite ist CDATA-abschnittedrohen ein <![CDATA[ ... ]]> Block existiert genau, damit Sie rohe, nicht entweichte Inhalte ablegen können - einen Ausschnitt aus JavaScript, einen Teil von HTML, eine Zeichenfolge voller < und & - in ein XML-Dokument, ohne es zu entkommen Ein Formatierer sendet diesen Inhalt genau so aus, wie er ihn gefunden hat, kein Entweichen, kein erneutes Einrücken innerhalb des Blocks.
Der dritte ist Bemerkungen und die Erklärung. Kommentare (<!-- ... -->), das <?xml version="1.0"?> Deklaration, und jegliche Bearbeitungsanweisungen werden erhalten und sinnvoll platziert Sie können wählen, Kommentare zu streifen, wenn Sie eine schlankere Datei wollen, aber das ist Ihre Entscheidung, nicht etwas, was das Tool hinter Ihrem Rücken tut.
Der vierte ist Attributreihenfolge und Zitat. Standardmäßig behält der Formatierer Ihre Attribute in der Reihenfolge, in der Sie sie geschrieben haben, mit dem von Ihnen verwendeten Zitatstil, da die XML-Spezifikation die Attributreihenfolge als unbedeutend behandelt und es keinen Grund gibt, sie zu ändern. Wenn Sie anstellen Wollen eine kanonische Reihenfolge - für sauberere Diffs, oder um zwei Elemente zu vergleichen, die dieselben Attribute in unterschiedlicher Reihenfolge tragen - ein & quot; sort attributs" Option setzt sie in alphabetischer Reihenfolge für Sie.
Da dies alles clientseitig in JavaScript läuft, gibt es auch eine Dividende für den Datenschutz: Ein Dokument voller Verbindungszeichenfolgen, interner Identifikatoren oder Kundendatensätze wird auf Ihrem eigenen Computer formatiert und nie hochgeladen Wenn es Ihnen wichtig ist, Arbeitsdaten von anderen Personen fernzuhalten's-Servern - und das sollten Sie - ist dieses Modell verständniswürdig, und ich habe mehr darüber in der geschrieben Datenschutzleitfaden für Online-Toolsdrohen
Welche XML-Fehler fängt der Formatierer auf?
Bevor ein Formatierer alles hübsch drucken kann, muss er das Dokument analysieren, und beim Parsen erfolgt die nützliche Validierung. Das ist Wohlgeformtheit Überprüfung - die strukturellen Regeln, die jedes XML-Dokument befolgen muss - und meiner Erfahrung nach sind drei Fehler für die überwiegende Mehrheit der Fehler verantwortlich.
Am häufigsten ist mit Abstand ein Nackter Amperand. XML-Reserven & Entität zu starten, also ein rohes & Im Text - die Art, die sich durch eine URL wie einschleicht ?a=1&b=2 oder einen Firmennamen wie " Markierungen & amp; Spencer" - lässt den Parser einen Entitätsnamen erwarten und erstickt dann, wenn er keinen findet Die Lösung besteht darin, zu schreiben &, und eine gute Fehlermeldung wird Sie an die Linie zeigen, damit Sie nicht blind jagen.
Der zweite ist ein Nicht übereinstimmendes oder nicht geschlossenes Tag. Öffnen Sie a <div> Und schließen Sie es mit </section>oder öffnen Sie ein <span> Und nie schließen, und das Dokument ist nicht mehr gut geformt Der Formatierer verfolgt den Open-Element-Stack beim Parsen, so kann er Ihnen genau sagen, welches Tag er voraussichtlich geschlossen sehen wird und welches er tatsächlich gefunden hat Diese einzelne Nachricht - " erwartet </book> Aber gefunden </author> In Zeile 14" - reicht normalerweise aus, um das Problem in Sekundenschnelle zu lösen.
Der dritte ist ein Nicht terminierter Abschnitt: ein Kommentar eröffnet mit <!-- Das erreicht nie -->oder ein CDATA-Block, der nie erreicht ]]>. Diese sind bei der Handbearbeitung einfach zu erstellen und etwas zu viel zu löschen, wieder meldet der Formatierer die Zeile, wo der Ausreißerabschnitt begonnen hat.
Was der Formatierer macht nicht Do ist, Ihr Dokument gegen ein Schema zu überprüfen Wohlgeformtheit fragt " ist dies strukturell gültiges XML? " Gültigkeit fragt " folgt dieses XML den Regeln von Mein besonderes Dokumenttyp - die richtigen Elemente, in der richtigen Reihenfolge, mit den richtigen Datentypen - wie durch eine DTD oder XSD definiert?" Das sind separate Ebenen Ein Dokument kann perfekt gut geformt sein und dennoch für seinen Verwendungszweck Unsinn sein Die Schemavalidierung benötigt das Schema, und das ist ein anderes Tool Der Formatierer garantiert die erste Ebene, die Ihren Parser zum Absturz bringt.
Wie formatiere ich XML in meinem Editor oder baue Pipeline?
Das Browser-Tool ist der schnellste Weg für ein einmaliges Dokument, aber es lohnt sich, die Alternativen zu kennen, damit Sie die richtige für den Job auswählen können.
Die meisten Editoren formatieren XML nativ Im VS Code verarbeitet der eingebaute & quot; Format Document" Befehl (Shift+Alt+F) XML, und Erweiterungen wie Red Hat' s XML-Sprachserver fügen oben schemabewusste Formatierung hinzuIntelliJ und seine Geschwister formatieren mit Strg+Alt+L neu. Diese sind ideal, wenn die Datei bereits vor Ihnen geöffnet ist.
Auf der Kommandozeile, die xmllint --format file.xml (Teil von libxml2, das auf den meisten Unix-Systemen ausgeliefert wird) verschönert, und xmllint --noblanks file.xml Bringt Sie in die Nähe der minifizierten Ausgabe In einem Node-Projekt können Bibliotheken wie xml-formatter oder prettier Mit dem XML-Plugin-Slot in einen Build-Schritt Python-Entwickler greifen nach xml.dom.minidom.parseString(s).toprettyxml()Allerdings sei gewarnt, dass es dafür berüchtigt ist, zusätzliche Leerzeilen um den vorhandenen Leerraum herum hinzuzufügen.
Warum also die XML-Formater Überhaupt? drei Gründe, auf die ich immer wieder zurückkomme Es braucht keine Installation, keine Konfiguration und kein Projekt - Sie fügen ein und gehen. Es behält die Daten auf Ihrer Maschine, was wichtig ist, wenn das XML eine echte Nutzlast und kein Spielzeugbeispiel ist. Und es passt sich auf natürliche Weise mit den benachbarten Tools an: Sobald Ihr XML sauber und gültig ist, konvertieren Sie es in JSON mit dem XML-zu-JSON-Konverter ist ein Klick, und die Rückwärtsfahrt durch JSON zu XML Verwendet die gleichen Konventionen Wenn Ihr Tag hauptsächlich JSON ist, wird die JSON-Formater ist das Äquivalent für dieses Format und die gesamte Familie wird im katalogisiert Webentwickler-Toolkitdrohen
Wann sollte ich mein XML formatieren versus konvertieren?
Eine Frage, die ich von Leuten bekomme, die neuer sind als diese: wenn JSON einfacher zu lesen ist, warum dann XML formatieren, anstatt es nur zu konvertieren? die Antwort ist, dass Formatierung und Konvertierung verschiedene Probleme lösen.
Formatieren Sie, wann Sie müssen Bleiben Das XML - weil ein SOAP-Endpunkt es erfordert, weil ein RSS- oder Atom-Feed per Definition XML ist, weil Ihre Konfigurationsdatei, Ihr Android-Layout oder Ihr Maven pom.xml Ist einfach XML und wird es immer sein Durch die Formatierung ist das XML lesbar oder kompakt, während es als XML belassen wird Nichts im Downstream muss sich ändern.
Konvertieren, wenn Sie möchten Arbeiten Sie mit den Daten in einem anderen Format - Werte in ein JavaScript-Frontend ziehen, einen Feed in ein System laden, das JSON spricht, oder mehrere Quellen in eine Form normalisieren Durch die Konvertierung ändert sich das Format und damit auch ein Teil der Wiedergabetreue: XML-Attribute, gemischte Inhalte und Elementreihenfolge haben keine sauberen JSON-Äquivalente, daher trifft ein Konverter bewusste Entscheidungen (Attribute werden zu präfixierten Schlüsseln, wiederholte Tags werden zu Arrays), die Sie verstehen sollten, bevor Sie sich auf sie verlassen.
Meine Faustregel: formatieren Sie immer zuerst Ein sauberes, validiertes Dokument lässt sich leichter darüber nachdenken, ob Ihr nächster Schritt darin besteht, es zu bearbeiten, zu diffundieren oder zu konvertieren. Formatieren ist der kostengünstige, sichere und verlustfreie Vorgang; Die Konvertierung ist die verlustbehaftete, die Sie durchführen, sobald Sie wissen, dass die Struktur solide ist. Sitemaps sind ein schönes Beispiel für XML, das Sie formatieren, anstatt es zu konvertieren - wenn Sie eines erstellen, das dedizierte Sitemap-generator Erzeugt direkt eine gültige, wohlgeformte Ausgabe.
Häufig gestellte Fragen
Wie formatiere ich XML online?
Fügen Sie Ihre XML-Datei in das Eingabefeld ein, wählen Sie Verschönern, wählen Sie eine Einzugsbreite aus und klicken Sie auf Format. Das Tool analysiert das Dokument, rückt es erneut ein und ermöglicht Ihnen das Kopieren oder Herunterladen des Ergebnisses. Alle Verarbeitungen erfolgen in Ihrem Browser - nichts wird hochgeladen.
Was ist der Unterschied zwischen Verschönerung und Minimierung von XML?
Verschönern fügt Zeilenumbrüche und Einrückungen hinzu, sodass die Elementhierarchie leicht zu lesen ist, was ideal zum Bearbeiten und Debuggen ist Minifizieren entfernt den gesamten Leerraum zwischen Tags, um eine möglichst kleine Datei zu erzeugen, die ideal zum Speichern oder Senden über das Netzwerk ist Beide bewahren die Bedeutung von document' s; nur der unbedeutende Leerraum ändert sich.
Ändert die Formatierung die Bedeutung meines XML?
kein drohen Nur der Leerraum zwischen den Tags wird geändert - die Elemente, Attribute, Textinhalte, Kommentare und CData bleiben unverändert. Da signifikante Leerzeichen in Textknoten und CD-Daten erhalten bleiben, verhält sich ein wohlgeformtes Dokument vor und nach der Formatierung identisch.
Werden Kommentare und CD-Daten-Abschnitte beibehalten?
Ja. Kommentare, CDATA-Abschnitte, die XML-Deklaration, und Verarbeitungsanweisungen werden alle gehalten Kommentare werden neben den Elementen eingerückt, mit denen sie sitzen, und CDATA-Inhalte werden wörtlich ausgegeben, ohne dass es zu einem Escape-Verfahren kommt Sie können auch wählen, ob Sie Kommentare streifen, wenn Sie eine schlankere Ausgabe wünschen.
Kann dieses Tool mein XML validieren?
Ja. Vor der Formatierung wird das Dokument vollständig analysiert und strukturelle Probleme - ein nicht geschlossenes Element, ein schließendes Tag, das nicht mit dem Eröffnungs-Tag übereinstimmt, oder ein nicht abgebrochener Kommentar oder ein nicht abgeschlossener Abschnitt mit CD-Daten - mit einer Zeilennummer gemeldet werden, damit Sie diese schnell beheben können. Es überprüft die Wohlgeformtheit, nicht die Gültigkeit gegen ein DTD- oder XSD-Schema.
Warum kann mein XML nicht formatiert werden?
Fast alle Ausfälle sind Wohlgeformtheitsfehler Am häufigsten sind ein blanker Ampere und im Text (es muss als Entität geschrieben werden, oder der Parser liest es als Start einer Entität), ein schließendes Tag, das nicht mit dem Element übereinstimmt, das es schließt, und ein Element, das geöffnet, aber nie geschlossen wird Die Fehlermeldung zeigt auf die Linie, sodass Sie direkt darauf springen können.
Ist es sicher, XML zu formatieren, das sensible Daten enthält?
Ja. Der Parser läuft in Ihrem Browser komplett in JavaScript - keine Netzwerkanforderung trägt Ihre Daten, nichts wird protokolliert oder gespeichert, und das Tool arbeitet nach dem Laden offline. XML-Dateien mit API-Schlüssel, Verbindungszeichenfolgen oder Kundendatensätzen verlassen niemals Ihre Maschine.
Kann ich das formatierte XML anschließend in JSON konvertieren?
Ja. Sobald das XML sauber und gültig ist, verwandelt der XML-zu-JSON-Konverter es in äquivalente JSON-Werte, die Attribute zu vorangestellten Schlüsseln und wiederholten Tags zu Arrays zuordnen. Das Formatieren macht zuerst die Struktur offensichtlich, was Ihnen hilft zu verstehen, wie sie vor der Konvertierung zuordnen wird.
Geschrieben von Liton - Builder von Toolz.dev, WP Adminify, und einer langen Liste von Laravel und React Projekten Jedes hier genannte Tool läuft kostenlos und vollständig in Ihrem Browser unter [Toolz.dev] (/.
