mitmario.dev

JSON-Dateien

Node.js Sandbox 3 Min Lesezeit 3 BeispieleLektion 4 von 7

Textdateien sind gut für Text. Willst du aber Daten ablegen, also Listen, Zahlen und Objekte, brauchst du ein Format, das die Struktur mitschreibt. JSON ist dafür der Standard, und aus dem JavaScript-Kurs kennst du es schon.

Neu ist nur, dass es jetzt in einer Datei liegt. Und eine Datei bleibt zwischen zwei Läufen erhalten.

Vier Schritte, immer dieselben

Einlesen als Text. Mit JSON.parse in ein Objekt verwandeln. Damit arbeiten wie mit jedem anderen Objekt. Mit JSON.stringify zurück in Text verwandeln und schreiben.

Der Zyklus aus vier Schritten
import { readFile, writeFile } from "node:fs/promises";

const daten = JSON.parse(await readFile("daten.json", "utf8"));

daten.lektionen.push("Prozess");

await writeFile("daten.json", JSON.stringify(daten, null, 2) + "\n");

console.log("Lektionen:", daten.lektionen.length);
console.log(await readFile("daten.json", "utf8"));

readFile gibt dir immer Text, auch wenn die Datei .json heißt. Node kennt den Unterschied nicht und soll ihn auch nicht kennen. Die Endung ist eine Verabredung zwischen Menschen.

Das + "\n" am Ende ist Höflichkeit gegenüber allen anderen Werkzeugen. Textdateien enden üblicherweise mit einem Zeilenumbruch, und Programme wie git merken es an, wenn deine nicht.

Der dritte Parameter ist mehr wert, als er aussieht

JSON.stringify(daten) schreibt alles in eine einzige Zeile. JSON.stringify(daten, null, 2) rückt ein.

Der dritte Parameter
const daten = { titel: "Kursplan", lektionen: ["Module", "Dateisystem"] };

console.log("Ohne dritten Parameter:");
console.log(JSON.stringify(daten));
console.log("Mit Einrückung 2:");
console.log(JSON.stringify(daten, null, 2));

Der zweite Parameter null steht dabei für „nichts aussortieren“. Gebraucht wird er selten. Die Einrückung ist aber nun einmal der dritte, und den zweiten kannst du nicht überspringen.

Im Alltag zählt die Einrückung, sobald die Datei in einem Repository liegt, der Ablage, in der Git jeden Stand deiner Dateien aufhebt. Bei einer eingerückten Datei zeigt dir git diff dann nur die Zeilen, die sich tatsächlich geändert haben, und beim neuen Eintrag oben sind das genau zwei. Ohne Einrückung besteht die ganze Datei aus einer Zeile, und git diff meldet nur, dass sich diese eine Zeile geändert hat. Was jemand wirklich geändert hat, siehst du dann nicht mehr.

Für Daten, die nur zwischen Programmen wandern und die kein Mensch liest, ist die kompakte Form richtig.

Kaputte Dateien fliegen dir um die Ohren, und das ist gut

JSON.parse ist streng. Ein Komma zu viel, ein einfaches statt doppeltes Anführungszeichen, ein abgeschnittenes Ende, und es wirft.

Wenn die Datei kaputt ist
import { readFile } from "node:fs/promises";

const roh = await readFile("kaputt.json", "utf8");

console.log("Gelesen, aber noch nicht verstanden:", roh.length, "Zeichen");

const daten = JSON.parse(roh);

console.log(daten.titel);

Die Meldung nennt dir die Position im Text und die Zeile. Das ist eine der brauchbareren Fehlermeldungen in JavaScript.

Wichtiger ist aber, dass es überhaupt einen Fehler gibt. Sonst gäbe parse bei einer kaputten Datei irgendetwas Halbes zurück, und du würdest ganz normal damit weiterarbeiten, bis irgendwann die Hälfte deiner Daten still verschwunden ist.

Wie du diesen Fehler abfängst und trotzdem sinnvoll weitermachst, kommt in der nächsten Lektion.

Wann eine JSON-Datei reicht

Für ein kleines Werkzeug ist eine JSON-Datei als Datenspeicher völlig in Ordnung. Sie ist lesbar und braucht keine Installation. Du kannst sie im Editor aufmachen und im Zweifel von Hand reparieren. Für Konfiguration, eine Aufgabenliste oder ein paar hundert Einträge reicht das.

Die Grenze ist erreicht, sobald zwei Dinge gleichzeitig schreiben. Im Zyklus oben wird die ganze Datei gelesen, im Speicher geändert und ganz zurückgeschrieben. Tun zwei Abläufe das parallel, gewinnt der letzte, und die Änderung des ersten ist weg. Ein Kommandozeilenwerkzeug, das einmal läuft und eins nach dem anderen erledigt, merkt davon nichts. Anders ist es bei zwei Terminals, einem Cronjob oder einem Webserver mit vielen Anfragen. Da geht still etwas verloren.

Dort fängt Abschnitt 12 an, und dann heißt die Antwort SQLite.

Der Liste in daten.json fehlt in der Aufgabe noch ein Eintrag.

Zum Mitnehmen

Eine JSON-Datei kommt als Text herein, wird mit JSON.parse zum Objekt und geht nach der Änderung mit JSON.stringify ganz zurück, eingerückt, wenn Menschen sie lesen. Ist sie kaputt, wirft JSON.parse.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.