mitmario.dev

Promises in Node

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

In älterem Node-Code steht readFile ohne await, mit einer Funktion als letztem Argument. In diesem Stil bleibt ein Fehler still, solange niemand nach ihm fragt, und das Programm läuft mit Unsinn weiter.

Node ist älter als Promises. Als die Standardbibliothek entstand, gab es async und await noch nicht, und deshalb gibt es vieles darin zweimal. node:fs arbeitet mit Callbacks und node:fs/promises mit Promises. Dasselbe Paar gibt es bei node:dns, node:timers, node:stream und node:readline. In Abschnitt 3 hast du durchgehend die Promise-Variante benutzt, ohne viel Aufhebens. Die andere wirst du trotzdem lesen müssen.

Der Callback-Stil und seine feste Form

Im alten Stil bekommt eine Funktion als letztes Argument eine Funktion mit, den Callback. Node ruft ihn auf, wenn das Ergebnis da ist, und gibt ihm zwei Werte mit: den Fehler und das Ergebnis.

Der Callback-Stil, Fehler zuerst
import { readFile } from "node:fs";

readFile("notizen.txt", "utf8", (fehler, text) => {
  if (fehler) {
    console.error(`Konnte nicht lesen: ${fehler.code}`);
    return;
  }
  console.log(`${text.trim().split("\n").length} Zeilen`);
});

Der Fehler kommt zuerst. Ist er null, hat es geklappt, und das Ergebnis steht im zweiten Parameter. Ist er gesetzt, gibt es kein Ergebnis.

Das nennt sich Fehler-zuerst-Verabredung, und ein Callback dieser Form heißt Fehler-zuerst-Callback (englisch error-first callback). Das Wort Verabredung ist wörtlich gemeint. Alle halten sich daran, aber die Sprache selbst prüft nichts. Wenn du den ersten Parameter nicht anschaust, sagt dir niemand etwas.

Der ignorierte Fehler

Was ein ignorierter Fehler anrichtet
import { readFile } from "node:fs";

readFile("gibtsnicht.txt", "utf8", (fehler, text) => {
  console.log(`Inhalt: ${text}`);
  console.log("Fertig.");
});

Die Datei gibt es nicht. Der Fehler steht sauber im ersten Parameter, wird aber nie angeschaut, und der zweite ist undefined. Das Programm läuft trotzdem weiter, schreibt Inhalt: undefined und darunter Fertig. ins Terminal und beendet sich mit Exit-Code 0. Alles in Ordnung, sagt es.

Das ist der teuerste Unterschied zwischen den beiden Stilen. Ein await ohne try wirft, und ein geworfener Fehler ist laut. Ein Callback ohne if (fehler) ist still.

Derselbe Vorgang mit Promises

Dasselbe mit await
import { readFile } from "node:fs/promises";

try {
  const text = await readFile("notizen.txt", "utf8");
  console.log(`${text.trim().split("\n").length} Zeilen`);
} catch (fehler) {
  console.error(`Konnte nicht lesen: ${fehler.code}`);
}

Kürzer ist es kaum, darum geht es auch nicht. Der Fehler nimmt jetzt den gewöhnlichen Weg der Sprache, über try und catch wie überall sonst. Mehrere Aufrufe passen in einen try, und Fehler lassen sich nach oben durchreichen. Aus Versehen nicht hinschauen geht auch nicht mehr, denn dann bricht das Programm ab.

Beim Fangen lohnt sich ein zweiter Blick auf den Fehler. Behandelt ein catch jeden Fehler gleich, verschluckt es auch die, mit denen du nicht gerechnet hast. fehler.code sagt dir, was wirklich los war. ENOENT heißt „gibt es nicht“, EACCES heißt „darfst du nicht“. Die Codes sind dieselben wie in Lektion 3.5.

Wenn ein fremdes Paket noch Callbacks nimmt

Das kommt vor, und dann willst du den Callback-Stil nicht in deinem ganzen Code herumtragen. util.promisify macht aus einer Funktion mit Fehler-zuerst-Callback eine, die ein Promise zurückgibt.

util.promisify als Brücke
import { promisify } from "node:util";

const altmodisch = (name, weiter) => {
  setTimeout(() => weiter(null, `Hallo ${name}`), 10);
};

const modern = promisify(altmodisch);

console.log(await modern("Mario"));

Eine Zeile, und ab da benutzt du sie wie alles andere. Bedingung ist nur, dass die Funktion sich an die Verabredung hält, also den Callback als letztes Argument erwartet und ihm den Fehler an erster Stelle übergibt. Ruft sie ihren Callback mit dem Ergebnis an erster Stelle auf, hält promisify das Ergebnis für einen Fehler. Das Promise wird dann mit dem Gruß abgelehnt, statt ihn zu liefern.

Die Aufgabe ist ein kleines Skript im Callback-Stil, das zwei Dateien liest und auf await umziehen soll.

Zum Mitnehmen

Für Dateien, Timer, Streams und DNS hat Node zwei Fassungen, eine mit Callbacks und eine mit Promises. Neuer Code nimmt die mit Promises, denn im Callback-Stil liegt ein Fehler still im ersten Parameter, mit await dagegen wirft er.

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 4 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.