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 参数');
執行以上代碼,運行的結果如下:
$ 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 listener1 = function listener1() { console.log('监听器 listener1 执行。'); } // 监听器 #2 var listener2 = function listener2() { console.log('监听器 listener2 执行。'); } // 绑定 connection 事件,处理函数为 listener1 eventEmitter.addListener('connection', listener1); // 绑定 connection 事件,处理函数为 listener2 eventEmitter.on('connection', listener2); var eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection'); console.log(eventListeners + " 个监听器监听连接事件。"); // 处理 connection 事件 eventEmitter.emit('connection'); // 移除监绑定的 listener1 函数 eventEmitter.removeListener('connection', listener1); console.log("listener1 不再受监听。"); // 触发连接事件 eventEmitter.emit('connection'); eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection'); console.log(eventListeners + " 个监听器监听连接事件。"); console.log("程序执行完毕。");
以上代碼,執行結果如下所示:
$ node main.js 2 个监听器监听连接事件。 监听器 listener1 执行。 监听器 listener2 执行。 listener1 不再受监听。 监听器 listener2 执行。 1 个监听器监听连接事件。 程序执行完毕。
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)
繼承EventEmitter
大多數時候我們不會直接使用EventEmitter,而是在對像中繼承它。 包括fs、net、 http 在內的,只要是支持事件響應的核心模塊都是EventEmitter 的子類。
為什麼要這樣做呢? 原因有兩點:
首先,具有某個實體功能的對象實現事件符合語義, 事件的監聽和發射應該是一個對象的方法。
其次JavaScript 的對像機制是基於原型的,支持部分多重繼承,繼承EventEmitter 不會打亂對象原有的繼承關係。