Sådan koder du din egen begivenhedsemitter i Node.js: en trinvis vejledning

Forstå Node-interner ved at kode små pakker / moduler

Hvis du er ny på Node.js, er der mange tutorials her på Medium og andre steder. Du kan f.eks. Tjekke min artikel Alt om kerne Node.JS.

Men uden yderligere ado, lad os komme til emnet under diskussion: "Event Emitters". Event Emitters spiller en meget vigtig rolle i Node.js-økosystemet.

EventEmitter er et modul, der letter kommunikation / interaktion mellem objekter i Node. EventEmitter er kernen i Node asynkron hændelsesdrevet arkitektur. Mange af Nodes indbyggede moduler arver fra EventEmitter, herunder prominente rammer som Express.js.

Konceptet er ret simpelt: emitterobjekter udsender navngivne begivenheder, der får kaldt til tidligere registrerede lyttere. Så et emitterobjekt har stort set to hovedfunktioner:

  • Udsendelse af navnehændelser.
  • Registrering og afregistrering af lytterfunktioner.

Det er som et pub / sub- eller observatørdesignmønster (dog ikke ligefrem).

Hvad vi skal bygge i denne vejledning

  • EventEmitter-klasse
  • on / addEventListener-metode
  • off / removeEventListener-metoden
  • en gang metode
  • udsender metode
  • rawListeners metode
  • listenerCount-metode

Ovenstående grundlæggende funktioner er tilstrækkelige til at implementere et komplet system ved hjælp af begivenhedsmodellen.

Før vi går ind i kodningen, lad os se på, hvordan vi bruger klassen EventEmitter. Bemærk, at vores kode efterligner den nøjagtige API for Node.js 'events' -modulet.

Faktisk, hvis du udskifter vores EventEmitter med Node.js's indbyggede 'events' -modul, får du det samme resultat.

Eksempel 1 - Opret en begivenhedsemitterinstans og registrer et par tilbagekald

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

Når begivenheden 'eventOne' udsendes, skal begge ovenstående tilbagekald påberåbes.

myEmitter.emit('eventOne');

Outputtet i konsollen vil være som følger:

an event occurred! yet another event occurred!

Eksempel 2 - Tilmelding til begivenheden, der kun fyres en gang ved hjælp af en gang.

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

Udsendelse af begivenheden 'eventOnce':

myEmitter.emit('eventOne');

Følgende output skal vises i konsollen:

eventOnce once fired

Udsendelse af begivenheder, der er registreret med igen, har ingen indflydelse.

myEmitter.emit('eventOne');

Da begivenheden kun blev udsendt en gang, har ovenstående erklæring ingen indflydelse.

Eksempel 3 - Registrering til begivenheden med tilbagekaldsparametre

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

Udsendelse af begivenheden med parametre:

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

Outputtet i konsollen vil være som nedenfor:

Got 200 and ok

BEMÆRK: Du kan udsende begivenheder flere gange (undtagen dem, der er registreret med metoden en gang).

Eksempel 4— Afmelding af begivenheder

myEmitter.off('eventOne', c1);

Hvis du nu udsender begivenheden som følger, vil der ikke ske noget, og det bliver en noop:

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

Eksempel 5 - Få lytteroptælling

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

BEMÆRK: Hvis begivenheden er blevet afregistreret ved hjælp af off eller removeListener-metoden, vil antallet være 0.

Eksempel 6 - Få rå lyttere

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

Eksempel 7 - Async-demo

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

Brug af withTime-begivenhedsemitteren:

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

Kontroller output i konsollen. Listen over indlæg vises sammen med andre logfiler.

Observatørmønsteret for vores begivenhedsudsender

Visuelt diagram 1 (Metoder i vores EventEmitter)

Da vi nu forstår brugen af ​​API, lad os gå til kodning af modulet.

Den komplette kedelpladekode til klassen EventEmitter

Vi udfylder detaljerne trinvist i de næste par sektioner.

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 :)

BEMÆRK : Koden er optimeret til læsbarhed og ikke til ydeevne. Måske som en øvelse kan du optimere koden og dele den i kommentarsektionen. Har ikke testet fuldt ud for kantsager, og nogle valideringer kan være slået fra, da dette var en hurtig opskrivning.

Denne artikel er en del af det kommende videokursus "Node.JS Master Class - Build Your Own ExpressJS-Like MVC Framework from scratch".

Kursets titel er endnu ikke afsluttet.