JSON und YAML im Vergleich: Einrückung und typische Fehler

Inhalt
- JSON markiert Grenzen mit Klammern, YAML mit Zeilenumbrüchen
- Warum YAML für Konfigurationsdateien häufiger gewählt wird
- Warum gerade dieser Komfort zur Fehlerquelle wird
- Wie das Tool die Regeln für Grenzmarkierungen übernimmt
- In umgekehrter Richtung (YAML → JSON) gelten dieselben Grenzen
- Zusammenfassung
- Häufig gestellte Fragen
Beim Öffnen von Konfigurationsdateien fällt auf: Manche sind dicht mit geschweiften Klammern, doppelten Anführungszeichen und Kommas gespickt, andere zeigen ihre Struktur allein durch Zeilenumbrüche und Einrückung, ganz ohne Satzzeichen. Die ersten sind JSON, die zweiten YAML. Beide können dieselben Daten darstellen – dass die Menge an Interpunktion so stark abweicht, hat einen Grund.
Es geht dabei nicht um Geschmack. Die beiden Formate markieren die „Grenzen“ der Daten (also wo ein Wert endet und der nächste beginnt) auf grundverschiedene Weise. Dieser Unterschied im Entwurf ist zugleich der Grund, warum YAML in Konfigurationsdateien bevorzugt wird, und der Grund, warum YAML-Dateien so auffallend oft kaputtgehen.
Zusammenfassung ① JSON markiert die Grenzen der Daten mit geschweiften und eckigen Klammern, Kommas und Anführungszeichen. YAML markiert sie mit Zeilenumbrüchen und der Anzahl der Einrückungsleerzeichen. ② Weil YAML mit minimaler Interpunktion auskommt, lässt es sich für Menschen gut lesen und schreiben und wird deshalb häufig für Konfigurationsdateien (Config) verwendet. ③ Aus demselben Grund zerstört schon ein einziges falsches Leerzeichen in der Einrückung oder ein eingemischtes Tabulatorzeichen die Struktur der gesamten YAML-Datei.
JSON markiert Grenzen mit Klammern, YAML mit Zeilenumbrüchen
In JSON beginnt und endet ein Objekt mit geschweiften Klammern, die einzelnen Einträge darin werden durch Kommas getrennt. Zeichenketten müssen zwingend in doppelten Anführungszeichen stehen, ebenso die Schlüssel. Nur durch diese Satzzeichen weiß der Parser genau, wo ein Wert aufhört.
YAML ersetzt diese Satzzeichen durch Zeilenumbrüche und Einrückung. Zeilen mit gleicher Einrückungstiefe gehören zur selben Ebene, eine tiefer eingerückte Zeile ist ein Unterelement der Zeile direkt darüber. Ganz ohne geschweifte Klammern und Kommas wird die Hierarchie allein über die Anzahl der Leerzeichen ausgedrückt.
Warum YAML für Konfigurationsdateien häufiger gewählt wird
Konfigurationsdateien öffnet man oft von Hand, um einen einzelnen Wert zu ändern. Dafür ist YAML mit seiner Struktur, die sich allein durch Einrückung auf einen Blick erschließt, deutlich angenehmer zu überfliegen als JSON, wo in jeder Zeile geschweifte Klammern und Kommas wiederkehren.
Je mehr Werte vorhanden sind und je tiefer die Hierarchie wird, desto größer wird dieser Unterschied. Bei JSON muss man auch darauf achten, wo Klammern geschlossen werden. Bei YAML genügt die korrekte Einrückungstiefe, und Einträge lassen sich vergleichsweise leicht hinzufügen oder umsortieren. Deshalb wird YAML tendenziell bei Konfigurationsdateien bevorzugt, die Menschen häufig von Hand bearbeiten.
Warum gerade dieser Komfort zur Fehlerquelle wird
Genau der Punkt, der den Komfort ausmacht – nämlich dass die Struktur über die Anzahl der Leerzeichen ausgedrückt wird –, ist zugleich die Ursache der häufigsten Fehler in YAML. Bei JSON sind Klammern und Kommas explizit, daher lässt sich die Datei auch mit falscher Einrückung parsen. In YAML ist die Einrückung selbst Teil der Syntax: Weicht die Zahl der Leerzeichen nur um eins ab, wird der Eintrag einer anderen Ebene zugeordnet oder es kommt gleich zu einem Fehler.
Dasselbe gilt für Tabulatorzeichen. Die YAML-Spezifikation erlaubt Tabulatoren in der Einrückung nicht. Jeder Editor stellt einen Tabulator mit einer anderen Anzahl von Spalten dar, deshalb kann der Parser nicht festlegen, wie vielen Leerzeichen ein Tabulator entspricht. Auch wenn eine Zeile nur mit Leerzeichen und eine Zeile mit Tabulator auf dem Bildschirm gleich ausgerichtet aussehen, behandelt der Parser sie als unterschiedliche Einrückungen.
JSON und YAML in beide Richtungen sofort umwandeln, mit automatisch passender Einrückung und passenden Anführungszeichen: der JSON ↔ YAML Konverter

