כיצד לקודד את פולט האירועים שלך ב- Node.js: מדריך שלב אחר שלב

להבין את פנימי הצומת על ידי קידוד חבילות / מודולים קטנים

אם אתה חדש ב- Node.js יש הרבה מדריכים כאן בינוני ובמקומות אחרים. אתה יכול לבדוק את המאמר שלי הכל אודות Core Node.JS, למשל.

אך ללא התייחסות נוספת, בואו נגיע לנושא הנדון: "פולטי אירועים". פולטני אירועים ממלאים תפקיד חשוב מאוד במערכת האקולוגית של Node.js.

ה- EventEmitter הוא מודול המאפשר תקשורת / אינטראקציה בין אובייקטים ב- Node. EventEmitter הוא הליבה של ארכיטקטורה מונעת אירועים אסינכרונית. רבים מהמודולים המובנים של Node יורשים מ- EventEmitter כולל מסגרות בולטות כמו Express.js.

הרעיון הוא די פשוט: אובייקטים פולטים פולטים אירועים בשם שגורמים להתקשרות למאזינים שנרשמו בעבר. אז, לאובייקט פולט בעצם יש שתי תכונות עיקריות:

  • פולט אירועי שם.
  • רישום וביטול רישום של פונקציות המאזין.

זה בערך כמו דפוס עיצוב פאב / משנה או צופה (אם כי לא בדיוק).

מה נבנה במדריך זה

  • שיעור Emitter
  • on / addEventListener שיטה
  • שיטת off / removeEventListener
  • פעם אחת
  • שיטת פולטים
  • שיטת rawListeners
  • שיטת listenerCount

התכונות הבסיסיות שלעיל מספיקות להטמעת מערכת מלאה באמצעות מודל האירוע.

לפני שנכנס לקידוד, בואו נסתכל כיצד נשתמש בכיתה EventEmitter. שים לב שהקוד שלנו יחקה את ה- API המדויק של מודול האירועים של Node.js.

למעשה, אם תחליף את EventEmitter שלנו במודול 'אירועים' המובנה של Node.js תקבל את אותה התוצאה.

דוגמא 1 - צור מופע של פולט אירוע וירשם כמה התקשרות חוזרות

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

כאשר האירוע 'eventOne' נפלט, יש להפעיל את השיחות החוזרות לעיל.

myEmitter.emit('eventOne');

הפלט במסוף יהיה כדלקמן:

an event occurred! yet another event occurred!

דוגמה 2 - הרשמה לאירוע שיפוטר פעם אחת בלבד תוך שימוש בפעם אחת.

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

פולט את האירוע 'eventOnce':

myEmitter.emit('eventOne');

הפלט הבא אמור להופיע במסוף:

eventOnce once fired

פליטת אירועים שנרשמה אליהם שוב לא תשפיע.

myEmitter.emit('eventOne');

מכיוון שהאירוע נפלט רק פעם אחת, לאמירה לעיל לא תהיה כל השפעה.

דוגמה 3 - הרשמה לאירוע עם פרמטרים להתקשרות חוזרת

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

פליטת האירוע עם פרמטרים:

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

הפלט במסוף יהיה כמו להלן:

Got 200 and ok

הערה: באפשרותך לפלוט אירועים מספר פעמים (למעט האירועים הרשומים בשיטת פעם).

דוגמה 4 - ביטול רישום אירועים

myEmitter.off('eventOne', c1);

עכשיו אם אתה משדר את האירוע באופן הבא, שום דבר לא יקרה וזה יהיה נופ:

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

דוגמה 5 - קבלת ספירת מאזינים

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

הערה: אם האירוע לא נרשם באמצעות שיטת Off או removeListener, הספירה תהיה 0.

דוגמה 6 - השגת מאזינים גולמיים

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

דוגמה 7 - הדגמה לדוגמא של Async

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

שימוש בפולט האירוע 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');

בדוק את הפלט במסוף. רשימת הפוסטים תוצג יחד עם יומנים אחרים.

תבנית הצופה עבור פולט האירוע שלנו

תרשים חזותי 1 (שיטות באירוע המגיש שלנו)

מכיוון שאנו מבינים כעת את ממשק ה- API לשימוש, בואו נקודד את המודול.

הקוד הדוד המלא עבור הכיתה EventEmitter

אנו ממלאים את הפרטים באופן הדרגתי בחלקים הזוגיים הבאים.

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.