Node.js EventEmmitter事件監聽器用法實例分析

2024-05-06 16:47:37

字體：大中小

來源：轉載

供稿：網友

本文實例講述了Node.js EventEmmitter事件監聽器用法。分享給大家供大家參考，具體如下：

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

events 模塊只提供了一個對象： events.EventEmitter。EventEmitter 的核心就是事件觸發與事件監聽器功能的封裝。
該模塊已被node.js默認引，不需要使用require()顯示引入。

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

一、on(event, listener)

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

var myEvent = new events.EventEmitter();var listener = function() {  console.log('someEvent emit');}myEvent.on('someEvent', listener);//這里是lambda表達式setTimeout(() => myEvent.emit('someEvent'), 1000);

EventEmitter 的每個事件由一個事件名和若干個參數組成，事件名是一個字符串，通常表達一定的語義。對于每個事件，EventEmitter 支持若干個事件監聽器。
當事件觸發時，注冊到這個事件的事件監聽器被依次調用，事件參數作為回調函數參數傳遞。

var myEvent = new events.EventEmitter();myEvent.on('someEvent', function(arg1,arg2) { console.log('someEvent 1 emit', arg1, arg2);});myEvent.on('someEvent', (arg1,arg2) => console.log('someEvent 2 emit', arg1, arg2));myEvent.emit('someEvent', 'arg1', 'arg2');/*輸出someEvent 1 emit arg1 arg2someEvent 2 emit arg1 arg2*/

二、once(event, listener)

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

var myEvent = new events.EventEmitter();myEvent.once('someEvent', function () {  console.log('someEvent emit');});myEvent.emit('someEvent');/*返回 true輸出 someEvent emit*/myEvent.emit('someEvent');//返回 false

三、removeListener(event, listener)

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

var myEvent = new events.EventEmitter();var listener = () => console.log('someEvent emit');myEvent.on('someEvent', listener);myEvent.removeListener('someEvent', listener);myEvent.emit('someEvent');//返回 false

四、removeAllListeners([event])

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

五、setMaxListeners(n)

默認情況下， EventEmitters 如果你添加的監聽器超過 10 個就會輸出警告信息。 setMaxListeners 函數用于提高監聽器的默認限制的數量。

六、listenerCount(emitter, event)

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

var myEvent = new events.EventEmitter();myEvent.listenerCount();//輸出 0events.EventEmitter.listenerCount(myEvent);//輸出 0events.EventEmitter.listenerCount(myEvent, 'someEvent');//輸出 0myEvent.on('someEvent', () => console.log('someEvent emit'));myEvent.listenerCount();//輸出 0events.EventEmitter.listenerCount(myEvent);//輸出 0events.EventEmitter.listenerCount(myEvent, 'someEvent');//輸出 1

七、error 事件

EventEmitter 定義了一個特殊的事件 error，它包含了錯誤的語義，我們在遇到異常的時候通常會觸發 error 事件。
當 error 被觸發時，EventEmitter 規定如果沒有響應的監聽器，Node.js 會把它當作異常，退出程序并輸出錯誤信息。
我們一般要為會觸發 error 事件的對象設置監聽器，避免遇到錯誤后整個程序崩潰。

var myEvent = new events.EventEmitter();myEvent.on('uncaughtException', (err) => { console.log('whoops! there was an error');});myEvent.emit('error', new Error('whoops!'));//輸出 Error: whoops!myEvent.on('error', (err) => { console.log('whoops! there was an error');});myEvent.emit('error', new Error('whoops!'));//輸出 whoops! there was an error

注意

大多數時候我們不會直接使用 EventEmitter，而是在對象中繼承它。包括 fs、net、 http 在內的，只要是支持事件響應的核心模塊都是 EventEmitter 的子類。

為什么要這樣做呢？原因有兩點：

1. 具有某個實體功能的對象實現事件符合語義，事件的監聽和發射應該是一個對象的方法。
2. JavaScript 的對象機制是基于原型的，支持部分多重繼承，繼承 EventEmitter 不會打亂對象原有的繼承關系。

Events（事件）模塊是Node.js的核心，許多其他模塊用它來圍繞著事件架構功能。由于Node.js運行在單一的線程中，任何同步代碼都是阻塞的，所以如果有長時間運行的代碼的話事件循環便會被阻塞。為了有效地使用Node.js編寫代碼，必須仔細思考自己的變成風格并遵循一些簡單的規則。