Node.js EventEmitter
Node.js 所有的異步 I/O 操作在完成時都會發(fā)送一個事件到事件隊列。
Node.js里面的許多對象都會分發(fā)事件:一個net.Server對象會在每次有新連接時分發(fā)一個事件, 一個fs.readStream對象會在文件被打開的時候發(fā)出一個事件痴鳄。 所有這些產(chǎn)生事件的對象都是 events.EventEmitter 的實例妈嘹。
EventEmitter 類
events 模塊只提供了一個對象: events.EventEmitter初嘹。EventEmitter 的核心就是事件觸發(fā)與事件監(jiān)聽器功能的封裝刨晴。
你可以通過require("events");來訪問該模塊。
// 引入 events 模塊
var events = require('events');
// 創(chuàng)建 eventEmitter 對象
var eventEmitter = new events.EventEmitter();
EventEmitter 對象如果在實例化時發(fā)生錯誤蓬抄,會觸發(fā) error 事件。當添加新的監(jiān)聽器時夯到,newListener 事件會觸發(fā)嚷缭,當監(jiān)聽器被移除時,removeListener 事件被觸發(fā)耍贾。
下面我們用一個簡單的例子說明 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é)果如下:
運行這段代碼阅爽,1 秒后控制臺輸出了 'some_event 事件觸發(fā)'。其原理是 event 對象注冊了事件 some_event 的一個監(jiān)聽器荐开,然后我們通過 setTimeout 在 1000 毫秒以后向 event 對象發(fā)送事件 some_event付翁,此時會調(diào)用some_event 的監(jiān)聽器。
EventEmitter 的每個事件由一個事件名和若干個參數(shù)組成晃听,事件名是一個字符串百侧,通常表達一定的語義。對于每個事件能扒,EventEmitter 支持 若干個事件監(jiān)聽器佣渴。
當事件觸發(fā)時,注冊到這個事件的事件監(jiān)聽器被依次調(diào)用初斑,事件參數(shù)作為回調(diào)函數(shù)參數(shù)傳遞辛润。
讓我們以下面的例子解釋這個過程:
//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í)行以上代碼,運行的結(jié)果如下:
以上例子中见秤,emitter 為事件 someEvent 注冊了兩個事件監(jiān)聽器频蛔,然后觸發(fā)了 someEvent 事件。
運行結(jié)果中可以看到兩個事件監(jiān)聽器回調(diào)函數(shù)被先后調(diào)用秦叛。 這就是EventEmitter最簡單的用法晦溪。
EventEmitter 提供了多個屬性,如 on 和 emit挣跋。on 函數(shù)用于綁定事件函數(shù)三圆,emit 屬性用于觸發(fā)一個事件。接下來我們來具體看下 EventEmitter 的屬性介紹。
方法
<li>addListener(event, listener) 為指定事件添加一個監(jiān)聽器到監(jiān)聽器數(shù)組的尾部舟肉。
<li>on(event, listener)為指定事件注冊一個監(jiān)聽器修噪,接受一個字符串 event 和一個回調(diào)函數(shù)。
<li>once(event, listener)為指定事件注冊一個單次監(jiān)聽器路媚,即 監(jiān)聽器最多只會觸發(fā)一次黄琼,觸發(fā)后立刻解除該監(jiān)聽器。
<li>removeListener(event, listener)移除指定事件的某個監(jiān)聽器整慎,監(jiān)聽器必須是該事件已經(jīng)注冊過的監(jiān)聽器脏款。它接受兩個參數(shù),第一個是事件名稱裤园,第二個是回調(diào)函數(shù)名稱撤师。
<li>removeAllListeners([event])移除所有事件的所有監(jiān)聽器, 如果指定事件拧揽,則移除指定事件的所有監(jiān)聽器剃盾。
<li>setMaxListeners(n)默認情況下, EventEmitters 如果你添加的監(jiān)聽器超過 10 個就會輸出警告信息淤袜。 setMaxListeners 函數(shù)用于提高監(jiān)聽器的默認限制的數(shù)量痒谴。
<li>listeners(event)返回指定事件的監(jiān)聽器數(shù)組。
<li>emit(event, [arg1], [arg2], [...])按參數(shù)的順序執(zhí)行每個監(jiān)聽器铡羡,如果事件有注冊監(jiān)聽返回 true闰歪,否則返回 false。
類方法
listenerCount(emitter, event)返回指定事件的監(jiān)聽器數(shù)量蓖墅。
事件
<li>newListener(event,listener) 該事件在添加新監(jiān)聽器時被觸發(fā)库倘。
<li>removeListener(event,listener)從指定監(jiān)聽器數(shù)組中刪除一個監(jiān)聽器。需要注意的是论矾,此操作將會改變處于被刪監(jiān)聽器之后的那些監(jiān)聽器的索引教翩。
實例
以下實例通過 connection(連接)事件演示了 EventEmitter 類的應(yīng)用。
創(chuàng)建 main.js 文件贪壳,代碼如下:
var events = require('events');
var eventEmitter = new events.EventEmitter();
// 監(jiān)聽器 #1
var listener1 = function listener1() {
console.log('監(jiān)聽器 listener1 執(zhí)行饱亿。');
}
// 監(jiān)聽器 #2
var listener2 = function listener2() {
console.log('監(jiān)聽器 listener2 執(zhí)行。');
}
// 綁定 connection 事件闰靴,處理函數(shù)為 listener1
eventEmitter.addListener('connection', listener1);
// 綁定 connection 事件彪笼,處理函數(shù)為 listener2
eventEmitter.on('connection', listener2);
var eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection');
console.log(eventListeners + " 個監(jiān)聽器監(jiān)聽連接事件。");
// 處理 connection 事件
eventEmitter.emit('connection');
// 移除監(jiān)綁定的 listener1 函數(shù)
eventEmitter.removeListener('connection', listener1);
console.log("listener1 不再受監(jiān)聽蚂且。");
// 觸發(fā)連接事件
eventEmitter.emit('connection');
eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection');
console.log(eventListeners + " 個監(jiān)聽器監(jiān)聽連接事件配猫。");
console.log("程序執(zhí)行完畢。");
以上代碼杏死,執(zhí)行結(jié)果如下所示
error 事件
EventEmitter 定義了一個特殊的事件 error泵肄,它包含了錯誤的語義捆交,我們在遇到 異常的時候通常會觸發(fā) error 事件。
當 error 被觸發(fā)時腐巢,EventEmitter 規(guī)定如果沒有響 應(yīng)的監(jiān)聽器品追,Node.js 會把它當作異常,退出程序并輸出錯誤信息冯丙。
我們一般要為會觸發(fā) error 事件的對象設(shè)置監(jiān)聽器肉瓦,避免遇到錯誤后整個程序崩潰。例如:
var events = require('events');
var emitter = new events.EventEmitter();
emitter.emit('error');
運行時會顯示以下錯誤:
繼承 EventEmitter
大多數(shù)時候我們不會直接使用 EventEmitter胃惜,而是在對象中繼承它泞莉。包括 fs、net蛹疯、 http 在內(nèi)的,只要是支持事件響應(yīng)的核心模塊都是 EventEmitter 的子類热监。
為什么要這樣做呢捺弦?原因有兩點:
首先,具有某個實體功能的對象實現(xiàn)事件符合語義孝扛, 事件的監(jiān)聽和發(fā)射應(yīng)該是一個對象的方法列吼。
其次 JavaScript 的對象機制是基于原型的,支持 部分多重繼承苦始,繼承 EventEmitter 不會打亂對象原有的繼承關(guān)系寞钥。