So codieren Sie Ihren eigenen Event-Emitter in Node.js: eine Schritt-für-Schritt-Anleitung

Verstehen Sie die Knoteninternale, indem Sie kleine Pakete / Module codieren

Wenn Sie Node.js noch nicht kennen, gibt es hier auf Medium und anderswo viele Tutorials. Sie können zum Beispiel meinen Artikel All About Core Node.JS lesen.

Kommen wir aber ohne weiteres zum Thema: „Event Emitters“. Event Emitters spielen eine sehr wichtige Rolle im Node.js-Ökosystem.

Der EventEmitter ist ein Modul, das die Kommunikation / Interaktion zwischen Objekten in Node erleichtert. EventEmitter ist das Kernstück der asynchronen ereignisgesteuerten Node-Architektur. Viele der in Node integrierten Module erben von EventEmitter, einschließlich prominenter Frameworks wie Express.js.

Das Konzept ist recht einfach: Emitterobjekte senden benannte Ereignisse aus, die dazu führen, dass zuvor registrierte Listener aufgerufen werden. Ein Emitterobjekt hat also grundsätzlich zwei Hauptmerkmale:

  • Namensereignisse ausgeben.
  • Listenerfunktionen registrieren und abmelden.

Es ist wie ein Pub / Sub- oder Beobachter-Designmuster (wenn auch nicht genau).

Was wir in diesem Tutorial bauen werden

  • EventEmitter-Klasse
  • on / addEventListener-Methode
  • off / removeEventListener-Methode
  • einmal Methode
  • Methode ausgeben
  • rawListeners-Methode
  • listenerCount-Methode

Die oben genannten Grundfunktionen reichen aus, um ein vollständiges System unter Verwendung des Ereignismodells zu implementieren.

Bevor wir uns mit der Codierung befassen, werfen wir einen Blick darauf, wie wir die EventEmitter-Klasse verwenden werden. Bitte beachten Sie, dass unser Code die genaue API des Node.js-Ereignismoduls nachahmt.

Wenn Sie unseren EventEmitter durch das in Node.js integrierte Modul 'events' ersetzen, erhalten Sie das gleiche Ergebnis.

Beispiel 1 - Erstellen Sie eine Ereignisemitterinstanz und registrieren Sie einige Rückrufe

const myEmitter = new EventEmitter(); function c1() { console.log('an event occurred!'); } function c2() { console.log('yet another event occurred!'); } myEmitter.on('eventOne', c1); // Register for eventOne myEmitter.on('eventOne', c2); // Register for eventOne

Wenn das Ereignis 'eventOne' ausgegeben wird, sollten beide oben genannten Rückrufe aufgerufen werden.

myEmitter.emit('eventOne');

Die Ausgabe in der Konsole lautet wie folgt:

an event occurred! yet another event occurred!

Beispiel 2 - Registrierung für das Ereignis, das nur einmal mit einmal ausgelöst werden soll.

myEmitter.once('eventOnce', () => console.log('eventOnce once fired')); 

Senden des Ereignisses 'eventOnce':

myEmitter.emit('eventOne');

Die folgende Ausgabe sollte in der Konsole angezeigt werden:

eventOnce once fired

Das Senden von Ereignissen, bei denen erneut registriert wurde, hat keine Auswirkungen.

myEmitter.emit('eventOne');

Da das Ereignis nur einmal gesendet wurde, hat die obige Erklärung keine Auswirkungen.

Beispiel 3 - Registrieren für das Ereignis mit Rückrufparametern

myEmitter.on('status', (code, msg)=> console.log(`Got ${code} and ${msg}`));

Senden des Ereignisses mit Parametern:

myEmitter.emit('status', 200, 'ok');

Die Ausgabe in der Konsole ist wie folgt:

Got 200 and ok

HINWEIS: Sie können Ereignisse mehrmals ausgeben (mit Ausnahme der Ereignisse, die mit der Methode Once registriert wurden).

Beispiel 4 - Aufheben der Registrierung von Ereignissen

myEmitter.off('eventOne', c1);

Wenn Sie das Ereignis nun wie folgt ausgeben, geschieht nichts und es wird ein Noop:

myEmitter.emit('eventOne'); // noop

Beispiel 5 - Abrufen der Listener-Anzahl

console.log(myEmitter.listenerCount('eventOne'));

HINWEIS: Wenn das Ereignis mit der Methode off oder removeListener nicht registriert wurde, ist die Anzahl 0.

Beispiel 6 - Rohe Listener abrufen

console.log(myEmitter.rawListeners('eventOne'));

Beispiel 7 - Async-Beispieldemo

// Example 2->Adapted and thanks to Sameer Buna class WithTime extends EventEmitter { execute(asyncFunc, ...args) { this.emit('begin'); console.time('execute'); this.on('data', (data)=> console.log('got data ', data)); asyncFunc(...args, (err, data) => { if (err) { return this.emit('error', err); } this.emit('data', data); console.timeEnd('execute'); this.emit('end'); }); } }

Verwenden des withTime-Ereignisemitters:

