Abschnitt 8 · Lektion 3
JSON
Ein Array in eine Datei zu schreiben klingt nach einem Nachmittag Arbeit. Ein ausgedachtes Trennzeichen, ein paar Sonderfälle und eine eigene Funktion zum Einlesen. Das ist alles schon erledigt, und zwar in einem Format, das außer PHP auch JavaScript, Python und fast jede Schnittstelle im Netz versteht.
json_encode und json_decode
<?php
declare(strict_types=1);
$warenkorb = [
"kunde" => "Mia",
"artikel" => ["Kaffee", "Brot"],
"summe" => 1245,
];
$text = json_encode($warenkorb);
echo "Als Text:\n", $text, "\n";
echo "Typ: ", get_debug_type($text), "\n";
$zurueck = json_decode($text, true);
echo "\nUnd wieder zurück:\n";
var_dump($zurueck); json_encode() macht aus deinem Array einen Text. json_decode() macht daraus wieder ein Array.
Mehr ist es im Kern nicht, und für alles, was du in diesem Kurs speicherst, reicht dieses Paar.
In der ersten Zeile der Ausgabe steht der ganze Warenkorb, mit geschweiften Klammern für Zuordnungen und eckigen für Listen. Das ist der Unterschied zwischen Liste und Zuordnung aus Abschnitt 5, diesmal sichtbar im Text.
Das zweite Argument entscheidet, was zurückkommt
<?php
declare(strict_types=1);
$text = '{"kunde": "Mia", "summe": 1245}';
echo "Ohne zweites Argument:\n";
$objekt = json_decode($text);
var_dump($objekt);
echo "Zugriff: ", $objekt->kunde, "\n";
echo "\nMit true:\n";
$array = json_decode($text, true);
var_dump($array);
echo "Zugriff: ", $array["kunde"], "\n"; json_decode($text) gibt dir ein Objekt zurück und kein Array. Du schreibst dann
$objekt->kunde statt $objekt["kunde"]. foreach läuft noch wie gewohnt, aber count() und die
Array-Funktionen aus Abschnitt 5 brechen mit einem TypeError ab.
In diesem Kurs steht überall true als zweites Argument, denn mit frisch gelesenen Daten geht es
fast immer mit diesen Array-Funktionen weiter.
Damit die Datei lesbar bleibt
<?php
declare(strict_types=1);
$daten = ["ware" => "Müsli", "menge" => 3, "bio" => true];
echo "So klein wie möglich:\n";
echo json_encode($daten), "\n";
echo "\nMit Einrückung:\n";
echo json_encode($daten, JSON_PRETTY_PRINT), "\n";
echo "\nMit Einrückung und echten Umlauten:\n";
echo json_encode($daten, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), "\n"; Ohne weitere Angabe schreibt json_encode so kurz wie möglich, ohne Umbrüche und ohne Leerzeichen.
Für eine Übertragung übers Netz ist das richtig. Für eine Datei, in die du selbst noch mal
hineinschaust, eher nicht.
Zwei Schalter helfen, und beide gehören zusammen:
JSON_PRETTY_PRINTsetzt Umbrüche und rückt mit vier Leerzeichen ein.JSON_UNESCAPED_UNICODElässt Umlaute als Umlaute stehen. Ohne den Schalter maskiert PHP dasüals\u00fc, ausMüsliwird alsoM\u00fcsli. Beides ist gültiges JSON und wird beim Einlesen wieder dasselbe, nur lesen kann ein Mensch nur das eine. Ohne Datei zeigt esphp -r 'echo json_encode("Müsli");'im Terminal, die Antwort ist"M\u00fcsli".
Der senkrechte Strich dazwischen ist derselbe wie bei den Schaltern für file().
Wenn das JSON kaputt ist
<?php
declare(strict_types=1);
$kaputt = '{"kunde": "Mia", "summe": }';
echo "Ohne Schalter:\n";
$still = json_decode($kaputt, true);
var_dump($still);
echo "Nachgefragt: ", json_last_error_msg(), "\n";
echo "\nMit JSON_THROW_ON_ERROR:\n";
try {
json_decode($kaputt, true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $fehler) {
echo "Gefangen: ", $fehler->getMessage(), "\n";
echo "Code: ", $fehler->getCode(), "\n";
} Bekommt json_decode etwas, das kein gültiges JSON ist, gibt es stillschweigend null zurück.
Auf dem Fehlerkanal steht nichts, nicht einmal eine Warnung. Dein Programm arbeitet mit diesem
null einfach weiter, bis der Fehler drei Funktionen später als etwas ganz anderes auftaucht und
niemand mehr sieht, woher er kommt.
Was los war, erfährst du nur, wenn du von dir aus json_last_error_msg() fragst. Und so ein eigenes
Nachfragen vergisst man leicht, wie beim false aus dem Abschnitt über Fehler.
Mit dem vierten Argument ist damit Schluss. JSON_THROW_ON_ERROR macht aus dem stillen null eine
JsonException, und die kannst du fangen wie jede andere Ausnahme. Die Meldung lautet
Syntax error, der Code ist 4.
Das dritte Argument dazwischen ist die maximale Verschachtelungstiefe. 512 ist der Standardwert,
und du schreibst ihn nur hin, weil du an das vierte herankommen willst. Mit benannten Argumenten aus
Abschnitt 6 geht es auch ohne, json_decode($text, true, flags: JSON_THROW_ON_ERROR) kommt zum
selben Ziel.
Der ganze Weg an einem Stück
{"ort":"Regal 3","waren":[{"name":"Kaffee","menge":1},{"name":"Kräutertee","menge":4}]} <?php
declare(strict_types=1);
$daten = json_decode(file_get_contents("lager.json"), true, 512, JSON_THROW_ON_ERROR);
echo "Kaffee vorher: ", $daten["waren"][0]["menge"], "\n";
$daten["waren"][0]["menge"] += 2;
file_put_contents(
"lager.json",
json_encode($daten, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR)
);
echo "Kaffee nachher: ", $daten["waren"][0]["menge"], "\n";
echo "\nSo sieht die Datei jetzt aus:\n";
echo file_get_contents("lager.json"), "\n"; Lesen, umbauen, zurückschreiben. Mit diesem Muster kommt eine kleine Anwendung ohne Datenbank aus. Im Beispiel steigt die Menge beim Kaffee um zwei, und die Liste bleibt so lang, wie sie war.
Erst wird die Datei vollständig gelesen, dann im Speicher verändert, dann in einem Rutsch
zurückgeschrieben. Geht beim Lesen oder Umbauen etwas schief, ist die Datei noch nicht angefasst.
Beim Schreiben selbst gilt das nicht mehr. file_put_contents leert die Datei zuerst, und wenn
json_encode ein false liefert, steht danach eine leere Datei da. Deshalb gehört
JSON_THROW_ON_ERROR auch an json_encode.
Die Datei ist danach anders als davor, und deshalb meldet ein zweites php index.php im Terminal
Kaffee vorher: 3. Das Programm arbeitet auf dem Stand, den es selbst hinterlassen hat.
In der Aufgabe kommt ein Eintrag zu einer Einkaufsliste dazu, die in daten.json steht.
Zum Mitnehmen
Aus einem Array wird mit json_encode ein Text und mit json_decode und true wieder ein Array. JSON_PRETTY_PRINT und JSON_UNESCAPED_UNICODE halten die Datei lesbar, JSON_THROW_ON_ERROR macht aus einem stillen null eine Ausnahme.
Jetzt du
Basis Konto, kostenlosZu 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 5 Beispielen zum Ausprobieren
Steht hier, ohne Konto lesbar.
-
Aufgabe, dein Code läuft auf einem Server
Öffnet sich mit dem Basis Konto.