Node.js EventEmitter: on, emit, once ve Özel Olaylar

EventEmitter, Node'un events modülünde bulunan ve bir nesnenin isimli olaylar duyurmasını sağlayan sınıftır. emitter.on('name', fn) ile bir listener kaydedersin ve emitter.emit('name', ...args) ile onu tetiklersin; o isimdeki her listener, eklendiği sırayla ve verdiğin argümanlarla çalışır. HTTP sunucuları, stream'ler ve process birer EventEmitter'dır, bu yüzden aynı birkaç metot Node'un her yerinde çalışır.

const EventEmitter = require('events');

const shop = new EventEmitter();

shop.on('order', (item, qty) => {
    console.log('order received:', qty, 'x', item);
});
shop.on('order', (item) => {
    console.log('update stock for', item);
});

console.log('before emit');
shop.emit('order', 'coffee', 2);
console.log('after emit');

İki listener da before emit ile after emit arasında çalışır: emit onları senkron çağırır ve ancak bittiklerinde döner. İki shop.on çağrısının yerini değiştirirsen ortadaki iki satırın da yeri değişir.

on, once ve off

on bir listener'ı sen silene kadar tutar, once onu ilk çağrıdan sonra siler, off (removeListener ile aynı) ise birini siler. Bir listener'ı silmek için eklediğin fonksiyonun aynısına ihtiyacın var, bu yüzden arrow function'ı satır içinde vermek yerine fonksiyona bir isim ver.

const EventEmitter = require('events');
const door = new EventEmitter();

function logOpen(who) {
    console.log('opened by', who);
}

door.on('open', logOpen);
door.once('open', () => console.log('first open ever'));

door.emit('open', 'Ada');
door.emit('open', 'Linus');

door.off('open', logOpen);
console.log('listeners left:', door.listenerCount('open'));
console.log('emit returned', door.emit('open', 'Grace'));

first open ever bir kez, Ada'dan sonra yazdırılır. logOpen silindikten sonra dinleyen kimse kalmaz, bu yüzden son emit false döndürür; door.removeAllListeners('open') iki listener'ı tek çağrıda temizlerdi.

error olayı

'error' özeldir. Onu emit edersen ve kimse dinlemiyorsa emit hatayı fırlatır ve gerçek bir programda yakalanmamış bir throw süreci çökertir. Stream'ler ve sunucular gibi hata verebilecek emitter'lara her zaman bir 'error' listener'ı ekle.

const EventEmitter = require('events');
const job = new EventEmitter();

try {
    job.emit('error', new Error('disk full'));
} catch (err) {
    console.log('emit threw:', err.message);
}

job.on('error', (err) => {
    console.log('handled:', err.message);
});
job.emit('error', new Error('disk full'));
console.log('still running');

Listener yokken emit hata fırlatır ve onu catch yakalar; listener eklendikten sonra aynı emit sadece onu çağırır ve program devam eder. Listener'ı olmayan diğer olay isimleri sessizce yok sayılır.

Kendi sınıfında EventEmitter'ı extend et

Olağan kullanım şekli, sınıfının EventEmitter'ı extend etmesi, constructor'da super() çağırması ve bir şey olduğunda this.emit kullanmasıdır. Sonra çağıranlar nesnene herhangi bir Node nesnesine abone olur gibi abone olur.

const EventEmitter = require('events');

class Upload extends EventEmitter {
    constructor(name, chunks) {
        super();
        this.name = name;
        this.chunks = chunks;
    }

    start() {
        for (let i = 1; i <= this.chunks; i++) {
            this.emit('progress', Math.round((i / this.chunks) * 100));
        }
        this.emit('done', this.name);
    }
}

const up = new Upload('photo.png', 4);
up.on('progress', (pct) => console.log(pct + '%'));
up.once('done', (name) => console.log(name, 'uploaded'));
up.start();

Önce 25%, 50%, 75%, 100%, ardından photo.png uploaded yazdırılır. up.start() satırını iki up.on satırının üstüne taşırsan hiçbir şey yazdırılmaz: olaylar kimse dinlemeden tetiklenir.

Aynı tuzak constructor'dan emit ederken de geçerlidir. Hemen emit etmesi gereken kütüphaneler çağrıyı process.nextTick ile sarar; bu, çağıranın on satırlarından sonra çalışır (bkz. event loop sayfası).

events.once ile bir olayı bekle

events.once(emitter, name), olay bir sonraki sefer emit edildiğinde olayın argümanlarıyla, bir dizi olarak, resolve olan bir promise döndürür. Tek seferlik bir olayı await edebileceğin bir şeye çevirir ve emitter önce 'error' emit ederse reject olur.

import { EventEmitter, once } from 'events';

const db = new EventEmitter();

setTimeout(() => db.emit('ready', 'v1.4', 3), 100);

console.log('waiting for ready');
const [version, tables] = await once(db, 'ready');
console.log('ready:', version, 'with', tables, 'tables');

await, timer ready olayını emit edene kadar bekler, sonra dizi iki argümana ayrıştırılır. Birçok kez tetiklenen bir olay için events.on(emitter, name), for await ile üzerinde döngü kurabileceğin bir async iterator verir.

Sık yapılan hatalar

Sık çalışan bir fonksiyonun içinde listener eklemek. Her request handler'da on çağırmak listener'ları ve belleği üst üste yığar. Bir kez ekle ya da once kullan.

Satır içi bir fonksiyonu silmeye çalışmak. off('data', () => ...) hiçbir şey silmez, çünkü o arrow function yepyeni bir fonksiyondur. Eklediğin fonksiyona bir referans tut.

Listener'ların daha sonra çalışmasını beklemek. emit senkrondur, yani yavaş bir listener emit eden kodu bekletir. Listener'ı async yapmak işe yaramaz, çünkü kodu ilk await satırına kadar yine aynı thread'de çalışır. Ağır işi aralarına setImmediate koyarak parçalara böl ya da bir worker thread'e taşı.