mitmario.dev

EventEmitter

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

Eine Küche bekommt eine Bestellung. Die Theke soll es erfahren, die Statistik auch, und morgen vielleicht die Abrechnung. Ruft die Küche alle drei selbst auf, muss sie jeden davon kennen. Und für jeden neuen wird sie umgebaut. Den Ausweg kennst du aus dem Browser, dort heißt er addEventListener. Eine Stelle meldet, dass etwas passiert ist, und wer sich dafür interessiert, hängt sich daran.

In Node heißt das EventEmitter. Er hängt nicht an einem DOM-Knoten, sondern an einem beliebigen Objekt. Ein Objekt, das auf diese Weise meldet, heißt kurz Emitter. Server, Sockets, Streams und Kindprozesse sind alle Emitter. Die halbe Standardbibliothek baut darauf auf, und wenn du das Muster einmal kennst, liest du fremden Node-Code plötzlich viel flüssiger.

Anhängen und auslösen

on hängt einen Listener an, wie addEventListener im JavaScript-Kurs, und emit löst das Ereignis aus.

Zuhören und melden
import { EventEmitter } from "node:events";

const kueche = new EventEmitter();

kueche.on("bestellung", (tisch, gericht) => {
  console.log(`Tisch ${tisch} bekommt ${gericht}`);
});

kueche.emit("bestellung", 4, "Suppe");
kueche.emit("bestellung", 7, "Salat");

Den Ereignisnamen wählst du frei, er ist einfach ein Text. Was hinter dem Namen an emit geht, kommt bei den Listenern als Argumente an. Die Reihenfolge bleibt dieselbe, im Beispiel erst der Tisch und dann das Gericht. Ein festes Format gibt es nicht, und angemeldet wird ein Ereignisname nirgends. Wer sich im Namen vertippt, bekommt deshalb auch keine Fehlermeldung. Es ist dann halt ein Ereignis, auf das niemand hört.

once, wenn es nur beim ersten Mal zählt

once hört nur einmal zu
import { EventEmitter } from "node:events";

const melder = new EventEmitter();

melder.on("tick", (nummer) => console.log(`on: ${nummer}`));
melder.once("tick", (nummer) => console.log(`once: ${nummer}`));

melder.emit("tick", 1);
melder.emit("tick", 2);
melder.emit("tick", 3);

once nimmt man für alles, was nur einmal passiert. Etwa „Verbindung steht“, „Datei ist fertig gelesen“ oder „Server hört jetzt zu“. Der Listener nimmt sich nach dem ersten Aufruf selbst wieder ab. Mit on müsste das später off erledigen, und off braucht dafür genau die Funktion, die bei on angemeldet wurde, nicht bloß eine, die gleich aussieht.

Das ist mehr als Bequemlichkeit. Wer Listener anhängt und nie abnimmt, hat irgendwann ein Programm, dessen Speicherverbrauch langsam steigt. Node rechnet sogar damit. Hängen an einem Ereignis mehr als zehn Listener, steht auf dem Fehlerkanal eine MaxListenersExceededWarning. Gleich dahinter kommt Possible EventEmitter memory leak detected, also der Verdacht auf ein Speicherleck.

Wann die Listener laufen

emit ruft sofort auf
import { EventEmitter } from "node:events";

const melder = new EventEmitter();

melder.on("fertig", () => console.log("der Listener läuft"));

console.log("vor emit");
melder.emit("fertig");
console.log("nach emit");

emit ruft die Listener synchron auf. Direkt, nacheinander, mitten in der Zeile, in der emit steht. Nichts davon passiert „später“ oder „im Hintergrund“. Ein Listener, der lange rechnet, hält die Stelle mit dem emit auf, und die Zeile danach kommt erst dran, wenn er fertig ist. Arbeit loswerden kann man mit einem Ereignis also nicht.

Zu spät angemeldet
import { EventEmitter } from "node:events";

const kueche = new EventEmitter();

kueche.emit("bestellung", 4, "Suppe");

kueche.on("bestellung", (tisch, gericht) => {
  console.log(`Tisch ${tisch} bekommt ${gericht}`);
});

console.log("Bestellung gemeldet");

Hier meldet die Küche, bevor sich die Theke angehängt hat. Im Terminal steht nur Bestellung gemeldet. Von Tisch 4 keine Spur, und eine Fehlermeldung gibt es auch nicht. Ereignisse werden nicht aufgehoben. Ein Listener, der erst nach dem emit dazukommt, hat es verpasst.

Ist ein Listener eine async-Funktion, wartet emit übrigens nicht auf sie. Es ruft sie auf, bekommt ein Promise zurück und wirft es weg. Wenn du auf ein Ergebnis warten willst, bist du bei Ereignissen an der falschen Adresse. Was man stattdessen nimmt, steht in Lektion 7.2.

Die Küche weiß von nichts

Die Küche im ersten Beispiel weiß nicht, wer ihre Bestellungen entgegennimmt. Sie meldet nur, dass eine da ist. Ein zweiter Listener, der jede Bestellung mitschreibt, kommt einfach dazu. Ein dritter für die Statistik auch, und an der Küche ändert sich dafür keine einzige Zeile.

In der Aufgabe meldet ein fertiger Zähler seine Schritte, und drei Listener machen daraus eine Ausgabe.

Zum Mitnehmen

on hängt einen Listener an, emit löst das Ereignis aus, once hört nur beim ersten Mal zu, und off nimmt einen Listener wieder ab. Alle Listener werden mitten im emit aufgerufen, bevor die Zeile danach drankommt.

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.