7、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");來訪問該模塊。
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 的監聽器。
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 參數‘);
以上例子中,emitter 為事件 someEvent 註冊了兩個事件監聽器,然後觸發了 someEvent 事件。
運行結果中可以看到兩個事件監聽器回調函數被先後調用。 這就是EventEmitter最簡單的用法。
EventEmitter 提供了多個屬性,如 on 和 emit。on 函數用於綁定事件函數,emit 屬性用於觸發一個事件。接下來我們來具體看下 EventEmitter 的屬性介紹。
###########################################################################################
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。
##########################################################################################
EventEmitter類方法
listenerCount(emitter, event)
返回指定事件的監聽器數量。
###################################################################################
EventEmitter事件
1
newListener
? event - 字符串,事件名稱
? listener - 處理事件函數
該事件在添加新監聽器時被觸發。
2
removeListener
? event - 字符串,事件名稱
? listener - 處理事件函數
從指定監聽器數組中刪除一個監聽器。需要註意的是,此操作將會改變處於被刪監聽器之後的那些監聽器的索引。
######################################################################################
實例
以下實例通過 connection(連接)事件演示了 EventEmitter 類的應用。
var events = require(‘events‘); var eventEmitter = new events.EventEmitter(); // listener #1 var listener1 = function () { console.log(‘listener1 running‘); } // listener #2 var listener2 = function () { console.log(‘listener2 running‘); } // 綁定 connecttion 事件,處理函數未listener1 eventEmitter.addListener(‘connection‘, listener1); eventEmitter.on(‘connection‘, listener2); var eventListeners = require(‘events‘).EventEmitter.listenerCount(eventEmitter, ‘connection‘); console.log(eventListeners + ‘個監聽事件‘); // 處理 connection 事件 eventEmitter.emit(‘connection‘); // 移除鑒定綁定的 listener2 函數 eventEmitter.removeListener(‘connection‘, listener2); console.log(‘listener2 不再受監聽‘); // 觸發連接事件 eventEmitter.emit(‘connection‘); eventListeners = require(‘events‘).EventEmitter.listenerCount(eventEmitter, ‘connection‘); console.log(eventListeners + ‘個監聽事件‘); console.log(‘程序執行完畢‘);
##########################################################################################
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) 我運行的時候不是這樣,,,,,,,顯示沒有error模塊沒有定義
如下:
events.js:188
throw err;
^
Error: Unhandled "error" event. (undefined)
at EventEmitter.emit (events.js:186:19)
at Object.<anonymous> (F:\nodejs_code\4_EventEmitter\error_example.js:9:9)
at Module._compile (module.js:652:30)
at Object.Module._extensions..js (module.js:663:10)
at Module.load (module.js:565:32)
at tryModuleLoad (module.js:505:12)
at Function.Module._load (module.js:497:3)
at Function.Module.runMain (module.js:693:10)
at startup (bootstrap_node.js:191:16)
at bootstrap_node.js:612:3
*/
#######################################################################################
繼承 EventEmitter
大多數時候我們不會直接使用 EventEmitter,而是在對象中繼承它。包括 fs、net、 http 在內的,只要是支持事件響應的核心模塊都是 EventEmitter 的子類。
這樣做的原因有兩點:
首先,具有某個實體功能的對象實現事件符合語義, 事件的監聽和發生應該是一個對象的方法。
其次 JavaScript 的對象機制是基於原型的,支持部分多重繼承,繼承 EventEmitter 不會打亂對象原有的繼承關系。
7、Node.js EventEmitter