Node.js 教程
Node.js 所有的異步 I/O 操作在完成時都會發(fā)送一個事件到事件隊列。
Node.js 里面的許多對象都會分發(fā)事件:一個 net.Server 對象會在每次有新連接時觸發(fā)一個事件, 一個 fs.readStream 對象會在文件被打開的時候觸發(fā)一個事件。 所有這些產生事件的對象都是 events.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í)行結果如下:
運行這段代碼,1 秒后控制臺輸出了 'some_event 事件觸發(fā)'。其原理是 event 對象注冊了事件 some_event 的一個監(jiān)聽器,然后我們通過 setTimeout 在 1000 毫秒以后向 event 對象發(fā)送事件 some_event,此時會調用some_event 的監(jiān)聽器。
$ node event.js some_event 事件觸發(fā)
EventEmitter 的每個事件由一個事件名和若干個參數(shù)組成,事件名是一個字符串,通常表達一定的語義。對于每個事件,EventEmitter 支持 若干個事件監(jiān)聽器。
當事件觸發(fā)時,注冊到這個事件的事件監(jiān)聽器被依次調用,事件參數(shù)作為回調函數(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í)行以上代碼,運行的結果如下:
$ node event.js listener1 arg1 參數(shù) arg2 參數(shù) listener2 arg1 參數(shù) arg2 參數(shù)
以上例子中,emitter 為事件 someEvent 注冊了兩個事件監(jiān)聽器,然后觸發(fā)了 someEvent 事件。
運行結果中可以看到兩個事件監(jiān)聽器回調函數(shù)被先后調用。 這就是EventEmitter最簡單的用法。
EventEmitter 提供了多個屬性,如 on 和 emit。on 函數(shù)用于綁定事件函數(shù),emit 屬性用于觸發(fā)一個事件。接下來我們來具體看下 EventEmitter 的屬性介紹。
序號 | 方法 & 描述 |
---|---|
1 | addListener(event, listener) 為指定事件添加一個監(jiān)聽器到監(jiān)聽器數(shù)組的尾部。 |
2 | on(event, listener) 為指定事件注冊一個監(jiān)聽器,接受一個字符串 event 和一個回調函數(shù)。 server.on('connection', function (stream) { console.log('someone connected!'); }); |
3 | once(event, listener) 為指定事件注冊一個單次監(jiān)聽器,即 監(jiān)聽器最多只會觸發(fā)一次,觸發(fā)后立刻解除該監(jiān)聽器。 server.once('connection', function (stream) { console.log('Ah, we have our first user!'); }); |
4 | removeListener(event, listener) 移除指定事件的某個監(jiān)聽器,監(jiān)聽器必須是該事件已經注冊過的監(jiān)聽器。 它接受兩個參數(shù),第一個是事件名稱,第二個是回調函數(shù)名稱。 var callback = function(stream) { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback); |
5 | removeAllListeners([event]) 移除所有事件的所有監(jiān)聽器, 如果指定事件,則移除指定事件的所有監(jiān)聽器。 |
6 | setMaxListeners(n) 默認情況下, EventEmitters 如果你添加的監(jiān)聽器超過 10 個就會輸出警告信息。 setMaxListeners 函數(shù)用于提高監(jiān)聽器的默認限制的數(shù)量。 |
7 | listeners(event) 返回指定事件的監(jiān)聽器數(shù)組。 |
8 | emit(event, [arg1], [arg2], [...]) 按監(jiān)聽器的順序執(zhí)行執(zhí)行每個監(jiān)聽器,如果事件有注冊監(jiān)聽返回 true,否則返回 false。 |
序號 | 方法 & 描述 |
---|---|
1 | listenerCount(emitter, event) 返回指定事件的監(jiān)聽器數(shù)量。 |
events.EventEmitter.listenerCount(emitter, eventName) //已廢棄,不推薦 events.emitter.listenerCount(eventName) //推薦
序號 | 事件 & 描述 |
---|---|
1 | newListener
該事件在添加新監(jiān)聽器時被觸發(fā)。 |
2 | removeListener
從指定監(jiān)聽器數(shù)組中刪除一個監(jiān)聽器。需要注意的是,此操作將會改變處于被刪監(jiān)聽器之后的那些監(jiān)聽器的索引。 |
以下實例通過 connection(連接)事件演示了 EventEmitter 類的應用。
創(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 = eventEmitter.listenerCount('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 = eventEmitter.listenerCount('connection'); console.log(eventListeners + " 個監(jiān)聽器監(jiān)聽連接事件。"); console.log("程序執(zhí)行完畢。");
以上代碼,執(zhí)行結果如下所示:
$ node main.js 2 個監(jiān)聽器監(jiān)聽連接事件。 監(jiān)聽器 listener1 執(zhí)行。 監(jiān)聽器 listener2 執(zhí)行。 listener1 不再受監(jiān)聽。 監(jiān)聽器 listener2 執(zhí)行。 1 個監(jiān)聽器監(jiān)聽連接事件。 程序執(zhí)行完畢。
EventEmitter 定義了一個特殊的事件 error,它包含了錯誤的語義,我們在遇到 異常的時候通常會觸發(fā) error 事件。
當 error 被觸發(fā)時,EventEmitter 規(guī)定如果沒有響 應的監(jiān)聽器,Node.js 會把它當作異常,退出程序并輸出錯誤信息。
我們一般要為會觸發(fā) error 事件的對象設置監(jiān)聽器,避免遇到錯誤后整個程序崩潰。例如:
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)
大多數(shù)時候我們不會直接使用 EventEmitter,而是在對象中繼承它。包括 fs、net、 http 在內的,只要是支持事件響應的核心模塊都是 EventEmitter 的子類。
為什么要這樣做呢?原因有兩點:
首先,具有某個實體功能的對象實現(xiàn)事件符合語義, 事件的監(jiān)聽和發(fā)生應該是一個對象的方法。
其次 JavaScript 的對象機制是基于原型的,支持 部分多重繼承,繼承 EventEmitter 不會打亂對象原有的繼承關系。