EventEmitter Node.js: on, emit, once dan Custom Event

EventEmitter adalah class di module events milik Node yang memungkinkan sebuah object mengumumkan event bernama. Kamu mendaftarkan listener dengan emitter.on('name', fn) dan memicunya dengan emitter.emit('name', ...args); setiap listener untuk nama itu berjalan, sesuai urutan pemasangannya, dengan argumen yang kamu berikan. HTTP server, stream, dan process semuanya adalah EventEmitter, jadi beberapa method yang sama ini bekerja di mana saja di Node.

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

Kedua listener berjalan di antara before emit dan after emit: emit memanggilnya secara synchronous dan baru kembali setelah keduanya selesai. Tukar posisi dua panggilan shop.on dan dua baris di tengah ikut tertukar.

on, once dan off

on menyimpan listener sampai kamu melepasnya, once melepasnya setelah panggilan pertama, dan off (sama dengan removeListener) melepas satu listener. Untuk melepas listener kamu butuh fungsi yang sama dengan yang kamu pasang, jadi beri nama fungsinya alih-alih menulis arrow function langsung di tempat.

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 tercetak sekali, setelah Ada. Begitu logOpen dilepas, tidak ada yang mendengarkan lagi, jadi emit terakhir mengembalikan false; door.removeAllListeners('open') akan menghapus kedua listener dalam satu panggilan.

Event error

'error' itu istimewa. Kalau kamu memancarkannya dan tidak ada yang mendengarkan, emit melempar error-nya, dan di program sungguhan, throw yang tidak ditangkap membuat proses crash. Selalu pasang listener 'error' di emitter yang bisa gagal, seperti stream dan server.

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

Tanpa listener, emit melempar error dan catch menangkapnya; setelah listener dipasang, emit yang sama hanya memanggilnya dan program terus berjalan. Nama event lain yang tidak punya listener diabaikan begitu saja.

Extend EventEmitter di class milikmu

Cara pakai yang umum adalah membuat class-mu extends EventEmitter, memanggil super() di constructor, dan this.emit saat sesuatu terjadi. Pemanggil lalu bisa subscribe ke object-mu seperti ke object Node mana pun.

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

Hasilnya 25%, 50%, 75%, 100%, lalu photo.png uploaded. Pindahkan up.start() ke atas dua baris up.on dan tidak ada yang tercetak: event-nya terpancar sebelum ada yang mendengarkan.

Jebakan yang sama berlaku saat memancarkan event dari constructor. Library yang harus langsung memancarkan event membungkus panggilannya dengan process.nextTick, yang berjalan setelah baris on milik pemanggil (lihat halaman event loop).

Menunggu event dengan events.once

events.once(emitter, name) mengembalikan promise yang resolve dengan argumen event itu, dalam bentuk array, saat event itu dipancarkan berikutnya. Fungsi ini mengubah event sekali-jalan menjadi sesuatu yang bisa kamu await, dan promise-nya reject kalau emitter memancarkan 'error' lebih dulu.

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 menjeda sampai timer memancarkan ready, lalu array-nya di-destructure menjadi dua argumen. Untuk event yang terpancar berkali-kali, events.on(emitter, name) memberimu async iterator yang bisa kamu ulangi dengan for await.

Kesalahan umum

Memasang listener di dalam fungsi yang sering berjalan. Memanggil on di setiap request handler menumpuk listener dan memakan memori. Pasang sekali saja, atau pakai once.

Melepas fungsi yang ditulis langsung di tempat. off('data', () => ...) tidak melepas apa pun, karena arrow function itu adalah fungsi baru. Simpan referensi ke fungsi yang kamu pasang.

Mengira listener akan berjalan belakangan. emit itu synchronous, jadi listener yang lambat menahan kode yang memancarkannya. Menandai listener sebagai async tidak membantu, karena kodenya tetap berjalan di thread yang sama sampai await pertama. Pecah pekerjaan berat menjadi beberapa bagian dengan setImmediate di antaranya, atau pindahkan ke worker thread.