Wie das Tool die Regeln für Grenzmarkierungen übernimmt
Wenn Sie im JSON ↔ YAML Konverter im Tab „JSON → YAML“ JSON in das Eingabefeld einfügen, wendet das Tool die eben beschriebenen Regeln für Grenzmarkierungen automatisch an und gibt Ihnen YAML mit Einrückung aus. Sie müssen die Einrückungstiefe nicht von Hand anpassen und auch nicht zwischen Tabulatoren und Leerzeichen unterscheiden.
Interessant ist bei dieser Umwandlung, welche Zeichenketten ihre Anführungszeichen behalten und bei welchen sie entfallen. Wenn ein Zeichenkettenwert wie true, false, null, yes oder no nach einem reservierten Wort aussieht oder wie eine Zahl wirkt, kann ein YAML-Parser ihn ohne Anführungszeichen fälschlich als Boolean oder Zahl deuten. Das Tool belässt in diesen Fällen sowie bei Sonderzeichen wie Doppelpunkt oder eckigen Klammern die doppelten Anführungszeichen. Alle übrigen gewöhnlichen Zeichenketten gibt es ohne Anführungszeichen aus, sodass die für YAML typische Kompaktheit erhalten bleibt.
In umgekehrter Richtung (YAML → JSON) gelten dieselben Grenzen
Wechseln Sie zum Tab „YAML → JSON“, können Sie auch die Gegenrichtung ausprobieren. Geben Sie YAML mit Einrückung in das Eingabefeld ein, liest das Tool die Einrückungstiefe jeder Zeile und stellt die Hierarchie wieder mit geschweiften und eckigen Klammern sowie Kommas dar.
Hilfreich ist in dieser Richtung vor allem, dass Sie nicht mehr mit den Augen abzählen müssen, um wie viele Leerzeichen eine Zeile tatsächlich verschoben ist. Auch wenn die Einrückung für Sie ähnlich aussieht, aber das Tool die Hierarchie anders gelesen hat, erkennen Sie an der resultierenden JSON-Struktur sofort, welche Zeile anders als beabsichtigt verarbeitet wurde.
Zusammenfassung
- JSON markiert die Grenzen der Daten mit geschweiften und eckigen Klammern, Kommas und Anführungszeichen, YAML mit Zeilenumbrüchen und der Anzahl der Einrückungsleerzeichen.
- Die Syntax auf Basis von Einrückung ist für Menschen angenehm zu lesen und zu schreiben, hat aber aus demselben Grund die Schwäche, dass schon ein einziges falsches Leerzeichen die Struktur zerstört.
- Laut Spezifikation erlaubt YAML in der Einrückung keine Tabulatorzeichen; werden Tabulatoren und Leerzeichen gemischt, deutet der Parser die Hierarchie anders.
- Anführungszeichen sind nur nötig, wenn ein Zeichenkettenwert wie ein reserviertes Wort oder eine Zahl aussieht; alles andere wird in YAML ohne Anführungszeichen geschrieben.
- Wenn Sie zwischen den beiden Formaten wechseln und prüfen möchten, ob die Struktur korrekt umgewandelt wurde, ist es genauer, die Daten selbst in den Konverter einzugeben, als Leerzeichen mit dem Auge abzuzählen.
JSON und YAML in beide Richtungen sofort umwandeln, mit automatisch passender Einrückung und passenden Anführungszeichen: der JSON ↔ YAML Konverter
Häufig gestellte Fragen
Warum führen Tabulatoren in YAML zu einem Fehler?
Die YAML-Spezifikation erlaubt in der Einrückung nur Leerzeichen, keine Tabulatoren. Da jeder Editor einen Tabulator mit einer anderen Anzahl von Spalten darstellt, kann der Parser nicht einheitlich festlegen, wie vielen Leerzeichen ein Tabulator entspricht. Auch wenn die Ausrichtung auf dem Bildschirm stimmt, kann ein Tabulator in der Datei beim Parsen zu einem Fehler führen.
Warum müssen in JSON immer Anführungszeichen gesetzt werden?
JSON markiert die Grenzen von Werten nicht durch Einrückung, sondern durch Satzzeichen wie geschweifte und eckige Klammern sowie Kommas. Fehlen die Anführungszeichen um eine Zeichenkette, kann der Parser nicht erkennen, wo der Wert endet und ob ein folgendes Komma oder ein Doppelpunkt Teil der Zeichenkette oder ein Syntaxzeichen ist. Deshalb müssen Zeichenketten und Schlüssel ausnahmslos in doppelten Anführungszeichen stehen.
Muss die Einrückungstiefe in YAML einheitlich sein?
Ja, Einträge derselben Ebene müssen unbedingt dieselbe Einrückungstiefe haben. Weicht nur bei einem Eintrag die Zahl der Leerzeichen ab, wird er unter Umständen so gedeutet, als wäre er auf eine andere Ebene verschoben worden, oder der Parser kann die Struktur gar nicht lesen und meldet einen Fehler. Auch eine Ausrichtung, die auf den ersten Blick ähnlich aussieht, führt zu einem anderen Ergebnis, wenn die tatsächliche Anzahl der Leerzeichen abweicht.
Wird JSON beim Umwandeln in YAML immer kürzer?
Nicht immer. Bei einfachen Strukturen mit nur wenigen Werten fällt der Unterschied in der Zeilenzahl zwischen beiden Formaten möglicherweise gering aus. Bei Konfigurationsdaten mit tiefer Hierarchie und vielen Einträgen ist YAML, das die Struktur allein durch Einrückung ausdrückt, jedoch meist kürzer und besser lesbar als JSON, in dem geschweifte Klammern, Kommas und Anführungszeichen ständig wiederholt werden müssen.
Dieser Artikel basiert auf unserem koreanischen Original. Koreanisches Original lesen