Die Pull-Anfrage hatte 240 geänderte Zeilen und ich hatte genau zwei Werte berührt Das war der Moment, in dem ich es ernst meinte mit dem Sortieren von JSON-Schlüsseln Ein Teamkollege hatte eine Config-Datei durch einen Formatierer laufen lassen, der seine Schlüssel neu ordnete, ich hatte zwei dieser Werte von Hand bearbeitet, und das resultierende Diff war eine unlesbare Wand aus Rot und Grün, wo 238 der Zeilen einfach verschobene Schlüssel warenMein Rezensent bat mich verständlicherweise, es neu zu machen Die wirklichen Änderungen waren im Inneren des Geräusches unsichtbar.
Ich betreibe [Toolz.dev] (/ und baue auch Laravel und WordPress Projekte, das heißt ich wohne drinnen package.json, composer.json, tsconfig.json(Übersetzungskataloge, und hundert andere JSON-Dateien, die sich der Versionskontrolle verpflichten Eine JSON-Datei mit unvorhersehbarer Schlüsselreihenfolge ist eine kleine, wiederkehrende Steuer auf jede dieser. Das Sortieren von Schlüsseln in eine stabile alphabetische Reihenfolge ist der Fix, und es ist eine dieser Änderungen, die kosmetisch aussieht, bis zum ersten Mal, wenn es Ihnen eine verschwendete Codeüberprüfung erspart. Diese Anleitung behandelt, wann Sie JSON-Schlüssel sortieren müssen, wann nicht, und wie Sie es tun, ohne etwas zu brechen.
tl; dr: Ein JSON-Sortierer ordnet ein Objekt neu' s-Schlüssel in alphabetischer Reihenfolge und serialisiert das Ergebnis neu Schlüsselreihenfolge ändert nichts an dem, was JSON bedeutet, denn Objekte sind vom JSON-Standard ungeordnet, aber eine konsistente Reihenfolge macht Dateien lesbar und erzeugt saubere Version-Steuerdiffs, die nur geänderte Werte anzeigen Sortieren Sie rekursiv, um verschachtelte Objekte zu erreichen, halten Sie Array-Reihenfolge standardmäßig, da Arrays geordnet sind, und wählen Sie aufsteigende oder absteigende, hübsche oder minifizierte Ausgabe Die JSON-Sortierer Läuft vollständig in Ihrem Browser.
Was ist ein JSON-Sortierer?
Ein JSON-Sortierer nimmt ein JSON-Objekt und ordnet seine Tasten in alphabetischer Reihenfolge neu an, schreibt das Objekt dann wieder herausDie Werte sind unberührt, es ändert sich nur die Reihenfolge, in der die Tasten erscheinen, und das ist sicher, weil RFC 8259 Definiert ein Objekt als ungeordnete Sammlung: Das Neuordnen von Schlüsseln kann nicht ändern, was das Dokument bedeutet Also {"name":"toolz","author":"Liton"} wird {"author":"Liton","name":"toolz"}. Standardmäßig ist die Sortierung rekursiv, was bedeutet, dass die Schlüssel in jedem verschachtelten Objekt ebenfalls sortiert sind, bis hin zur tiefsten Ebene.
Das ist die ganze Operation, und ihre Einfachheit ist der Punkt Du transformierst keine Daten, validierst kein Schema oder konvertierst ein Format Du erzwingst eine vorhersehbare Reihenfolge für etwas, das eine willkürliche hatte Jeder andere Vorteil, Lesbarkeit, Vergleichbarkeit, saubere Diffs, fließt aus dieser einzigen vorhersehbaren Reihenfolge.
Ändert das Sortieren von Tasten, was mein JSON bedeutet?
Nein, und das ist die Tatsache, die das Sortieren sicher macht Im JSON-Standard ECMA-404 wird ein Objekt als eine ungeordnete Sammlung von Namen - und Wertpaaren definiert Die Spezifikation ist explizit, dass die Reihenfolge dieser Paare nicht signifikant ist Jeder konforme Parser liest {"a":1,"b":2} und {"b":2,"a":1} Als genau die gleichen Daten Wenn Ihr Programm config.timeout oder data["name"]„Es sucht die Taste namentlich nach oben; Es kümmert sich nie darum, wo im Objekt diese Taste geschrieben wurde.
Es gibt eine Einschränkung, die es wert ist, klar angegeben zu werden, denn jemand fragt immer Eine winzige Anzahl von Systemen missbraucht JSON-Objekte, als ob sie bestellt worden wären, und verlässt sich dabei auf die Einfügungsreihenfolge für die Anzeige oder Verarbeitung. Das ist eher ein Missbrauch des Formats als eine Eigenschaft davon, aber wenn Sie ein System, das Sie nicht kontrollieren, einspeisen, testen Sie, bevor Sie eine sortierte Datei in eine Pipeline einbinden, die Sie nicht überprüfen können. Für die überwiegende Mehrheit der realen JSON, Konfigurationsdateien, API-Nutzlasten, Sperrdateien, Übersetzungskataloge und Sortierschlüssel ist eine rein präsentierende Änderung mit null Auswirkungen auf die Bedeutung.
Arrays sind der umgekehrte Fall, und die Unterscheidung ist wichtig Ein JSON-Array ist per Definition geordnet, und seine Reihenfolge trägt häufig Bedeutung: eine Folge von Schritten, eine Rangliste, eine Menge von Koordinaten, bei denen Position eins Längengrad und Position zwei Breitengrad ist Das Neuordnen eines Arrays kann stillschweigend ändern, was die Daten sagen Deshalb behält dieses Tool standardmäßig die Array-Reihenfolge bei und sortiert Arrays nur, wenn man es explizit darum bittet, und selbst dann nur für Arrays, deren Elemente alle Zeichenfolgen oder alle Zahlen sind.
Warum sollte ich JSON-Schlüssel sortieren?
Der Grund für die Überschrift ist Clean Diffs, und es ist derjenige, der meine Arbeitsweise geändert hat Versionskontrollwerkzeuge vergleichen Dateien Zeile für Zeile Wenn zwei Dateien, die dieselben Daten darstellen, ihre Schlüssel in unterschiedlicher Reihenfolge schreiben, ist das Diff voll von Schlüsseln, die sich verschoben haben, anstatt von Werten, die sich geändert haben Nehmen Sie eine Regel an, dass jede JSON-Datei mit sortierten Schlüsseln geschrieben wird, und das Problem verschwindet: Zwei Versionen der Datei unterscheiden sich nur dort, wo ein Wert tatsächlich abweicht, sodass ein Rezensent die tatsächliche Änderung sofort sieht Genau aus diesem Grund bieten viele Linter und Formatierer eine Option für Sortierschlüssel an, und warum Tools wie jq Versenden Sie eine Sort-Keys-Flagge.
Der zweite Grund ist die menschliche Lesbarkeit Wenn Sie eine große Konfigurationsdatei scannen, um nach einer bestimmten Einstellung zu suchen, sagt Ihnen die alphabetische Reihenfolge, wo Sie suchen sollen Sie lesen nicht die ganze Datei; Sie springen ungefähr dorthin, wo der Schlüssel sein soll, so wie Sie es in einem Wörterbuch tun würden Bei einer Datei mit achtzig Schlüsseln ist das der Unterschied zwischen einer Zwei-Sekunden-Nachschau und einem vollständigen Scan.
Der dritte Grund ist die Vergleichbarkeit über Dateien hinweg, wenn Ihr Projekt zehn JSON-Dateien hat, die alle eine gemeinsame Struktur haben sollten, macht es für den Blickwinkel trivial, ob einem ein Schlüssel fehlt oder eine zusätzliche Divergenzen nebeneinander aufstellen, anstatt sich in verschiedenen Positionen zu verstecken.
Der vierte Grund ist die Kanonisierung Einige Workflows benötigen eine stabile, deterministische Darstellung eines JSON-Wertes, um ihn beispielsweise zu hashen, zwischenzuspeichern oder zwei Nutzlasten auf Gleichheit zu vergleichen, unabhängig davon, wie sie serialisiert wurden Das Sortieren von Schlüsseln ist ein Schritt in Richtung einer kanonischen Form, obwohl ein vollkanonisches JSON auch die Leerzeichen- und Zahlenformatierung normalisiert.
Wie verwende ich den JSON Sorter?
Fügen Sie Ihren JSON in das Eingabefeld auf der ein JSON-Sortierer‘oder laden Sie die Probe, um die Form der Ausgabe zu sehen Die Eingabe muss gültiges JSON sein Ist dies nicht der Fall, meldet das Tool den Analysefehler mit seiner Position, damit Sie vor dem Sortieren ein Streuspeicherkomma oder eine nicht geschlossene Klammer reparieren können.
Wählen Sie dann aus, wie die Sortierung ausgeführt wird Wählen Sie aufsteigend, was A bis Z ist, oder absteigend für Z bis A. Entscheiden Sie, ob Fall gefaltet werden soll, der standardmäßig eingeschaltet ist, damit Name, name, und NAME Zusammensitzen statt getrennt zu werden, weil Großbuchstaben in roher Zeichenreihenfolge vor Kleinbuchstaben sortieren Wählen Sie, ob Sie in verschachtelte Objekte absteigen, was Sie fast immer wollen, oder nur die oberste Ebene sortieren, Wenn Sie Arrays von Zeichenfolgen oder Zahlen ebenfalls bestellt haben möchten, schalten Sie die Array-Sortierung ein; gemischte Arrays und Arrays von Objekten bleiben immer so, wie sie sind.
Wählen Sie abschließend Ihren Ausgabestil aus. Drucken Sie mit Zwei-Leerzeichen-, Vier-Leerzeichen- oder Tabulatoreinrückung für eine lesbare Datei, die Sie festlegen möchten, oder minifizieren Sie sie für die kleinste Nutzlast zur Speicherung oder zum Transport in eine einzelne Zeile. Führen Sie die Sortierung aus, kopieren Sie dann das Ergebnis oder laden Sie es herunter. Der Schlüsselzähler gibt Ihnen an, wie viele Schlüssel neu geordnet wurden. Dies ist eine schnelle Überprüfung der geistigen Gesundheit, ob das Tool die von Ihnen erwartete Struktur gesehen hat.
Aufsteigend, absteigend, rekursiv: welche Einstellungen möchte ich?
Meistens sind die Defaults das, was man will: aufsteigend, rekursiv, fallunsensibel, hübsch gedruckt mit zwei Leerzeichen Das erzeugt die lesbare, diff-freundliche Datei, die das Sortieren überhaupt motiviert Die anderen Einstellungen gibt es für bestimmte Situationen, und die Tabelle unten ist, wie ich entscheide.
| Einstellung | Standard | Wann man es ändern sollte |
|---|---|---|
| Orden | Aufsteigend (A bis Z) | Abstieg ist selten; nützlich, wenn Sie oben die aktuellsten oder prioritärsten Schlüssel mit dem Namen zuletzt sortieren möchten |
| Rekursiv | Auf | Schalten Sie nur aus, wenn Sie Abschnitte der obersten Ebene neu bestellen möchten, aber bewahren Sie die handgestimmte Reihenfolge in jedem Abschnitt auf |
| Fall ignorieren | Auf | Schalten Sie aus, wenn Sie eine strenge Codepunktreihenfolge benötigen, um beispielsweise ein anderes Tool zu finden, das fallsensibel sortiert |
| Arrays sortieren | Aus | Schalten Sie Arrays ein, bei denen es sich um wirklich ungeordnete Mengen handelt, z. B. eine Liste von Tags oder zulässigen Werten |
| Hübscher Druck | Auf | Abschalten, um den Transport oder die Lagerung zu minifizieren |
Die eine Einstellung, die Personen missbrauchen, ist Array-Sortierung Schalten Sie es nur ein, wenn Sie sicher sind, dass ein Array eine ungeordnete Menge darstellt Eine Liste von Tags, eine Reihe von erlaubten Dateierweiterungen oder eine Tasche mit Feature-Flags ist sicher zu sortieren Eine Liste von Pipeline-Schritten, eine Routentabelle oder alles, wo Position impliziert Sequenz ist nicht Im Zweifelsfall lassen Sie Arrays in Ruhe, denn die Standardeinstellung von tool' die Aufrechterhaltung der Reihenfolge kann Ihre Daten niemals beschädigen, während das falsche Array stillschweigend sortiert werden kann.
Wie passt das zu anderen JSON-Tools?
Sortieren ist in einer kleinen Kette meist ein Schritt, wenn JSON minifiziert und unlesbar von einer API kommt, führe ich es durch die JSON-Formater Zuerst einrücken und validieren, dann die Schlüssel sortieren, um es scannbar zu machen Wenn ich eine Nutzlast für den Transport nach dem Sortieren vorbereite, wird die JSON-Minifier Lindert es wieder auf eine einzige Zeile, und da die Schlüssel bereits sortiert sind, werden zwei minifizierte Nutzlasten, die dieselben Daten darstellen, Byte für Byte identisch herausgebracht, was zum Zwischenspeichern und Vergleichen praktisch ist.
Für strukturelle Arbeiten statt für Präsentationen ist die JSON-Flattener Versteckte Objekte in gepunktete Schlüssel und zurück verwandelt, die auf natürliche Weise mit der Sortierung gekoppelt werden, wenn Sie die Konfiguration in Umgebungsvariablen umwandeln. Und wenn Sie die Daten vollständig in einem anderen Format benötigen, ist die JSON-zu-YAML-Konverter Ist der nächste Stopp; das Sortieren von Schlüsseln vor der Konvertierung gibt Ihnen eine YAML-Datei mit einer vorhersehbaren, lesbaren Feldreihenfolge zu Wenn Sie das Gesamtbild davon wollen, wie diese zusammenpassen, habe ich mein vollständiges Setup in der Leitfaden für Webentwickler-Toolkitund die tieferen Mechanismen der Formatierung live in der JSON-Formater-Anleitungdrohen
Ein echtes Beispiel: ein Paket bändigen.json diff
Lassen Sie mich durch die genaue Situation gehen, die diesen Artikel ins Leben gerufen hat, denn er zeigt, warum die Einstellungsentscheidungen wichtig sind Ich hatte eine package.json Wo die dependencies Block in Installationsreihenfolge geschrieben worden war, ungefähr in der Reihenfolge, in der Pakete über zwei Jahre hinzugefügt worden waren Ein neues Teammitglied ließ seinen Editor' s format-on-save laufen, der die Abhängigkeitsschlüssel sortierte, und verpflichtete ihn zusammen mit einer echten Änderung: ein Paket von Version 4 auf Version 5 zu stoßen.
Das Diff war eine Katastrophe Jede Abhängigkeit unterhalb der gestoßenen schien sich verschoben zu haben, denn das Sortieren hatte ihre Positionen verschoben, so sah der Rezensent dreißig geänderte Zeilen für das, was ein einzeiliges Upgrade warDie Korrektur bestand nicht darin, darüber zu streiten, wessen Editor Recht hatte Die Korrektur bestand darin, die Datei einmal zu sortieren, diese Art als eigene separate Änderung mit einer Nachricht wie & quot;sort package.json keys, " zu begehen und dann die Version auf der jetzt stabilen Reihenfolge zum Bump zu bringen Danach erzeugte jede zukünftige Abhängigkeitsänderung ein sauberes einzeiliges oder zweizeiliges Diff, da die Datei bereits in der Reihenfolge war, in der alle & #39; s-Tools sie einfügen wollten.
Das ist das Muster, dem ich jetzt für jeden JSON folge, der in der Versionskontrolle lebt Sortieren Sie ihn einmal in einem dedizierten Commit, dann halten Sie ihn sortiert Die JSON-Sortierer Mit seinen Voreinstellungen, aufsteigend und rekursiv, ergibt sich genau die Reihenfolge, in der Prettier's Option sortieren und jq --sort-keys Produzieren, so bleibt die Datei stabil, egal welches Tool ein Teamkollege zufällig ausführt Das Einzige, was ich zuerst überprüfe, sind Arrays: package.json Es gibt keine sinnvollen Arrays, um die man sich Sorgen machen muss, aber eine Datei mit einem geordneten Array wie einer Liste von Build-Schritten muss die Array-Sortierung deaktiviert haben, was die Standardeinstellung ist, sodass die Sequenz überlebt.
Welche Tools und Formate sortieren JSON-Schlüssel?
Das Sortieren von JSON-Schlüsseln ist ein so häufiges Bedürfnis, dass es im gesamten Ökosystem auftaucht. Dies ist ein gutes Zeichen dafür, dass die Praxis sinnvoll und keine persönliche Eigenart ist. Der Befehlszeilenprozessor jq hat ein --sort-keys Flagge, oft geschrieben -SDas sortiert die Tasten jedes Objekts in seiner Ausgabe Der Prettier Code Formatier kann Schlüssel in JSON durch seine Konfiguration sortieren Viele Linter bieten eine Sortierschlüsselregel an, die unsortierte Objekte im Quellcode markiert Sprachstandardbibliotheken legen die gleiche Fähigkeit offen, zum Beispiel Python' s json.dumps Akzeptiert a sort_keys=True Argument, das eine kanonische, sortierte Ausgabe erzeugt.
Was ein Browser-basierter Sortierer hinzufügt, ist der schnelle Fall ohne Einrichtung Wenn Sie einen JSON-Blob aus einer API-Antwort, einer Protokollzeile oder einer Slack-Nachricht haben und ihn gerade in vernünftiger Reihenfolge lesen möchten, ist das Öffnen einer Seite und das Einfügen schneller als das Verkabeln eines Formatierers oder das Herunterfallen in eine Shell. Aus dem gleichen Grund existiert neben Editor-Plugins auch ein Paste-and-Go-Formatierer: Das Tool erfüllt den Ad-hoc-Bedarf, den die konfigurierte Pipeline nicht abdeckt.
Ist mein JSON privat?
Ja. Das JSON wird komplett in Ihrem Browser mit JavaScript geparst, sortiert und neu serialisiert, nichts wird auf einen Server hochgeladen, protokolliert oder irgendwo gespeichert Das ist kein kleines Detail speziell für JSON, denn bei JSON leben Geheimnisse: API-Antworten mit Token, Konfigurationsdateien mit Verbindungszeichenfolgen, Nutzlasten mit Kundendatensätzen Das Einfügen all dessen in ein Tool, das es an einen Server liefert, ist ein echtes Risiko, und genau das Risiko ist es, das dieses Tool vermeiden soll.
Sie können die Behauptung genauso überprüfen wie ich Öffnen Sie die Netzwerk-Registerkarte in Ihrem Browser' s Entwicklertools und schauen Sie sie sich an, während Sie sortieren; keine Anfrage verlässt die Seite Oder trennen Sie sich vom Internet und sortieren Sie weiter, denn sobald die Seite geladen wurde, funktioniert das Tool ohne jegliche Verbindung Client-seitige Verarbeitung ist die Standardeinstellung für alles, was ich baue, und wenn Ihnen das umfassendere Argument dafür am Herzen liegt, die Datenschutz-Leitfaden Vollständig darlegt.
Häufig gestellte Fragen
Was bedeutet es, JSON-Schlüssel zu sortieren?
Das Sortieren von JSON-Schlüsseln ordnet die Namen-Wert-Paare eines Objekts in alphabetische Reihenfolge um, ohne Werte zu ändern Das Objekt {" name": " toolz", "author"} wird zu {"author": "Liton" " name": "toolz"}. Es ändert sich nur die Reihenfolge der Schlüssel, so bleiben die Daten, die das Dokument darstellt, genau gleich.
Ändert das Sortieren von Tasten, was mein JSON bedeutet?
kein drohen Im JSON-Standard, ECMA-404, ist ein Objekt eine nicht geordnete Menge von Namen-Wert-Paaren, so dass das Neuordnen seiner Schlüssel nicht seine Bedeutung ändert. Jeder konforme Parser liest die sortierten und unsortierten Versionen als dieselben Daten. Die Reihenfolge ist nur für die menschliche Lesbarkeit und für die Herstellung stabiler Diffs von Bedeutung.
Sind auch verschachtelte Objekte sortiert?
Ja, standardmäßig. Die rekursive Sortierung ist aktiviert, sodass die Schlüssel jedes Objekts im Dokument auf jeder Ebene der Verschachtelung sortiert werden. Sie können Rekursion deaktivieren, um nur die Tasten der obersten Ebene zu sortieren und verschachtelte Objekte in ihrer ursprünglichen Reihenfolge zu lassen.
Ordert der Sortierer Arrays neu?
Nicht standardmäßig. Arrays sind definitionsgemäß geordnet, und das Neuordnen kann die Bedeutung ändern, sodass das Tool die Array-Reihenfolge beibehält. Es gibt die Möglichkeit, Arrays zu sortieren, deren Elemente alle Strings sind oder alle Zahlen, wenn sie geordnet sind; Arrays, die Typen mischen oder Objekte enthalten, bleiben immer so, wie sie sind.
Warum sollte ich JSON-Schlüssel sortieren?
Der häufigste Grund sind stabile Unterschiede: Wenn jede Datei ihre Schlüssel in derselben alphabetischen Reihenfolge schreibt, heben die Versionskontroll-Differen nur die Werte hervor, die sich geändert haben, anstatt die sich verschobenen Schlüssel. Das Sortieren erleichtert auch das Scannen und Vergleichen großer Konfigurationsdateien und API-Antworten mit dem Auge.
Wie funktioniert die Sortierung der Groß- und Kleinschreibung?
Bei der Ein- und Aussortierung von Groß- und Kleinschreibung werden die Schlüssel wie in Kleinbuchstaben verglichen, sodass Name, Name und Name nebeneinander gruppiert werden, anstatt getrennt zu werden, da Großbuchstaben vor Kleinbuchstaben in der rohen Zeichenreihenfolge sortieren. Schalten Sie es aus, um streng nach Zeichencode zu sortieren.
Kann ich den sortierten JSON minimieren?
Ja. Wählen Sie "Minified Output", um das sortierte JSON in einer Zeile ohne zusätzlichen Leerraum abzurufen. Dies ist die kleinste Form für die Speicherung oder den Transport. Wählen Sie für eine lesbare Datei die Option Pretty Output mit zwei Leerzeichen, vier Leerzeichen oder Tabulatoren.
Wird mein JSON irgendwo hochgeladen?
kein drohen Der JSON wird in Ihrem Browser analysiert und nach Javascript sortiert und niemals übertragen, protokolliert oder gespeichert. Sie können dies überprüfen, indem Sie sich während des Sortierens auf die Registerkarte Netzwerk ansehen oder offline gehen, ohne eine Verbindung zu funktionieren.
Geschrieben von Liton, Erbauer von [Toolz.dev] (/. Ich baue browserbasierte Entwicklertools und schreibe über die Arbeit mit JSON, Laravel und dem Web.
