天天看點

Node.js EventEmitter

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

Node.js 裡面的許多對象都會分發事件:一個 net.Server 對象會在每次有新連接配接時觸發一個事件, 一個 fs.readStream 對象會在檔案被打開的時候觸發一個事件。 所有這些産生事件的對象都是 events.EventEmitter 的執行個體。

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

你可以通過require("events");來通路該子產品。

EventEmitter 對象如果在執行個體化時發生錯誤,會觸發 error 事件。當添加新的監聽器時,newListener 事件會觸發,當監聽器被移除時,removeListener 事件被觸發。

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

執行結果如下:

運作這段代碼,1 秒後控制台輸出了 <b>'some_event 事件觸發'</b>。其原理是 event 對象注冊了事件 some_event 的一個監聽器,然後我們通過 setTimeout 在 1000 毫秒以後向 event 對象發送事件 some_event,此時會調用some_event 的監聽器。

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

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

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

執行以上代碼,運作的結果如下:

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

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

EventEmitter 提供了多個屬性,如 <b>on</b> 和 <b>emit</b>。<b>on</b> 函數用于綁定事件函數,<b>emit</b> 屬性用于觸發一個事件。接下來我們來具體看下 EventEmitter 的屬性介紹。

序号

方法 &amp; 描述

1

<b>addListener(event, listener)</b>

為指定事件添加一個監聽器到監聽器數組的尾部。

2

<b>on(event, listener)</b>

為指定事件注冊一個監聽器,接受一個字元串 event 和一個回調函數。

3

<b>once(event, listener)</b>

為指定事件注冊一個單次監聽器,即 監聽器最多隻會觸發一次,觸發後立刻解除該監聽器。

4

<b>removeListener(event, listener)</b>

移除指定事件的某個監聽器,監聽器必須是該事件已經注冊過的監聽器。

它接受兩個參數,第一個是事件名稱,第二個是回調函數名稱。

5

<b>removeAllListeners([event])</b>

移除所有事件的所有監聽器, 如果指定事件,則移除指定事件的所有監聽器。

6

<b>setMaxListeners(n)</b>

預設情況下, EventEmitters 如果你添加的監聽器超過 10 個就會輸出警告資訊。

setMaxListeners 函數用于改變監聽器的預設限制的數量。

7

<b>listeners(event)</b>

傳回指定事件的監聽器數組。

8

<b>emit(event, [arg1], [arg2], [...])</b>

按監聽器的順序執行執行每個監聽器,如果事件有注冊監聽傳回 true,否則傳回 false。

<b>listenerCount(emitter, event)</b>

傳回指定事件的監聽器數量。

事件 &amp; 描述

<b>newListener</b>

<b>event</b> - 字元串,事件名稱

<b>listener</b> - 處理事件函數

該事件在添加新監聽器時被觸發。

<b>removeListener</b>

從指定監聽器數組中删除一個監聽器。需要注意的是,此操作将會改變處于被删監聽器之後的那些監聽器的索引。

以下執行個體通過 connection(連接配接)事件示範了 EventEmitter 類的應用。

建立 main.js 檔案,代碼如下:

以上代碼,執行結果如下所示:

EventEmitter 定義了一個特殊的事件 error,它包含了錯誤的語義,我們在遇到

異常的時候通常會觸發 error 事件。

當 error 被觸發時,EventEmitter 規定如果沒有響

應的監聽器,Node.js 會把它當作異常,退出程式并輸出錯誤資訊。

我們一般要為會觸發 error

事件的對象設定監聽器,避免遇到錯誤後整個程式崩潰。例如:

運作時會顯示以下錯誤:

大多數時候我們不會直接使用 EventEmitter,而是在對象中繼承它。包括 fs、net、

http 在内的,隻要是支援事件響應的核心子產品都是 EventEmitter 的子類。

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

首先,具有某個實體功能的對象實作事件符合語義,

事件的監聽和發生應該是一個對象的方法。

其次 JavaScript 的對象機制是基于原型的,支援

部分多重繼承,繼承 EventEmitter 不會打亂對象原有的繼承關系。