Node.js中的EventEmitter類使用小結(jié)
1.EventEmitter類說明
EventEmitter
是 Node.js 中的一個核心模塊,它提供了一種實現(xiàn)事件驅(qū)動編程的機制。它是一個基于觀察者模式的類,用于在應(yīng)用程序中處理事件和觸發(fā)事件。
Node.js 所有的異步 I/O 操作在完成時都會發(fā)送一個事件到事件隊列。
Node.js 里面的許多對象都會分發(fā)事件:一個 net.Server 對象會在每次有新連接時觸發(fā)一個事件, 一個 fs.readStream 對象會在文件被打開的時候觸發(fā)一個事件。 所有這些產(chǎn)生事件的對象都是 events.EventEmitter 的實例。
2.EventEmitter類使用
2.1事件注冊和觸發(fā)
通過 on
方法可以注冊事件監(jiān)聽器,監(jiān)聽特定的事件。當(dāng)事件觸發(fā)時,所有注冊的監(jiān)聽器將按照順序執(zhí)行。例如:
const EventEmitter = require('events'); const myEmitter = new EventEmitter(); myEmitter.on('event', () => { console.log('Event occurred'); }); myEmitter.emit('event'); // 執(zhí)行事件并觸發(fā)監(jiān)聽器
當(dāng) event
事件觸發(fā)時,EventEmitter
將調(diào)用相應(yīng)的監(jiān)聽器函數(shù),并輸出 'Event occurred'
。
2.2一次性事件監(jiān)聽器
使用 once
方法可以注冊一次性事件監(jiān)聽器,它只會在當(dāng)前事件觸發(fā)的第一次執(zhí)行。例如:
const EventEmitter = require('events'); const myEmitter = new EventEmitter(); myEmitter.once('event', () => { console.log('Event occurred once'); }); myEmitter.emit('event'); // 執(zhí)行事件并觸發(fā)監(jiān)聽器 myEmitter.emit('event'); // 不再觸發(fā)監(jiān)聽器
在上述示例中,once
方法注冊的監(jiān)聽器只會在第一次觸發(fā)事件時執(zhí)行。第二次觸發(fā)事件時,不會調(diào)用該監(jiān)聽器。
2.3傳遞參數(shù)
可以在事件觸發(fā)時向監(jiān)聽器傳遞參數(shù)。例如:
const EventEmitter = require('events'); const myEmitter = new EventEmitter(); myEmitter.on('event', (arg1, arg2) => { console.log(`Received ${arg1} and ${arg2}`); }); myEmitter.emit('event', 'Hello', 'World'); // 執(zhí)行事件并觸發(fā)監(jiān)聽器,并傳遞參數(shù)
在上述示例中,emit
方法觸發(fā)了 event
事件,并將 'Hello'
和 'World'
作為參數(shù)傳遞給監(jiān)聽器函數(shù)。
2.4錯誤處理
EventEmitter
具有內(nèi)置的錯誤處理機制??梢酝ㄟ^監(jiān)聽 'error'
事件來處理錯誤。如果沒有針對 'error'
事件注冊監(jiān)聽器,將會輸出一個未處理的錯誤堆棧。例如:
const EventEmitter = require('events'); const myEmitter = new EventEmitter(); myEmitter.on('error', (error) => { console.error('Error occurred:', error); }); myEmitter.emit('error', new Error('Something went wrong')); // 觸發(fā) 'error' 事件并傳遞錯誤對象
在上述示例中,當(dāng) 'error'
事件觸發(fā)時,注冊的監(jiān)聽器將打印出錯誤信息。
EventEmitter
類還具有其他方法,如 removeListener、removeAllListeners 等,用于添加、刪除或清除事件監(jiān)聽器。通過使用 EventEmitter,可以輕松實現(xiàn)事件驅(qū)動的編程范式,以構(gòu)建靈活、可擴展的應(yīng)用程序。
3.EventEmitter類方法說明
3.1 方法
- addListener(event, listener):為指定事件添加一個監(jiān)聽器到監(jiān)聽器數(shù)組的尾部。
- on(event, listener):為指定事件注冊一個監(jiān)聽器,接受一個字符串 event 和一個回調(diào)函數(shù)。
server.on('connection', function (stream) { console.log('someone connected!'); });
once(event, listener):為指定事件注冊一個單次監(jiān)聽器,即 監(jiān)聽器最多只會觸發(fā)一次,觸發(fā)后立刻解除該監(jiān)聽器。
server.once('connection', function (stream) { console.log('Ah, we have our first user!'); });
removeListener(event, listener):移除指定事件的某個監(jiān)聽器,監(jiān)聽器必須是該事件已經(jīng)注冊過的監(jiān)聽器。它接受兩個參數(shù),第一個是事件名稱,第二個是回調(diào)函數(shù)名稱。
var callback = function(stream) { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback);
- removeAllListeners([event]):移除所有事件的所有監(jiān)聽器, 如果指定事件,則移除指定事件的所有監(jiān)聽器。
- setMaxListeners(n):默認(rèn)情況下, EventEmitters 如果你添加的監(jiān)聽器超過 10 個就會輸出警告信息。 setMaxListeners 函數(shù)用于改變監(jiān)聽器的默認(rèn)限制的數(shù)量。
- listeners(event):返回指定事件的監(jiān)聽器數(shù)組。
- emit(event, [arg1], [arg2], […]):按監(jiān)聽器的順序執(zhí)行執(zhí)行每個監(jiān)聽器,如果事件有注冊監(jiān)聽返回 true,否則返回 false。
3.2類方法
listenerCount(emitter, event):返回指定事件的監(jiān)聽器數(shù)量。
events.EventEmitter.listenerCount(emitter, eventName) //已廢棄,不推薦 events.emitter.listenerCount(eventName) //推薦
3.3 事件
- newListener(該事件在添加新監(jiān)聽器時被觸發(fā)。)
- event - 字符串,事件名稱
- listener - 處理事件函數(shù)
- removeListener(從指定監(jiān)聽器數(shù)組中刪除一個監(jiān)聽器。需要注意的是,此操作將會改變處于被刪監(jiān)聽器之后的那些監(jiān)聽器的索引。)
- event - 字符串,事件名稱
- listener - 處理事件函數(shù)
3.4 EventEmitter子類
大多數(shù)時候我們不會直接使用 EventEmitter,而是在對象中繼承它。包括 fs、net、 http 在內(nèi)的,只要是支持事件響應(yīng)的核心模塊都是 EventEmitter 的子類。
為什么要這樣做呢?原因有兩點:
首先,具有某個實體功能的對象實現(xiàn)事件符合語義, 事件的監(jiān)聽和發(fā)生應(yīng)該是一個對象的方法。
其次 JavaScript 的對象機制是基于原型的,支持 部分多重繼承,繼承 EventEmitter 不會打亂對象原有的繼承關(guān)系。
4.舉例說明
var events = require('events'); var eventEmitter = new events.EventEmitter(); // 監(jiān)聽器 #1 var listener1 = function listener1() { console.log('監(jiān)聽器 listener1 執(zhí)行。'); } // 監(jiān)聽器 #2 var listener2 = function listener2() { console.log('監(jiān)聽器 listener2 執(zhí)行。'); } // 綁定 connection 事件,處理函數(shù)為 listener1 eventEmitter.addListener('connection', listener1); // 綁定 connection 事件,處理函數(shù)為 listener2 eventEmitter.on('connection', listener2); var eventListeners = eventEmitter.listenerCount('connection'); console.log(eventListeners + " 個監(jiān)聽器監(jiān)聽連接事件。"); // 處理 connection 事件 eventEmitter.emit('connection'); // 移除監(jiān)綁定的 listener1 函數(shù) eventEmitter.removeListener('connection', listener1); console.log("listener1 不再受監(jiān)聽。"); // 觸發(fā)連接事件 eventEmitter.emit('connection'); eventListeners = eventEmitter.listenerCount('connection'); console.log(eventListeners + " 個監(jiān)聽器監(jiān)聽連接事件。"); console.log("程序執(zhí)行完畢。");
終端執(zhí)行結(jié)果:
$ node test_event_emit.js
2 個監(jiān)聽器監(jiān)聽連接事件。
監(jiān)聽器 listener1 執(zhí)行。
監(jiān)聽器 listener2 執(zhí)行。
listener1 不再受監(jiān)聽。
監(jiān)聽器 listener2 執(zhí)行。
1 個監(jiān)聽器監(jiān)聽連接事件。
程序執(zhí)行完畢。
到此這篇關(guān)于Node.js中的EventEmitter類介紹的文章就介紹到這了,更多相關(guān)Node.js EventEmitter類內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
基于 Docker 開發(fā) NodeJS 應(yīng)用
這是兩篇文章的第一篇。本文涵蓋了有關(guān)在使用 Express 框架開發(fā)一個Node應(yīng)用時,用Docker 替代 Vagrant 的比較詳細(xì)的教程, 應(yīng)用將使用 connect-redis 中間件將會話信息持久化到Redis中. 第二篇文章將介紹到將這個開發(fā)的設(shè)置產(chǎn)品化.2014-07-07理解nodejs的stream和pipe機制的原理和實現(xiàn)
本篇文章主要介紹了理解nodejs的stream和pipe機制的原理和實現(xiàn),具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-08-08從零學(xué)習(xí)node.js之mysql數(shù)據(jù)庫的操作(五)
因為接觸Node.JS已經(jīng)有一段時間了,最近粗略的研究了一下node.js操作數(shù)據(jù)庫的包,覺得node.js連接數(shù)據(jù)庫不錯。下面這篇文章主要給大家介紹了node.js之mysql數(shù)據(jù)庫操作的相關(guān)資料,需要的朋友可以參考下。2017-02-02Node.js使用Express創(chuàng)建Web項目詳細(xì)教程
如果需要入門使用node.js進行web開發(fā),正在學(xué)習(xí) nodejs web開發(fā)指南 的和想快速了解node.js web開發(fā)模式的朋友,相信本文是有一定幫助意義的。2017-03-03Node.js基礎(chǔ)入門之模塊與npm包管理器使用詳解
Node.js是一個基于Chrome?V8引擎的JavaScript運行時。類似于Java中的JRE,.Net中的CLR。本文將詳細(xì)為大家介紹Node.js中的模塊與npm包管理器的使用,需要的可以參考一下2022-03-03