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 的屬性介紹。

 addListener(event, listener)

為指定事件添加一個監聽器到監聽器數組的尾部。

on(event, listener)

為指定事件注冊一個監聽器，接受一個字元串 event 和一個回調函數。

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

addListener和on是一樣的，都是注冊監聽器

 once(event, listener)

為指定事件注冊一個單次監聽器，即 監聽器最多隻會觸發一次，觸發後立刻解除該監聽器。

removeListener(event, listener)

移除指定事件的某個監聽器，監聽器必須是該事件已經注冊過的監聽器。

它接受兩個參數，第一個是事件名稱，第二個是回調函數名稱。

removeAllListeners([event])

移除所有事件的所有監聽器， 如果指定事件，則移除指定事件的所有監聽器。

執行個體

以下執行個體通過 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 個監聽器監聽連接配接事件。
程式執行完畢。
      

繼承 EventEmitter

大多數時候我們不會直接使用 EventEmitter，而是在對象中繼承它。包括 fs、net、 http 在内的，隻要是支援事件響應的核心子產品都是 EventEmitter 的子類。

1、eventEmitter.on()與eventEmitter.addListener()沒有差別，且一個事件可以綁定多個回調函數；

2、若事件隊列中出現一個未綁定事件則觸發error事件，若未綁定 error事件則程式抛出異常結束執行

 摘自：

http://www.runoob.com/nodejs/nodejs-event.html