Comment coder votre propre émetteur d'événements dans Node.js: un guide étape par étape

Comprendre les composants internes de Node en codant de petits packages / modules

Si vous êtes nouveau sur Node.js, il existe de nombreux tutoriels ici sur Medium et ailleurs. Vous pouvez consulter mon article Tout sur Core Node.JS, par exemple.

Mais sans plus tarder, passons au sujet en discussion: «Event Emitters». Les émetteurs d'événements jouent un rôle très important dans l'écosystème Node.js.

EventEmitter est un module qui facilite la communication / interaction entre les objets dans Node. EventEmitter est au cœur de l'architecture événementielle asynchrone Node. De nombreux modules intégrés de Node héritent d'EventEmitter, y compris des frameworks importants comme Express.js.

Le concept est assez simple: les objets émetteurs émettent des événements nommés qui provoquent l'appel des écouteurs précédemment enregistrés. Ainsi, un objet émetteur a essentiellement deux caractéristiques principales:

  • Emission d'événements de nom.
  • Enregistrement et désinscription des fonctions d'écoute.

C'est un peu comme un modèle de conception de pub / sub ou d'observateur (mais pas exactement).

Ce que nous allons construire dans ce tutoriel

  • Classe EventEmitter
  • méthode on / addEventListener
  • méthode off / removeEventListener
  • méthode une fois
  • méthode d'émission
  • Méthode rawListeners
  • listenerCount, méthode

Les fonctionnalités de base ci-dessus sont suffisantes pour implémenter un système complet utilisant le modèle d'événement.

Avant d'entrer dans le codage, voyons comment nous utiliserons la classe EventEmitter. Veuillez noter que notre code imitera l'API exacte du module «événements» de Node.js.

En fait, si vous remplacez notre EventEmitter par le module «événements» intégré de Node.js, vous obtiendrez le même résultat.

Exemple 1 - Créez une instance d'émetteur d'événement et enregistrez quelques rappels

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

Lorsque l'événement 'eventOne' est émis, les deux rappels ci-dessus doivent être appelés.

myEmitter.emit('eventOne');

La sortie dans la console sera la suivante:

an event occurred! yet another event occurred!

Exemple 2— Enregistrement pour l'événement à déclencher une seule fois en utilisant une seule fois.

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

Emission de l'événement 'eventOnce':

myEmitter.emit('eventOne');

La sortie suivante doit apparaître dans la console:

eventOnce once fired

L'émission d'événements enregistrés avec une fois de plus n'aura aucun impact.

myEmitter.emit('eventOne');

Puisque l'événement n'a été émis qu'une seule fois, l'instruction ci-dessus n'aura aucun impact.

Exemple 3 - Inscription à l'événement avec des paramètres de rappel

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

Emission de l'événement avec paramètres:

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

La sortie dans la console sera comme ci-dessous:

Got 200 and ok

REMARQUE: vous pouvez émettre des événements plusieurs fois (sauf ceux enregistrés avec la méthode une fois).

Exemple 4 - Annulation de l’enregistrement d’événements

myEmitter.off('eventOne', c1);

Maintenant, si vous émettez l'événement comme suit, rien ne se passera et ce sera un noop:

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

Exemple 5 - Obtention du nombre d'auditeurs

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

REMARQUE: si l'événement a été désinscrit à l'aide de la méthode off ou removeListener, le nombre sera égal à 0.

Exemple 6 - Obtenir des écouteurs bruts

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

Exemple 7 - Démo Async Exemple

// 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'); }); } }

Utilisation de l'émetteur d'événements withTime:

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');

Vérifiez la sortie dans la console. La liste des messages sera affichée avec d'autres journaux.

Le modèle d'observateur pour notre émetteur d'événements

Diagramme visuel 1 (méthodes de notre EventEmitter)

Puisque nous comprenons maintenant l'API d'utilisation, passons au codage du module.

Le code passe-partout complet pour la classe EventEmitter

Nous allons compléter les détails progressivement dans les prochaines sections.

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.