JSON formatieren

Der billige Weg zu einem Formatierer ist, die Zeichen durchzugehen und nach jeder Klammer und jedem Komma einen Zeilenumbruch zu setzen. Das sind fünfzig Zeilen, es funktioniert bei den meisten Eingaben, und es scheitert an genau dem Fall, auf den es ankommt: einer Klammer, einer eckigen Klammer oder einem Komma innerhalb eines String-Werts. Eine URL mit Query, ein als Einstellung gespeicherter regulärer Ausdruck, eine Nachricht mit einem Komma darin — und schon ist die Ausgabe kein gültiges JSON mehr.

Diese Seite schickt das Dokument durch einen echten Parser und gibt das Ergebnis aus. Daraus folgt: Was sie zurückgibt, lässt sich garantiert parsen, und was sie ablehnt, lässt sich tatsächlich nicht parsen. Einen dritten Zustand, in dem ein Werkzeug die Eingabe halb verstanden und etwas Plausibles produziert hat, gibt es nicht.

Parsen und neu ausgeben ist nicht folgenlos, und ein Werkzeug, das das verschweigt, verbirgt etwas. Zahlen werden in ihrer kürzesten exakten Form neu geschrieben, aus `1.0` wird also `1` und aus `1e3` wird `1000`. Doppelte Schlüssel fallen auf den letzten zusammen, weil jeder JSON-Parser das so macht. Unnötige Maskierungen verlieren ihren Backslash.

Nichts davon ändert, was das Dokument für einen Parser bedeutet, und deshalb ist es vertretbar. Wenn du die Bytes exakt brauchst — weil du das Dokument signierst oder eine Prüfsumme vergleichst —, formatiere es gar nicht: Jeder Formatierer, der neu einrückt, hat die Bytes bereits verändert.

Zwei Systeme, die dasselbe Objekt serialisieren, geben seine Schlüssel oft in unterschiedlicher Reihenfolge aus — und der resultierende Vergleich ist so groß wie die Datei, was das Prüfen einer echten Ein-Feld-Änderung unmöglich macht. Sortiert man beide Seiten vorher, schrumpft er auf die Änderung selbst.

Arrays bleiben bewusst unangetastet. Ein Objekt ist per Definition ungeordnet, seine Schlüssel umzustellen ändert nichts; ein Array ist eine Folge, und es zu sortieren ändert die Daten. Werkzeuge, die beides sortieren, gibt es, und sie stellen klaglos eine Liste von Arbeitsschritten, Koordinaten oder Datenbankmigrationen um.

Zwei Leerzeichen sind bei JSON in den meisten Ökosystemen die Konvention und das, was `npm`, `composer` und die meisten Linter erzeugen. Vier begegnen einem in Python-nahen Projekten, weil es zur Sprache passt. Ein Tabulator ist richtig, wo eine Datei in Editoren mit unterschiedlichen Vorlieben gelesen wird, denn dort entscheidet der Lesende über die Breite.

Nicht mehr Geschmackssache ist es in einem Repository, in dem bereits ein Formatierer konfiguriert ist. Nimm dessen Einstellung — eine mit anderer Einrückung neu formatierte Datei erzeugt einen Vergleich, der jede Zeile berührt, und das kostet die prüfende Person weit mehr, als die Einrückung je wert war.

Eine Datei mit `//` darin ist kein JSON, und eine mit einem Komma vor der schließenden Klammer auch nicht. Beides ist JSON5 oder JSONC — andere Sprachen, die zufällig ähnlich aussehen —, und beides ist in Konfigurationsdateien weit verbreitet: `tsconfig.json` ist JSONC, was regelmäßig überrascht, wenn jemand es mit einem strengen Parser einliest.

Diese Seite lehnt das ab, statt es stillschweigend wegzuräumen, und das ist das nützlichere Verhalten: Sie sagt dir, dass die Datei dort, wohin du sie gleich schickst, nicht durchgehen wird. Ein Formatierer, der Kommentare kommentarlos entfernt, gäbe dir eine funktionierende Datei und ein falsches Bild davon, womit du es zu tun hast.

JSON-Zahlen werden zu Gleitkommazahlen doppelter Genauigkeit, und die halten Ganzzahlen nur bis etwa neun Billiarden exakt. Darüber wird eine Kennung gerundet: eine Snowflake-ID, eine alte Twitter-Status-ID, manche Primärschlüssel. Aus `12345678901234567890` wird `12345678901234567000`, und nichts in der Ausgabe sagt es.

Diese Seite bemerkt es und weist darauf hin, mehr kann sie nicht tun. Die Lösung liegt weiter oben: Systeme, die solche Kennungen ausgeben, verschicken sie aus genau diesem Grund als Zeichenketten — und wenn deines das nicht tut, ist das Formatieren nicht der Schritt, an dem sich das reparieren lässt.

Beide Begriffe werden gesucht, und beide meinen dieses Werkzeug. Eine zweite Seite mit demselben Feld und umformulierter Erklärung wäre eine Doorway-Page — genau das Muster, das der Rest dieser Website vermeidet, und dieselbe Entscheidung, die dort schon für „Zeichenzähler“ getroffen wurde.

Beide Fragen werden also hier beantwortet. Wer JSON „verschönern“ oder „anzeigen“ wollte, ist hier richtig, und eine gute Seite hat gegen eingesessene Konkurrenz bessere Aussichten als zwei dünne.

Was in einen JSON-Formatierer eingefügt wird, ist fast immer eine Antwort aus einem System, an dem jemand arbeitet — samt allem, was sie enthält: Kundendaten, interne Kennungen, gelegentlich ein Token in einem Feld, in dem es nicht sein sollte.

Das an einen fremden Server zu schicken, damit er Zeilenumbrüche einfügt, ist ein sehr schlechtes Tauschgeschäft. Die Arbeit erledigt der eingebaute Parser deines Browsers in Millisekunden, und das Netzwerk-Panel zeigt dabei nichts.

JSON verbietet nicht, denselben Schlüssel zweimal in ein Objekt zu schreiben — die Spezifikation nennt das Verhalten schlicht undefiniert. In der Praxis behalten fast alle Parser den letzten, auch der im Browser, und das heißt: Ein Dokument mit doppeltem Schlüssel geht hier durch und kommt einfach kürzer wieder heraus.

Das ist eine der wenigen Stellen, an denen Formatieren tatsächlich Daten verliert, und deshalb steht es hier. Wenn eine formatierte Datei kleiner ist, als sie sein sollte, ist ein doppelter Schlüssel die erste Vermutung — und die Ursache liegt fast immer bei einem Generator, der zwei Quellen zusammenschreibt, ohne zu prüfen.

Formatiertes JSON besteht typischerweise zu zwanzig bis vierzig Prozent aus Leerraum. Das klingt nach viel und ist über das Netz meist bedeutungslos, weil Antworten komprimiert übertragen werden und gzip mit Folgen von Leerzeichen ausgezeichnet umgeht — komprimiert liegt der Unterschied oft unter fünf Prozent.

Ins Gewicht fällt es dort, wo nicht komprimiert wird: in einer Umgebungsvariablen, einer Datenbankspalte, einer einzelnen Logzeile, einem Feld mit harter Längenbegrenzung. Wer eine dieser Grenzen vor sich hat, will die Seite zum Minifizieren; wer eine Datei lesen will, ist hier richtig.