Node.js EventEmitterの使い方：on、emit、onceと独自イベント

EventEmitter はNode.jsの events モジュールにあるクラスで、オブジェクトが名前付きのイベントを発行できるようにします。emitter.on('name', fn) でリスナーを登録し、emitter.emit('name', ...args) で発火させます。その名前のリスナーがすべて、追加した順に、渡した引数で実行されます。HTTPサーバー、ストリーム、process はどれもEventEmitterなので、同じいくつかのメソッドがNode.jsのどこでも使えます。

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

2つのリスナーはどちらも before emit と after emit の間で実行されます。emit はリスナーを同期的に呼び、それが終わってから戻るからです。2つの shop.on の呼び出しを入れ替えると、真ん中の2行も入れ替わります。

on、once、off

on は削除するまでリスナーを残し、once は最初の呼び出しの後で削除し、off（removeListener と同じ）は1つを削除します。リスナーを削除するには追加したときと同じ関数が必要なので、アロー関数をその場で渡さずに名前を付けておきましょう。

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 はAdaの後に1回だけ表示されます。logOpen を削除すると誰も聞いていないので、最後の emit は false を返します。door.removeAllListeners('open') を使えば、両方のリスナーを1回で消せました。

errorイベント

'error' は特別です。誰も聞いていないのに発行すると、emit はそのエラーを投げます。実際のプログラムでは、捕まえられなかった例外はプロセスをクラッシュさせます。ストリームやサーバーのように失敗しうるEmitterには、必ず 'error' のリスナーを追加しましょう。

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

リスナーがないと emit が例外を投げ、catch がそれを受け取ります。リスナーを追加すると、同じ emit はリスナーを呼ぶだけで、プログラムはそのまま続きます。ほかのイベント名なら、リスナーがなくても黙って無視されます。

自作のクラスでEventEmitterを継承する

いちばんよくある使い方は、自分のクラスで EventEmitter を継承し、コンストラクタで super() を呼び、何か起きたら this.emit することです。呼び出す側は、Node.jsのほかのオブジェクトと同じようにあなたのオブジェクトを購読できます。

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

25%、50%、75%、100%、続いて photo.png uploaded が表示されます。up.start() を2つの up.on の行より上に移すと、何も表示されません。誰かが聞き始める前にイベントが発行されてしまうからです。

コンストラクタの中から発行するときも同じ落とし穴があります。すぐに発行しなければならないライブラリは、その呼び出しを process.nextTick で包みます。これは呼び出し側の on の行より後に実行されます（イベントループのページを参照）。

events.onceでイベントを待つ

events.once(emitter, name) は、次にイベントが発行されたときにその引数を配列にして解決するPromiseを返します。一度きりのイベントを await できる形に変え、先に 'error' が発行された場合はrejectします。

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 はタイマーが ready を発行するまで止まり、その後で配列が2つの引数に分割代入されます。何度も発行されるイベントなら、events.on(emitter, name) が for await で回せる非同期イテレーターを返します。

よくある間違い

頻繁に実行される関数の中でリスナーを追加する。 リクエストハンドラーのたびに on を呼ぶと、リスナーとメモリが積み上がります。追加は1回にするか、once を使いましょう。

その場で書いた関数を削除しようとする。 off('data', () => ...) は何も削除しません。そのアロー関数は新しく作られた別の関数だからです。追加した関数への参照を持っておきましょう。

リスナーが後で実行されると思う。 emit は同期的なので、遅いリスナーは発行した側のコードを止めます。リスナーを async にしても解決しません。最初の await までは、そのコードは同じスレッドで動くからです。重い処理は間に setImmediate を挟んで小分けにするか、ワーカースレッドに移しましょう。