Как да кодирате вашия собствен излъчвател на събития в Node.js: ръководство стъпка по стъпка

Разберете вътрешните елементи на Node чрез кодиране на малки пакети / модули

Ако сте нов в Node.js, има много уроци тук на Medium и другаде. Можете да проверите моята статия All About Core Node.JS, например.

Но без повече шум, нека да стигнем до дискутираната тема: „Излъчватели на събития“. Излъчвателите на събития играят много важна роля в екосистемата Node.js.

EventEmitter е модул, който улеснява комуникацията / взаимодействието между обекти в Node. EventEmitter е в основата на асинхронната управлявана от събития архитектура на Node. Много от вградените модули на Node наследяват от EventEmitter, включително известни рамки като Express.js.

Концепцията е съвсем проста: обектите на излъчвателя излъчват именувани събития, които водят до извикване на предварително регистрирани слушатели. И така, излъчващият обект има две основни характеристики:

  • Излъчване на събития с имена.
  • Регистриране и отписване на функции на слушателя.

Това е нещо като модел на кръчма / подпис или наблюдател (макар и не точно).

Какво ще изграждаме в този урок

  • Клас EventEmitter
  • 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

ЗАБЕЛЕЖКА: Можете да излъчвате събития няколко пъти (с изключение на регистрираните с метода Once).

Пример 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 - Демонстрация на пример за асинхрон

// 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 (Методи в нашия EventEmitter)

Тъй като сега разбираме 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.