Node.js EventEmitter
Node.js EventEmitter
Node.js 所有的非同步 I/O 操作在完成時都會發送一個事件到事件佇列。
Node.js 裡面的許多物件都會分發事件：一個 net.Server 物件會在每次有新連線時觸發一個事件， 一個 fs.readStream 物件會在檔案被開啟的時候觸發一個事件。 所有這些產生事件的物件都是 events.EventEmitter 的例項。
EventEmitter 類
events 模組只提供了一個物件： events.EventEmitter。EventEmitter 的核心就是事件觸發與事件監聽器功能的封裝。
你可以通過require("events");來訪問該模組。
// 引入 events 模組
var events = require('events');
// 建立 eventEmitter 物件
var eventEmitter = new events.EventEmitter();
EventEmitter 物件如果在例項化時發生錯誤，會觸發 error 事件。當新增新的監聽器時，newListener 事件會觸發，當監聽器被移除時，removeListener 事件被觸發。
下面我們用一個簡單的例子說明 EventEmitter 的用法：
//event.js 檔案
var EventEmitter = require('events').EventEmitter;
var event = new EventEmitter();
event.on('some_event', function() {
console.log('some_event 事件觸發');
});
setTimeout(function() {
event.emit('some_event');
}, 1000);
執行結果如下：
執行這段程式碼，1 秒後控制檯輸出了 'some_event 事件觸發'。其原理是 event 物件註冊了事件 some_event 的一個監聽器，然後我們通過 setTimeout 在 1000 毫秒以後向 event 物件傳送事件 some_event，此時會呼叫some_event 的監聽器。
$ node event.js some_event 事件觸發
EventEmitter 的每個事件由一個事件名和若干個引數組成，事件名是一個字串，通常表達一定的語義。對於每個事件，EventEmitter 支援 若干個事件監聽器。
當事件觸發時，註冊到這個事件的事件監聽器被依次呼叫，事件引數作為回撥函式引數傳遞。
讓我們以下面的例子解釋這個過程：
//event.js 檔案
var events = require('events');
var emitter = new events.EventEmitter();
emitter.on('someEvent', function(arg1, arg2) {
console.log('listener1', arg1, arg2);
});
emitter.on('someEvent', function(arg1, arg2) {
console.log('listener2', arg1, arg2);
});
emitter.emit('someEvent', 'arg1 引數', 'arg2 引數');
執行以上程式碼，執行的結果如下：
$ node event.js listener1 arg1 引數 arg2 引數 listener2 arg1 引數 arg2 引數
以上例子中，emitter 為事件 someEvent 註冊了兩個事件監聽器，然後觸發了 someEvent 事件。
執行結果中可以看到兩個事件監聽器回撥函式被先後呼叫。 這就是EventEmitter最簡單的用法。
EventEmitter 提供了多個屬性，如 on 和 emit。on 函式用於繫結事件函式，emit 屬性用於觸發一個事件。接下來我們來具體看下 EventEmitter 的屬性介紹。
方法
| 序號 | 方法 & 描述 |
|---|---|
| 1 | addListener(event, listener) 為指定事件新增一個監聽器到監聽器陣列的尾部。 |
| 2 | on(event, listener) 為指定事件註冊一個監聽器，接受一個字串 event 和一個回撥函式。
server.on('connection', function (stream) {
console.log('someone connected!');
});
|
| 3 | once(event, listener) 為指定事件註冊一個單次監聽器，即 監聽器最多隻會觸發一次，觸發後立刻解除該監聽器。
server.once('connection', function (stream) {
console.log('Ah, we have our first user!');
});
|
| 4 | removeListener(event, listener) 移除指定事件的某個監聽器，監聽器必須是該事件已經註冊過的監聽器。 它接受兩個引數，第一個是事件名稱，第二個是回撥函式名稱。
var callback = function(stream) {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
|
| 5 | removeAllListeners([event]) 移除所有事件的所有監聽器， 如果指定事件，則移除指定事件的所有監聽器。 |
| 6 | setMaxListeners(n) 預設情況下， EventEmitters 如果你新增的監聽器超過 10 個就會輸出警告資訊。 setMaxListeners 函式用於改變監聽器的預設限制的數量。 |
| 7 | listeners(event) 返回指定事件的監聽器陣列。 |
| 8 | emit(event, [arg1], [arg2], [...]) 按監聽器的順序執行執行每個監聽器，如果事件有註冊監聽返回 true，否則返回 false。 |
類方法
| 序號 | 方法 & 描述 |
|---|---|
| 1 | listenerCount(emitter, event) 返回指定事件的監聽器數量。 |
events.EventEmitter.listenerCount(emitter, eventName) //已廢棄，不推薦 events.emitter.listenerCount(eventName) //推薦
事件
| 序號 | 事件 & 描述 |
|---|---|
| 1 | newListener
該事件在新增新監聽器時被觸發。 |
| 2 | removeListener
從指定監聽器陣列中刪除一個監聽器。需要注意的是，此操作將會改變處於被刪監聽器之後的那些監聽器的索引。 |
例項
以下例項通過 connection（連線）事件演示了 EventEmitter 類的應用。
建立 main.js 檔案，程式碼如下：
var events = require('events');
var eventEmitter = new events.EventEmitter();
// 監聽器 #1
var listener1 = function listener1() {
console.log('監聽器 listener1 執行。');
}
// 監聽器 #2
var listener2 = function listener2() {
console.log('監聽器 listener2 執行。');
}
// 繫結 connection 事件，處理函式為 listener1
eventEmitter.addListener('connection', listener1);
// 繫結 connection 事件，處理函式為 listener2
eventEmitter.on('connection', listener2);
var eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + " 個監聽器監聽連線事件。");
// 處理 connection 事件
eventEmitter.emit('connection');
// 移除監繫結的 listener1 函式
eventEmitter.removeListener('connection', listener1);
console.log("listener1 不再受監聽。");
// 觸發連線事件
eventEmitter.emit('connection');
eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + " 個監聽器監聽連線事件。");
console.log("程式執行完畢。");
以上程式碼，執行結果如下所示：
$ 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 的子類。
為什麼要這樣做呢？原因有兩點：
首先，具有某個實體功能的物件實現事件符合語義， 事件的監聽和發生應該是一個物件的方法。
其次 JavaScript 的物件機制是基於原型的，支援 部分多重繼承，繼承 EventEmitter 不會打亂物件原有的繼承關係。