Node事件循環之EventEmitter

Node.js 所有的異步 I/O 操作在完成時都會發送一個事件到事件隊列，Node.js 裡面的許多對象都會觸發分發事件：一個 net.Server 對象會在每次有新連接配接時觸發一個事件， 一個 fs.readStream 對象會在檔案被打開的時候觸發一個事件。 所有這些産生事件的對象都是 events.EventEmitter 的執行個體。

EventEmitter簡介

events 子產品隻提供了一個對象： events.EventEmitter。EventEmitter 的核心就是事件觸發與事件監聽器功能的封裝，可以通過require(“events”);來通路該子產品。例如：

// 引入 events 子產品或者使用import
var events = require('events');
// 建立 eventEmitter 對象
var eventEmitter = new      

EventEmitter 對象如果在執行個體化時發生錯誤，會觸發 error 事件;當添加新的監聽器時，newListener 事件會觸發，當監聽器被移除時，removeListener 事件被觸發。下面是一個簡單的EventEmitter 的用法：

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 支援 若幹個事件監聽器。當事件觸發時，注冊到這個事件的事件監聽器被依次調用，事件參數作為回調函數參數傳遞。例如：

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方法

• addListener(event, listener)

  為指定事件添加一個監聽器。

• on(event, listener)

  為指定事件注冊一個監聽器，接受一個字元串 event 和一個回調函數。例如下面的執行個體：

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

• once(event, listener)

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

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

• removeListener(event, listener)

  移除指定事件的某個監聽器，監聽器必須是該事件已經注冊過的監聽器，其中第一個參數表示事件名稱，第二個參數表示回調函數名稱。

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

• removeAllListeners([event])

  移除所有事件的所有監聽器， 如果指定事件，則移除指定事件的所有監聽器，接受的是一個事件數組。

• setMaxListeners(n)

  預設情況下， EventEmitters 添加的監聽器超過 10 個就會輸出警告資訊，setMaxListeners 函數用于提高監聽器的預設限制的數量。

• listeners(event)

  傳回指定事件的監聽器數組。

• emit(event, [arg1], [arg2], […])

  按參數的順序執行每個監聽器，如果事件有注冊監聽傳回 true，否則傳回 false。

類方法

• listenerCount(emitter, 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 = require('events').EventEmitter.listenerCount(eventEmitter,'connection');
console.log(eventListeners + " 個監聽器監聽連接配接事件。");

// 處理 connection 事件 
eventEmitter.emit('connection');

// 移除監綁定的 listener1 函數
eventEmitter.removeListener('connection', listener1);
console.log("listener1 不再受監聽。");

// 觸發連接配接事件
eventEmitter.emit('connection');

eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection');
console.log(eventListeners + " 個監聽器監聽連接配接事件。");

console.log("程式執行完畢。");      

執行上面的代碼：

$ node main.js
2 個監聽器監聽連接配接事件。
監聽器 listener1 執行。
監聽器 listener2 執行。
listener1 不再受監聽。
監聽器 listener2 執行。
1      

error 事件

EventEmitter 定義了一個特殊的事件 error，它包含了錯誤的語義，我們在遇到 異常的時候通常會觸發 error 事件。當 error 被觸發時，EventEmitter 規定如果沒有響 應的監聽器，Node.js 會把它當作異常，退出程式并輸出錯誤資訊。例如：

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)      

總結