events 模塊只提供了一個對象: events.EventEmitter。EventEmitter 的核心就是事件觸發與事件監聽器功能的封裝。
可以通過require("events");來訪問該模塊。
var EventEmitter=require('events').EventEmitter;
var event=new EventEmitter();
event.on('event_one',function(){
console.log('event_one 事件觸發');
});
//定時執行 觸發事件
setTimeout(function(){event.emit('event_one');},1000);
event 對象註冊了事件 event_one 的一個監聽器,然後我們通過 setTimeout 在 1000 毫秒以後向 event 對象發送事件 event_one ,此時會調用some_event 的監聽器。
<span style="font-family: 'Microsoft Yahei', 'Helvetica Neue', Helvetica, Arial, sans-serif; background-color: rgb(255, 255, 255);"></span>
以下是原文:
Node.js EventEmitter
Node.js 所有的異步 I/O 操作在完成時都會發送一個事件到事件隊列。
Node.js裏面的許多對象都會分發事件:一個net.Server對象會在每次有新連接時分發一個事件, 一個fs.readStream對象會在文件被打開的時候發出一個事件。 所有這些產生事件的對象都是 events.EventEmitter 的實例。
EventEmitter 類
events 模塊只提供了一個對象: events.EventEmitter。EventEmitter 的核心就是事件觸發與事件監聽器功能的封裝。
你可以通過require("events");來訪問該模塊。
// 引入 events 模塊 var events = require('events'); // 創建 eventEmitter 對象 var eventEmitter = new events.EventEmitter();
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 的監聽器。
$ node event.js 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 參數');
執行以上代碼,運行的結果如下:/p>
$ node event.js listener1 arg1 參數 arg2 參數 listener2 arg1 參數 arg2 參數
以上例子中,emitter 爲事件 someEvent 註冊了兩個事件監聽器,然後觸發了 someEvent 事件。
運行結果中可以看到兩個事件監聽器回調函數被先後調用。 這就是EventEmitter最簡單的用法。
EventEmitter 提供了多個屬性,如 on 和 emit。on 函數用於綁定事件函數,emit 屬性用於觸發一個事件。接下來我們來具體看下 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。 |
類方法
序號 | 方法 & 描述 |
---|---|
1 |
listenerCount(emitter, event) 返回指定事件的監聽器數量。 |
事件
序號 | 事件 & 描述 |
---|---|
1 |
newListener
該事件在添加新監聽器時被觸發。 |
2 |
removeListener
從指定監聽器數組中刪除一個監聽器。需要注意的是,此操作將會改變處於被刪監聽器之後的那些監聽器的索引。 |
實例
以下實例通過 connection(連接)事件演示了 EventEmitter 類的應用。
創建 main.js 文件,代碼如下:
var events = require('events'); var eventEmitter = new events.EventEmitter(); // 監聽器 #1 var listner1 = function listner1() { console.log('監聽器 listner1 執行。'); } // 監聽器 #2 var listner2 = function listner2() { console.log('監聽器 listner2 執行。'); } // 綁定 connection 事件,處理函數爲 listner1 eventEmitter.addListener('connection', listner1); // 綁定 connection 事件,處理函數爲 listner2 eventEmitter.on('connection', listner2); var eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection'); console.log(eventListeners + " 監聽器監聽連接事件。"); // 處理 connection 事件 eventEmitter.emit('connection'); // 移除監綁定的 listner1 函數 eventEmitter.removeListener('connection', listner1); console.log("listner1 不再受監聽。"); // 觸發連接事件 eventEmitter.emit('connection'); eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection'); console.log(eventListeners + " 監聽器監聽連接事件。"); console.log("程序執行完畢。");
以上代碼,執行結果如下所示:
$ node main.js 2 監聽器監聽連接事件。 監聽器 listner1 執行。 監聽器 listner2 執行。 listner1 不再受監聽。 監聽器 listner2 執行。 1 監聽器監聽連接事件。 程序執行完畢。
error 事件
EventEmitter 定義了一個特殊的事件 error,它包含了錯誤的語義,我們在遇到 異常的時候通常會觸發 error 事件。
當 error 被觸發時,EventEmitter 規定如果沒有響 應的監聽器,Node.js 會把它當作異常,退出程序並輸出錯誤信息。
我們一般要爲會觸發 error 事件的對象設置監聽器,避免遇到錯誤後整個程序崩潰。例如:
var events = require('events'); var emitter = newevents.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)
繼承 EventEmitter
大多數時候我們不會直接使用 EventEmitter,而是在對象中繼承它。包括 fs、net、 http 在內的,只要是支持事件響應的核心模塊都是 EventEmitter 的子類。
爲什麼要這樣做呢?原因有兩點:
首先,具有某個實體功能的對象實現事件符合語義, 事件的監聽和發射應該是一個對象的方法。
其次 JavaScript 的對象機制是基於原型的,支持 部分多重繼承,繼承 EventEmitter 不會打亂對象原有的繼承關係。
轉自:http://www.runoob.com/nodejs/nodejs-event.html