Node.js EventEmitter

Node.js のすべての非同期 I/O 操作は完了時にイベントをイベントキューに送信します。

Node.js 内の多くのオブジェクトはイベントを配信します。net.Server オブジェクトは新しい接続があるたびにイベントをトリガーし、fs.readStream オブジェクトはファイルが開かれたときにイベントをトリガーします。これらのイベントを生成するオブジェクトはすべて events.EventEmitter のインスタンスです。

EventEmitter は、Node.js でイベントを作成、登録、トリガーするためのコアモジュールです。

EventEmitter はイベント駆動型プログラミングの基礎であり、開発者がイベントのパブリッシュ/サブスクライブ機構を簡単に実装するのに役立ちます。

EventEmitter クラス

events モジュールは events.EventEmitter という 1 つのオブジェクトのみを提供します。

EventEmitter の核心は、イベントトリガーとイベントリスナー機能のカプセル化です。

次のようにしてrequire("events");このモジュールにアクセスできます。

EventEmitter オブジェクトは、インスタンス化中にエラーが発生すると error イベントをトリガーします。新しいリスナーが追加されると newListener イベントがトリガーされ、リスナーが削除されると removeListener イベントがトリガーされます。

次に、簡単な例で EventEmitter の使い方を説明します。

このコードを実行すると、1 秒後にコンソールに次のように出力されます。some_event イベントがトリガーされましたその原理は、event オブジェクトが some_event イベントのリスナーを登録し、setTimeout を使用して 1000 ミリ秒後に event オブジェクトへ some_event イベントを送信すると、some_event のリスナーが呼び出されるというものです。

実行結果は次のとおりです。

$ node event.js 
some_event 事件触发

EventEmitter の各イベントは、イベント名と複数のパラメーターで構成されます。イベント名は文字列で、通常は特定の意味を表します。EventEmitter は各イベントに対して複数のイベントリスナーをサポートしています。

イベントがトリガーされると、そのイベントに登録されたイベントリスナーが順番に呼び出され、イベントパラメーターがコールバック関数の引数として渡されます。

このプロセスを次の例で説明します。

上記のコードを実行すると、結果は次のようになります。

$ node event.js 
listener1 arg1 参数 arg2 参数
listener2 arg1 参数 arg2 参数

上記の例では、emitter は someEvent イベントに 2 つのイベントリスナーを登録し、その後 someEvent イベントをトリガーしました。

実行結果では、2 つのイベントリスナーのコールバック関数が順番に呼び出されていることがわかります。これが EventEmitter の最も簡単な使い方です。

EventEmitter には複数のプロパティがあります。たとえば、onとemit。on関数はイベント関数をバインドするために使用され、emitプロパティはイベントをトリガーするために使用されます。次に、EventEmitter のプロパティの説明を詳しく見ていきましょう。

メソッド

server.on('connection', function (stream) {
  console.log('someone connected!');
});

server.once('connection', function (stream) {
  console.log('Ah, we have our first user!');
});

var callback = function(stream) {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

クラスメソッド

events.EventEmitter.listenerCount(emitter, eventName) //已废弃，不推荐
events.emitter.listenerCount(eventName) //推荐

イベントリスナーを登録します:

出力：

Hello, Alice!

once() を使用して 1 回限りのイベントを登録します:

myEmitter.once('init', () => {
  console.log('Initialization event occurred');
});

myEmitter.emit('init'); // 打印: Initialization event occurred
myEmitter.emit('init'); // 不会再触发

イベントトリガー時にパラメーターを渡して、リスナーで使用できます:

トリガーされたイベントに対応するリスナーがない場合、EventEmitter はエラーをスローします:

イベント

インスタンス

次の例では、connection（接続）イベントを通じて EventEmitter クラスのアプリケーションを示します。

main.js ファイルを作成し、コードは次のとおりです。

上記のコードの実行結果は次のとおりです。

$ node main.js
2 个监听器监听连接事件。
监听器 listener1 执行。
监听器 listener2 执行。
listener1 不再受监听。
监听器 listener2 执行。
1 个监听器监听连接事件。
程序执行完毕。

error イベント

EventEmitter は特別なイベント error を定義しています。これはエラーの意味を含み、例外が発生したときには通常 error イベントをトリガーします。

error がトリガーされたとき、EventEmitter は対応するリスナーがない場合、Node.js はそれを例外として扱い、プログラムを終了してエラーメッセージを出力すると規定しています。

error イベントをトリガーする可能性のあるオブジェクトには、エラーが発生した後にプログラム全体がクラッシュしないように、通常リスナーを設定します。例：

var events = require('events'); 
var emitter = new events.EventEmitter(); 
emitter.emit('error'); 

実行時に次のエラーが表示されます：

node.js:201 
throw e; // process.nextTick error, or 'error' event on first tick 
^ 
Error: Uncaught, unspecified 'error' event. 
at EventEmitter.emit (events.js:50:15) 
at Object.<anonymous> (/home/byvoid/error.js:5:9) 
at Module._compile (module.js:441:26) 
at Object..js (module.js:459:10) 
at Module.load (module.js:348:31) 
at Function._load (module.js:308:12) 
at Array.0 (module.js:479:10) 
at EventEmitter._tickCallback (node.js:192:40) 

EventEmitter を継承する

ほとんどの場合、EventEmitter を直接使用するのではなく、オブジェクト内でそれを継承します。fs、net、http を含め、イベント応答をサポートするコアモジュールはすべて EventEmitter のサブクラスです。

なぜそうするのでしょうか？理由は 2 つあります：

• 第一に、何らかの実体機能を持つオブジェクトがイベントを実装するのは意味論に適合し、イベントの監視と発生はオブジェクトのメソッドであるべきです。

• 第二に、JavaScript のオブジェクト機構はプロトタイプベースであり、部分的な多重継承をサポートしています。EventEmitter を継承しても、オブジェクトの既存の継承関係が崩れることはありません。

ほとんどの Node.js コアモジュール（HTTP、ファイルシステムなど）は EventEmitter を継承しています。独自のクラスを作成して EventEmitter を継承できます。