Како кодирати сопствени емитер догађаја у Ноде.јс: детаљни водич

Разумевање интерних чворова кодирањем малих пакета / модула

Ако сте нови у Ноде.јс, има много водича овде на Медиуму и другде. На пример, можете погледати мој чланак Алл Абоут Цоре Ноде.ЈС.

Али без даљег одлагања, пређимо на тему о којој се расправља: ​​„Емитери догађаја“. Емитери догађаја играју веома важну улогу у екосистему Ноде.јс.

ЕвентЕмиттер је модул који олакшава комуникацију / интеракцију између објеката у Нодеу. ЕвентЕмиттер је у основи Ноде асинхроне архитектуре вођене догађајима. Многи уграђени модули Ноде-а наслеђују ЕвентЕмиттер, укључујући истакнуте оквире попут Екпресс.јс.

Концепт је прилично једноставан: емитерски објекти емитују именоване догађаје због којих се позивају претходно регистровани слушаоци. Дакле, емитерски објекат у основи има две главне карактеристике:

  • Емитујући догађаје имена.
  • Регистровање и поништавање регистрације функција слушалаца.

То је некако попут обрасца дизајна паба / подмлатка или посматрача (мада не баш).

Шта ћемо градити у овом упутству

  • ЦлассЕмиттер цласс
  • на / аддЕвентЛистенер методу
  • офф / ремовеЕвентЛистенер метода
  • једном метода
  • метода емисије
  • метода равЛистенерс
  • метход листенерЦоунт

Горе наведене основне карактеристике довољне су за примену комплетног система који користи модел догађаја.

Пре него што уђемо у кодирање, погледајмо како ћемо користити класу ЕвентЕмиттер. Имајте на уму да ће наш код имитирати тачан АПИ модула Ноде.јс 'евентс'.

У ствари, ако наш ЕвентЕмиттер замените уграђеним Ноде.јс-овим модулом за догађаје, добићете исти резултат.

Пример 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

Када се емитује догађај 'евентОне', треба позвати оба горе наведена повратна позива.

myEmitter.emit('eventOne');

Излаз у конзоли биће следећи:

an event occurred! yet another event occurred!

Пример 2 - Регистровање за покретање догађаја само једном, једном.

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

Емитујући догађај 'евентОнце':

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

НАПОМЕНА: Ако је догађај нерегистрован методом офф или ремовеЛистенер, бројање ће бити 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'); }); } }

Коришћење емитера догађаја витхТиме:

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 (Методе у нашем ЕвентЕмиттер-у)

Пошто сада разумемо АПИ употребе, пређимо на кодирање модула.

Комплетна шифра за класу ЕвентЕмиттер

Детаље ћемо попуњавати у наредних неколико одељака.

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

НАПОМЕНА : Код је оптимизован за читљивост, а не за перформансе. Можда као вежбу можете да оптимизујете код и делите га у одељку за коментаре. Нисмо у потпуности тестирали случајеве ивица и неке провере могу бити искључене, јер је ово било брзо писање.

Овај чланак је део предстојећег видео курса „Ноде.ЈС Мастер Цласс - Израдите сопствени МВЦ оквир сличан ЕкпрессЈС-у“.

Наслов курса још није коначан.