Node.js 事件發射器

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 的屬性介紹。

方法

##12345678

序號	方法& 描述
	addListener(event, listener)為指定事件新增一個監聽器到監聽器陣列的尾部。
	on(event, listener)為指定事件註冊一個監聽器，接受一個字串event 和一個回調函數。 server.on('connection', function (stream) { console.log('someone connected!'); });
	once(event, listener)#為指定事件註冊一個單次監聽器，即監聽器最多只會觸發一次，觸發後立刻解除該監聽器。 server.once('connection', function (stream) { console.log('Ah, we have our first user!'); });
	removeListener(event, listener)移除指定事件的某個監聽器，監聽器必須是該事件已經註冊過的監聽器。 var callback = function(stream) { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback);
	removeAllListeners([event])移除所有事件的所有監聽器，如果指定事件，則移除指定事件的所有監聽器。
	setMaxListeners(n) 預設情況下，EventEmitters 如果你加入的監聽器超過10 個就會輸出警告資訊. setMaxListeners 函數用於提高監聽器的預設限制的數量。
	listeners(event)傳回指定事件的監聽器陣列。
	emit(event, [arg1], [arg2], [...])依參數的順序執行每個監聽器，如果事件有註冊監聽回傳true，否則回傳false。

類別方法

##方法& 描述

listenerCount(emitter, event)傳回指定事件的監聽器數量。 #1newListener2

1
	事件 #事件& 描述
	#event - 字串，事件名稱 listener - 處理事件函數該事件在新增監聽器時被觸發。

事件

#事件& 描述

#event
- 字串，事件名稱
listener
- 處理事件函數

###removeListener##################event### - 字符串，事件名稱###############listener### - 處理事件函數############從指定監聽器陣列中刪除一個監聽器。需要注意的是，此操作將會改變處於被刪除監聽器之後的那些監聽器的索引。 ################

實例

以下實例透過 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 不會打亂物件原有的繼承關係。

Node.js 事件發射器

EventEmitter 類別

方法

實例

error 事件

繼承EventEmitter

PHP中文網