Like Share Discussion Bookmark Smile

J.J. Huang   2020-01-22   Node.js   瀏覽次數:

Node.js | EventEmitter(事件發射器)

EventEmitter 簡介

Node.js所有的異步I/O操作在完成時都會發送一個事件到事件隊列。

Node.js裡面的許多對像都會分發事件:一個net.Server對象會在每次有新連接時觸發一個事件,一個fs.readStream對象會在文件被打開的時候觸發一個事件。所有這些產生事件的對像都是events.EventEmitter的範例。

註:詳細Doc Link

EventEmitter 類

events模組只提供了一個對象:events.EventEmitter
EventEmitter的核心就是事件觸發與事件監聽器功能的封裝。

你可以通過require("events");來訪問該模組。

1
2
3
4
// 引入 events 模組
var events = require('events');
// 建立 eventEmitter 對象
var eventEmitter = new events.EventEmitter();

EventEmitter對像如果在實例化時發生錯誤,會觸發error事件。
當添加新的監聽器時,newListener事件會觸發,當監聽器被移除時,removeListener事件被觸發。

下面我們用一個簡單的例子說明EventEmitter的用法:

1
2
3
4
5
6
7
8
9
10
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
2
$ node main.js 
some_event 事件觸發

運行這段程式,1秒後控制台輸出了'some_event 事件觸發'
其原理是event對象註冊了事件some_event的一個監聽器,然後我們通過setTimeout1000毫秒以後向event對象發送事件 some_event,此時會調用some_event的監聽器。

EventEmitter的每個事件由一個事件名和若干個參數組成,事件名是一個字符串,通常表達一定的語義。對於每個事件,EventEmitter支持若干個事件監聽器。

當事件觸發時,註冊到這個事件的事件監聽器被依次調用,事件參數作為回調函數參數傳遞。

讓我們以下面的例子解釋這個過程:

1
2
3
4
5
6
7
8
9
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 參數');

執行結果如下:

1
2
3
$ node main.js
listener1 arg1 參數 arg2 參數
listener2 arg1 參數 arg2 參數

以上例子中,emitter為事件someEvent註冊了兩個事件監聽器,然後觸發了someEvent事件。

運行結果中可以看到兩個事件監聽器回調函數被先後調用。這就是EventEmitter最簡單的用法。

EventEmitter提供了多個屬性,如onemit

  • on函數用於綁定事件函數。
  • emit屬性用於觸發一個事件。

具體看下EventEmitter的屬性介紹:

方法

序號 方法 & 描述 Doc
1 addListener(eventName, listener)
為指定事件添加一個監聽器到監聽器數組的尾部。
Link
2 on(eventName, listener)
為指定事件註冊一個監聽器,接受一個字符串 event 和一個回調函數。
Link
3 once(eventName, listener)
為指定事件註冊一個單次監聽器,即 監聽器最多只會觸發一次,觸發後立刻解除該監聽器。
Link
4 removeListener(eventName, listener)
移除指定事件的某個監聽器,監聽器必須是該事件已經註冊過的監聽器。
它接受兩個參數,第一個是事件名稱,第二個是回調函數名稱。
Link
5 removeAllListeners([eventName])
移除所有事件的所有監聽器,如果指定事件,則移除指定事件的所有監聽器。
Link
6 setMaxListeners(n)
默認情況下, EventEmitters 如果你添加的監聽器超過 10 個就會輸出警告訊息。setMaxListeners 函數用於提高監聽器的默認限制的數量。
Link
7 listeners(eventName)
返回指定事件的監聽器數組。
Link
8 emit(eventName, [arg1], [arg2], […])按監聽器的順序執行執行每個監聽器,如果事件有註冊監聽返回 true,否則返回 false。 Link

類方法

序號 方法 & 描述 Doc
1 listenerCount(emitter, eventName)
返回指定事件的監聽器數量。// 已廢棄,不推薦
Link
2 listenerCount(eventName)
返回指定事件的監聽器數量。// 推薦                                                                                                                                       
Link

事件

序號 方法 & 描述 Doc
1 newListener
  • event - 字符串,事件名稱
  • listener - 處理事件函數
該事件在添加新監聽器時被觸發。
Link
2 removeListener
  • event - 字符串,事件名稱
  • listener - 處理事件函數
從指定監聽器數組中刪除一個監聽器。需要注意的是,此操作將會改變處於被刪監聽器之後的那些監聽器的索引。
Link

範例

通過connection(連接)事件示範了EventEmitter類的應用。

main.js,程式如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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 = eventEmitter.listenerCount('connection');
console.log(eventListeners + '個監聽器監聽連接事件。');

// 處理 connection 事件
eventEmitter.emit('connection');

// 移除監綁定的 listener1 函數
eventEmitter.removeListener('connection', listener1);
console.log('listener1 不再受監聽。');

// 觸發連接事件
eventEmitter.emit('connection');

eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + '個監聽器監聽連接事件。');

console.log('執行完畢。');

執行結果如下:

1
2
3
4
5
6
7
8
$ node main.js
2個監聽器監聽連接事件。
監聽器 listener1 執行。
監聽器 listener2 執行。
listener1 不再受監聽。
監聽器 listener2 執行。
1個監聽器監聽連接事件。
執行完畢。

error 事件

EventEmitter定義了一個特殊的事件error,它包含了錯誤的語義,我們在遇到異常的時候通常會觸發error事件。

error被觸發時,EventEmitter規定如果沒有響應的監聽器,Node.js會把它當作異常,退出程序並輸出錯誤訊息。

我們一般要為會觸發error事件的對象設置監聽器,避免遇到錯誤後整個程序崩潰。

例如:

1
2
3
var events = require('events'); 
var emitter = new events.EventEmitter();
emitter.emit('error');

執行結果如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$ node main.js
events.js:201
throw err; // Unhandled 'error' event
^

Error [ERR_UNHANDLED_ERROR]: Unhandled error. (undefined)
at EventEmitter.emit (events.js:199:17)
at Object.<anonymous> (/Users/morose/Documents/Temp/Example/main.js:3:9)
at Module._compile (internal/modules/cjs/loader.js:956:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:973:10)
at Module.load (internal/modules/cjs/loader.js:812:32)
at Function.Module._load (internal/modules/cjs/loader.js:724:14)
at Function.Module.runMain (internal/modules/cjs/loader.js:1025:10)
at internal/main/run_main_module.js:17:11 {
code: 'ERR_UNHANDLED_ERROR',
context: undefined
}

繼承 EventEmitter

大多數時候我們不會直接使用EventEmitter,而是在對像中繼承它。包括fsnethttp在內的,只要是支持事件響應的核心模組都是 EventEmitter的子類。

為什麼要這樣做呢?原因有兩點:

  • 首先,具有某個實體功能的對象實現事件符合語義,事件的監聽和發生應該是一個對象的方法。
  • 其次JavaScript的對像機制是基於原型的,支持 部分多重繼承,繼承EventEmitter不會打亂對象原有的繼承關係。

註:以上參考了
Node.js EventEmitter