const withTime = new WithTime(); withTime.on('begin', () => console.log('About to execute')); withTime.on('end', () => console.log('Done with execute')); const readFile = (url, cb) => { fetch(url) .then((resp) => resp.json()) // Transform the data into json .then(function(data) { cb(null, data); }); } withTime.execute(readFile, '//jsonplaceholder.typicode.com/posts/1');

Überprüfen Sie die Ausgabe in der Konsole. Die Liste der Beiträge wird zusammen mit anderen Protokollen angezeigt.

Das Beobachtermuster für unseren Event-Emitter

Visuelles Diagramm 1 (Methoden in unserem EventEmitter)

Da wir jetzt die Verwendungs-API verstehen, wollen wir das Modul codieren.

Der vollständige Boilerplate-Code für die EventEmitter-Klasse

Wir werden die Details in den nächsten Abschnitten schrittweise ausfüllen.

class EventEmitter { listeners = {}; // key-value pair addListener(eventName, fn) {} on(eventName, fn) {} removeListener(eventName, fn) {} off(eventName, fn) {} once(eventName, fn) {} emit(eventName, ...args) { } listenerCount(eventName) {} rawListeners(eventName) {} }

We begin by creating the template for the EventEmitter class along with a hash to store the listeners. The listeners will be stored as a key-value pair. The value could be an array (since for the same event we allow multiple listeners to be registered).

1. The addListener() method

Let us now implement the addListener method. It takes in an event name and a callback function to be executed.

 addListener(event, fn)  []; this.listeners[event].push(fn); return this; 

A little explanation:

The addListener event checks if the event is already registered. If yes, returns the array, otherwise empty array.

this.listeners[event] // will return array of events or undefined (first time registration)

For example…

Let’s understand this with a usage example. Let’s create a new eventEmitter and register a ‘test-event’. This is the first time the ‘test-event’ is being registered.

const eventEmitter = new EventEmitter(); eventEmitter.addListener('test-event', ()=> { console.log ("test one") } );

Inside addListener () method:

this.listeners[event] => this.listeners['test-event'] => undefined || [] => []

The result will be:

this.listeners['test-event'] = []; // empty array

and then the ‘fn’ will be pushed to this array as shown below:

this.listeners['test-event'].push(fn);

I hope this makes the ‘addListener’ method very clear to decipher and understand.

A note: Multiple callbacks can be registered against that same event.

2. The on method

This is just an alias to the ‘addListener’ method. We will be using the ‘on’ method more than the ‘addListener’ method for the sake of convenience.

on(event, fn) { return this.addListener(event, fn); }

3. The removeListener(event, fn) method

The removeListener method takes an eventName and the callback as the parameters. It removes said listener from the event array.

NOTE: If the event has multiple listeners then other listeners will not be impacted.

First, let’s take a look at the full code for removeListener.

removeListener (event, fn) { let lis = this.listeners[event]; if (!lis) return this; for(let i = lis.length; i > 0; i--) { if (lis[i] === fn) { lis.splice(i,1); break; } } return this; }

Here’s the removeListener method explained step-by-step:

  • Grab the array of listeners by ‘event’
  • If none found return ‘this’ for chaining.
  • If found, loop through all listeners. If the current listener matches with the ‘fn’ parameter use the splice method of the array to remove it. Break from the loop.
  • Return ‘this’ to continue chaining.

4. The off(event, fn) method

This is just an alias to the ‘removeListener’ method. We will be using the ‘on’ method more than the ‘addListener’ method for sake of convenience.

 off(event, fn) { return this.removeListener(event, fn); }

5. The once(eventName, fn) method

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Use for setup/init kind of events.

Let’s take a peek at the code.

once(eventName, fn) { this.listeners[event] = this.listeners[eventName] || []; const onceWrapper = () => { fn(); this.off(eventName, onceWrapper); } this.listeners[eventName].push(onceWrapper); return this; }

Here’s the once method explained step-by-step:

  • Get the event array object. Empty array if the first time.
  • Create a wrapper function called onceWrapper which will invoke the fn when the event is emitted and also removes the listener.
  • Add the wrapped function to the array.
  • Return ‘this’ for chaining.

6. The emit (eventName, ..args) method

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

emit(eventName, ...args) { let fns = this.listeners[eventName]; if (!fns) return false; fns.forEach((f) => { f(...args); }); return true; }

Here’s the emit method explained step-by-step:

  • Get the functions for said eventName parameter
  • If no listeners, return false
  • For all function listeners, invoke the function with the arguments
  • Return true when done

7. The listenerCount (eventName) method

Returns the number of listeners listening to the event named eventName.

Here’s the source code:

listenerCount(eventName) 

Here’s the listenerCount method explained step-by-step:

  • Get the functions/listeners under consideration or an empty array if none.
  • Return the length.

8. The rawListeners(eventName) method

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()). The once wrappers in this implementation will not be available if the event has been emitted once.

rawListeners(event) { return this.listeners[event]; }

The full source code for reference:

class EventEmitter { listeners = {} addListener(eventName, fn)  on(eventName, fn) { return this.addListener(eventName, fn); } once(eventName, fn) { this.listeners[eventName] = this.listeners[eventName] || []; const onceWrapper = () => { fn(); this.off(eventName, onceWrapper); } this.listeners[eventName].push(onceWrapper); return this; } off(eventName, fn) { return this.removeListener(eventName, fn); } removeListener (eventName, fn) { let lis = this.listeners[eventName]; if (!lis) return this; for(let i = lis.length; i > 0; i--) { if (lis[i] === fn) { lis.splice(i,1); break; } } return this; } emit(eventName, ...args) { let fns = this.listeners[eventName]; if (!fns) return false; fns.forEach((f) => { f(...args); }); return true; } listenerCount(eventName)  rawListeners(eventName) { return this.listeners[eventName]; } }

The complete code is available here:

//jsbin.com/gibofab/edit?js,console,output

As an exercise feel free to implement other events’ APIs from the documentation //nodejs.org/api/events.html.

If you liked this article and want to see more of similar articles, feel free to give a couple of claps :)

NOTE: The code is optimized for readability and not for performance. Maybe as an exercise, you can optimize the code and share it in the comment section. Haven’t tested fully for edge cases and some validations may be off as this was a quick writeup.

This article is part of the upcoming video course “Node.JS Master Class — Build Your Own ExpressJS-Like MVC Framework from scratch”.

The title of the course is not yet finalized.