Node.js EventEmitter

Node.js 所有的異步 I/O 操作在完成時(shí)都會(huì)發(fā)送一個(gè)事件到事件隊(duì)列。

Node.js 里面的許多對(duì)象都會(huì)分發(fā)事件：一個(gè)net.Server對(duì)象會(huì)在每次有新連接時(shí)分發(fā)一個(gè)事件， 一個(gè)fs.readStream對(duì)象會(huì)在文件被打開(kāi)的時(shí)候發(fā)出一個(gè)事件。 所有這些產(chǎn)生事件的對(duì)象都是 events.EventEmitter 的實(shí)例。 

EventEmitter 類(lèi)

events 模塊只提供了一個(gè)對(duì)象： events.EventEmitter。EventEmitter 的核心就是事件觸發(fā)與事件監(jiān)聽(tīng)器功能的封裝。

你可以通過(guò)require("events");來(lái)訪問(wèn)該模塊。

// 引入 events 模塊
var events = require('events');
// 創(chuàng)建 eventEmitter 對(duì)象
var eventEmitter = new events.EventEmitter();

EventEmitter 對(duì)象如果在實(shí)例化時(shí)發(fā)生錯(cuò)誤，會(huì)觸發(fā) error 事件。當(dāng)添加新的監(jiān)聽(tīng)器時(shí)，newListener 事件會(huì)觸發(fā)，當(dāng)監(jiān)聽(tīng)器被移除時(shí)，removeListener 事件被觸發(fā)。

下面我們用一個(gè)簡(jiǎn)單的例子說(shuō)明 EventEmitter 的用法：

//event.js 文件
var EventEmitter = require('events').EventEmitter; 
var event = new EventEmitter(); 
event.on('some_event', function() { 
    console.log('some_event 事件觸發(fā)'); 
}); 
setTimeout(function() { 
    event.emit('some_event'); 
}, 1000); 

執(zhí)行結(jié)果如下：

運(yùn)行這段代碼，1 秒后控制臺(tái)輸出了 'some_event 事件觸發(fā)'。其原理是 event 對(duì)象注冊(cè)了事件 some_event 的一個(gè)監(jiān)聽(tīng)器，然后我們通過(guò) setTimeout 在 1000 毫秒以后向 event 對(duì)象發(fā)送事件 some_event，此時(shí)會(huì)調(diào)用some_event 的監(jiān)聽(tīng)器。

$ node event.js 
some_event 事件觸發(fā)

EventEmitter 的每個(gè)事件由一個(gè)事件名和若干個(gè)參數(shù)組成，事件名是一個(gè)字符串，通常表達(dá)一定的語(yǔ)義。對(duì)于每個(gè)事件，EventEmitter 支持 若干個(gè)事件監(jiān)聽(tīng)器。

當(dāng)事件觸發(fā)時(shí)，注冊(cè)到這個(gè)事件的事件監(jiān)聽(tīng)器被依次調(diào)用，事件參數(shù)作為回調(diào)函數(shù)參數(shù)傳遞。

讓我們以下面的例子解釋這個(gè)過(guò)程：

//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 參數(shù)', 'arg2 參數(shù)'); 

執(zhí)行以上代碼，運(yùn)行的結(jié)果如下：

$ node event.js 
listener1 arg1 參數(shù) arg2 參數(shù)
listener2 arg1 參數(shù) arg2 參數(shù)

以上例子中，emitter 為事件 someEvent 注冊(cè)了兩個(gè)事件監(jiān)聽(tīng)器，然后觸發(fā)了 someEvent 事件。

運(yùn)行結(jié)果中可以看到兩個(gè)事件監(jiān)聽(tīng)器回調(diào)函數(shù)被先后調(diào)用。 這就是EventEmitter最簡(jiǎn)單的用法。

EventEmitter 提供了多個(gè)屬性，如 on 和 emit。on 函數(shù)用于綁定事件函數(shù)，emit 屬性用于觸發(fā)一個(gè)事件。接下來(lái)我們來(lái)具體看下 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);

類(lèi)方法

events.EventEmitter.listenerCount(emitter, eventName) //已廢棄，不推薦
events.emitter.listenerCount(eventName) //推薦

事件

實(shí)例

以下實(shí)例通過(guò) connection（連接）事件演示了 EventEmitter 類(lèi)的應(yīng)用。

創(chuàng)建 main.js 文件，代碼如下：

var events = require('events');
var eventEmitter = new events.EventEmitter();

// 監(jiān)聽(tīng)器 #1
var listener1 = function listener1() {
   console.log('監(jiān)聽(tīng)器 listener1 執(zhí)行。');
}

// 監(jiān)聽(tīng)器 #2
var listener2 = function listener2() {
  console.log('監(jiān)聽(tīng)器 listener2 執(zhí)行。');
}

// 綁定 connection 事件，處理函數(shù)為 listener1 
eventEmitter.addListener('connection', listener1);

// 綁定 connection 事件，處理函數(shù)為 listener2
eventEmitter.on('connection', listener2);

var eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + " 個(gè)監(jiān)聽(tīng)器監(jiān)聽(tīng)連接事件。");

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

// 移除監(jiān)綁定的 listener1 函數(shù)
eventEmitter.removeListener('connection', listener1);
console.log("listener1 不再受監(jiān)聽(tīng)。");

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

eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + " 個(gè)監(jiān)聽(tīng)器監(jiān)聽(tīng)連接事件。");

console.log("程序執(zhí)行完畢。");

以上代碼，執(zhí)行結(jié)果如下所示：

$ node main.js
2 個(gè)監(jiān)聽(tīng)器監(jiān)聽(tīng)連接事件。
監(jiān)聽(tīng)器 listener1 執(zhí)行。
監(jiān)聽(tīng)器 listener2 執(zhí)行。
listener1 不再受監(jiān)聽(tīng)。
監(jiān)聽(tīng)器 listener2 執(zhí)行。
1 個(gè)監(jiān)聽(tīng)器監(jiān)聽(tīng)連接事件。
程序執(zhí)行完畢。

error 事件

EventEmitter 定義了一個(gè)特殊的事件 error，它包含了錯(cuò)誤的語(yǔ)義，我們?cè)谟龅?異常的時(shí)候通常會(huì)觸發(fā) error 事件。

當(dāng) error 被觸發(fā)時(shí)，EventEmitter 規(guī)定如果沒(méi)有響 應(yīng)的監(jiān)聽(tīng)器，Node.js 會(huì)把它當(dāng)作異常，退出程序并輸出錯(cuò)誤信息。

我們一般要為會(huì)觸發(fā) error 事件的對(duì)象設(shè)置監(jiān)聽(tīng)器，避免遇到錯(cuò)誤后整個(gè)程序崩潰。例如：

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

運(yùn)行時(shí)會(huì)顯示以下錯(cuò)誤：

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

大多數(shù)時(shí)候我們不會(huì)直接使用 EventEmitter，而是在對(duì)象中繼承它。包括 fs、net、 http 在內(nèi)的，只要是支持事件響應(yīng)的核心模塊都是 EventEmitter 的子類(lèi)。

為什么要這樣做呢？原因有兩點(diǎn)：

首先，具有某個(gè)實(shí)體功能的對(duì)象實(shí)現(xiàn)事件符合語(yǔ)義， 事件的監(jiān)聽(tīng)和發(fā)生應(yīng)該是一個(gè)對(duì)象的方法。

其次 JavaScript 的對(duì)象機(jī)制是基于原型的，支持 部分多重繼承，繼承 EventEmitter 不會(huì)打亂對(duì)象原有的繼承關(guān)系。