node的EventEmitter模塊基本用法簡單實現示例
導讀
node的事件模塊只包含了一個類：EventEmitter。這個類在node的內置模塊和第三方模塊中大量使用。EventEmitter本質上是一個觀察者模式的實現，這種模式可以擴展node在多個進程或網絡中運行。本文從node的EventEmitter的使用出發(fā)，循序漸進的實現一個完整的EventEmitter模塊。
- EventEmitter模塊的基本用法和簡單實現
- node中常用的EventEmitter模塊的API
- EventEmitter模塊的異常處理
- 完整的實現一個EventEmitter模塊
原文地址：https://github.com/forthealll...
如果文章對您有幫助，您的star是對我最好的鼓勵～
EventEmitter模塊的基本用法和簡單實現
(1) EventEmitter模塊的基本用法
首先先了解一下EventEmitter模塊的基本用法，EventEmitter本質上是一個觀察者模式的實現，所謂觀察者模式：
它定義了對象間的一種一對多的關系，讓多個觀察者對象同時監(jiān)聽某一個主題對象，當一個對象發(fā)生改變時，所有依賴于它的對象都將得到通知。
因此最基本的EventEmitter功能，包含了一個觀察者和一個被監(jiān)聽的對象，對應的實現就是EventEmitter中的on和emit：
var events=require('events');
var eventEmitter=new events.EventEmitter();
eventEmitter.on('say',function(name){
console.log('Hello',name);
})
eventEmitter.emit('say','Jony yu');eventEmitter是EventEmitter模塊的一個實例，eventEmitter的emit方法，發(fā)出say事件，通過eventEmitter的on方法監(jiān)聽，從而執(zhí)行相應的函數。
(2) 簡單實現一個EventEmitter模塊
根據上述的例子，我們知道了EventEmitter模塊的基礎功能emit和on。下面我們實現一個包含emit和on方法的EventEmitter類。
on(eventName,callback)方法傳入兩個參數，一個是事件名（eventName），另一個是相應的回調函數，我們選擇在on的時候針對事件名添加監(jiān)聽函數，用對象來包含所有事件。在這個對象中對象名表示事件名（eventName),而對象的值是一個數組，表示該事件名所對應的執(zhí)行函數。
emit(eventName,...arg)方法傳入的參數，第一個為事件名，其他參數事件對應的執(zhí)行函數中的實參，emit方法的功能就是從事件對象中，尋找對應key為eventName的屬性，執(zhí)行該屬性所對應的數組里面每一個執(zhí)行函數。
下面來實現一個EventEmitter類
class EventEmitter{
constructor(){
this.handler={};
}
on(eventName,callback){
if(!this.handles){
this.handles={};
}
if(!this.handles[eventName]){
this.handles[eventName]=[];
}
this.handles[eventName].push(callback);
}
emit(eventName,...arg){
if(this.handles[eventName]){
for(var i=0;i<this.handles[eventName].length;i++){
this.handles[eventName][i](...arg);
}
}
}
}上述就實現了一個簡單的EventEmitter類，下面來實例化：
let event=new EventEmitter();
event.on('say',function(str){
console.log(str);
});
event.emit('say','hello Jony yu');
//輸出hello Jony yunode中常用的EventEmitter模塊的API
跟在上述簡單的EventEmitter模塊不同，node的EventEmitter還包含了很多常用的API，我們一一來介紹幾個實用的API.
| 方法名 | 方法描述 | |
|---|---|---|
| addListener(event, listener) | 為指定事件添加一個監(jiān)聽器到監(jiān)聽器數組的尾部。 | |
| prependListener(event,listener) | 與addListener相對，為指定事件添加一個監(jiān)聽器到監(jiān)聽器數組的頭部。 | |
| on(event, listener) | 其實就是addListener的別名 | |
| once(event, listener) | 為指定事件注冊一個單次監(jiān)聽器，即 監(jiān)聽器最多只會觸發(fā)一次，觸發(fā)后立刻解除該監(jiān)聽器。 | |
| removeListener(event, listener) | 移除指定事件的某個監(jiān)聽器，監(jiān)聽器必須是該事件已經注冊過的監(jiān)聽器 | |
| off(event, listener) | removeListener的別名 | |
| removeAllListeners([event]) | 移除所有事件的所有監(jiān)聽器， 如果指定事件，則移除指定事件的所有監(jiān)聽器。 | |
| setMaxListeners(n) | 默認情況下， EventEmitters 如果你添加的監(jiān)聽器超過 10 個就會輸出警告信息。 setMaxListeners 函數用于提高監(jiān)聽器的默認限制的數量。 | |
| listeners(event) | 返回指定事件的監(jiān)聽器數組。 | |
| emit(event, [arg1], [arg2], [...]) | 按參數的順序執(zhí)行每個監(jiān)聽器，如果事件有注冊監(jiān)聽返回 true，否則返回 false。 |
除此之外，還有2個特殊的，不需要手動添加，node的EventEmitter模塊自帶的特殊事件：
| 事件名 | 事件描述 | |
|---|---|---|
| newListener | 該事件在添加新事件監(jiān)聽器的時候觸發(fā) | |
| removeListener | 從指定監(jiān)聽器數組中刪除一個監(jiān)聽器。需要注意的是，此操作將會改變處于被刪監(jiān)聽器之后的那些監(jiān)聽器的索引 |
上述node的EventEmitter的模塊看起來很多很復雜，其實上述的API中包含了一些別名，仔細整理，理解其使用和實現不是很困難，下面一一對比和介紹上述的API。
(1) addListener和removeListener、on和off方法
addListener(eventName,listener)的作用是為指定事件添加一個監(jiān)聽器. 其別名為on
removeListener(eventName,listener)的作用是為移除某個事件的監(jiān)聽器. 其別名為off
再次需要強調的是：addListener的別名是on，removeListener的別名是off
EventEmitter.prototype.on=EventEmitter.prototype.addListener EventEmitter.prototype.off=EventEmitter.prototype.removeListener
接著我們來看具體的用法：
var events=require('events');
var emitter=new events.EventEmitter();
function hello1(name){
console.log("hello 1",name);
}
function hello2(name){
console.log("hello 2",name);
}
emitter.addListener('say',hello1);
emitter.addListener('say',hello2);
emitter.emit('say','Jony');
//輸出hello 1 Jony
//輸出hello 2 Jony
emitter.removeListener('say',hello1);
emitter.emit('say','Jony');
//相應的監(jiān)聽say事件的hello1事件被移除
//只輸出hello 2 Jony(2) removeListener和removeAllListeners
removeListener指的是移除一個指定事件的某一個監(jiān)聽器，而removeAllListeners指的是移除某一個指定事件的全部監(jiān)聽器。
這里舉例一個removeAllListeners的例子：
var events=require('events');
var emitter=new events.EventEmitter();
function hello1(name){
console.log("hello 1",name);
}
function hello2(name){
console.log("hello 2",name);
}
emitter.addListener('say',hello1);
emitter.addListener('say',hello2);
emitter.removeAllListeners('say');
emitter.emit('say','Jony');
//removeAllListeners移除了所有關于say事件的監(jiān)聽
//因此沒有任何輸出(3) on和once方法
on和once的區(qū)別是：
on的方法對于某一指定事件添加的監(jiān)聽器可以持續(xù)不斷的監(jiān)聽相應的事件，而once方法添加的監(jiān)聽器，監(jiān)聽一次后，就會被消除。
比如on方法（跟addListener相同）：
var events=require('events');
var emitter=new events.EventEmitter();
function hello(name){
console.log("hello",name);
}
emitter.on('say',hello);
emitter.emit('say','Jony');
emitter.emit('say','yu');
emitter.emit('say','me');
//會一次輸出 hello Jony、hello yu、hello me也就是說on方法監(jiān)聽的事件，可以持續(xù)不斷的被觸發(fā)。
(4) 兩個特殊的事件newListener和removeListener
我們知道當實例化EventEmitter模塊之后，監(jiān)聽對象是一個對象，包含了所有的監(jiān)聽事件，而這兩個特殊的方法就是針對監(jiān)聽事件的添加和移除的。
newListener：在添加新事件監(jiān)聽器觸發(fā)removeListener：在移除事件監(jiān)聽器時觸發(fā)
以newListener為例，會在添加新事件監(jiān)聽器的時候觸發(fā)：
var events=require('events');
var emitter=new events.EventEmitter();
function hello(name){
console.log("hello",name);
}
emitter.on('newListener',function(eventName,listener){
console.log(eventName);
console.log(listener);
});
emitter.addListener('say',hello);
//輸出say和[Function: hello]從上述的例子來看，每當添加新的事件，都會自動的emit一個“newListener”事件，且參數為eventName(新事件的名)和listener(新事件的執(zhí)行函數)。
同理特殊事件removeListener也是同樣的，當事件被移除，會自動emit一個"removeListener"事件。
EventEmitter模塊的異常處理
(1) node中的try catch異常處理方法
在node中也可以通過try catch方式來捕獲和處理異常，比如：
try {
let x=x;
} catch (e) {
console.log(e);
}上述let x=x 賦值語句的錯誤會被捕獲。這里提異常處理，那么跟事件有什么關系呢？
node中有一個特殊的事件error，如果異常沒有被捕獲，就會觸發(fā)process的uncaughtException事件拋出，如果你沒有注冊該事件的監(jiān)聽器（即該事件沒有被處理），則 Node.js 會在控制臺打印該異常的堆棧信息，并結束進程。
比如：
var events=require('events');
var emitter=new events.EventEmitter();
emitter.emit('error');在上述代碼中沒有監(jiān)聽error的事件函數，因此會觸發(fā)process的uncaughtException事件，從而打印異常堆棧信息，并結束進程。
對于阻塞或者說非異步的異常捕獲，try catch是沒有問題的，但是：
try catch不能捕獲非阻塞或者異步函數里面的異常。
舉例來說：
try {
let x=x;//第二個x在使用前未定義，會拋出異常
} catch (e) {
console.log('該異常已經被捕獲');
console.log(e);
}上述代碼中，以為try方法里面是同步的，因此可以捕獲異常。如果try方法里面有異步的函數：
try {
process.nextTick(function(){
let x=x; //第二個x在使用前未定義，會拋出異常
});
} catch (e) {
console.log('該異常已經被捕獲');
console.log(e);
}因為process.nextTick是異步的，因此在process.nextTick內部的錯誤不能被捕獲，也就是說try catch不能捕獲非阻塞函數內的異常。
(2) 通過domains管理異常
node中domain模塊能被用來集中地處理多個異常操作，通過node的domain模塊可以捕獲非阻塞函數內的異常。
var domain=require('domain');
var eventDomain=domain.create();
eventDomain.on('error',function(err){
console.log('該異常已經被捕獲了');
console.log(err);
});
eventDomain.run(function(){
process.nextTick(function(){
let x=x;//拋出異常
});
});同樣的，即使process.nextTick是一個異步函數，domain.on方法也可以捕獲這個異步函數中的異常。
即使更復雜的情況下，比如異步嵌套異步的情況下，domain.on方法也可以捕獲異常。
var domain=require('domain');
var eventDomain=domain.create();
eventDomain.on('error',function(err){
console.log('該異常已經被捕獲了');
console.log(err);
});
eventDomain.run(function(){
process.nextTick(function(){
setTimeout(function(){
setTimeout(function(){
let x=x;
},0);
},0);
});
});在上述的情況下，即使異步嵌套很復雜，也能在最外層捕獲到異常。
(3) domain模塊缺陷
在node最新的文檔中，domain被廢除（被標記為：Deprecated），domain從誕生之日起就有著缺陷，舉例來說：
var domain = require('domain');
var EventEmitter = require('events').EventEmitter;
var e = new EventEmitter();
var timer = setTimeout(function () {
e.emit('data');
}, 10);
function next() {
e.once('data', function () {
throw new Error('something wrong here');
});
}
var d = domain.create();
d.on('error', function () {
console.log('cache by domain');
});
d.run(next);如上述的代碼是無法捕獲到異常Error的，原因在于發(fā)出異常的EventEmitter實例e,以及觸發(fā)異常的定時函數timer沒有被domain包裹。domain模塊是通過重寫事件循環(huán)中的nextTick和_tickCallback來事件將process.domain注入到next包裹的所有異步事件內。
解決上述無法捕獲異常的情況，只需要將e或者timer包裹進domain。
d.add(e)或者d.add(timer)
就可以成功的捕獲異常。
domain模塊已經在node最新的文檔中被廢除
(4)process.on('uncaughtException')的方法捕獲異常
node中提供了一個最外層的兜底的捕獲異常的方法。非阻塞或者異步函數中的異常都會拋出到最外層，如果異常沒有被捕獲，那么會暴露出來，被最外層的process.on('uncaughtException')所捕獲。
try {
process.nextTick(function(){
let x=x; //第二個x在使用前未定義，會拋出異常
},0);
} catch (e) {
console.log('該異常已經被捕獲');
console.log(e);
}
process.on('uncaughtException',function(err){console.log(err)})這樣就能在最外層捕獲異步或者說非阻塞函數中的異常。
完整的實現一個EventEmitter模塊（可選讀）
在第二節(jié)中我們知道了EventEmitter模塊的基本用法，那么根據基本的API我們可以進一步自己去實現一個EventEmitter模塊。
每一個EventEmitter實例都有一個包含所有事件的對象_events,
事件的監(jiān)聽和監(jiān)聽事件的觸發(fā)，以及監(jiān)聽事件的移除等都在這個對象_events的基礎上實現。
(1) emit
emit的方法實現的大致功能如下程序流程圖所示：
從上述的程序圖出發(fā)，我們開始實現自己的EventEmitter模塊。
首先生成一個EventEmitter類，在類的初始化方法中生成這個事件對象_events.
class EventEmitter{
constructor(){
if(this._events===undefined){
this._events=Object.create(null);//定義事件對象
this._eventsCount=0;
}
}
}_eventsCount用于統(tǒng)計事件的個數，也就是_events對象有多少個屬性。
接著我們來實現emit方法，根據框圖，我們知道emit所做的事情是在_events對象中取出相應type的屬性，并執(zhí)行屬性所對應的函數，我們來實現這個emit方法。
class EventEmitter{
constructor(){
if(this._events===undefined){
this._events=Object.create(null);//定義事件對象
this._eventsCount=0;
}
}
emit(type,...args){
const events=this._events;
const handler=events[type];
//判斷相應type的執(zhí)行函數是否為一個函數還是一個數組
if(typeof handler==='function'){
Reflect.apply(handler,this,args);
}else{
const len=handler.length;
for(var i=0;li<len;i++){
Reflect.apply(handler[i],this,args);
}
}
return true;
}
}(2) on、addListener和prependListener方法
emit方法是出發(fā)事件，并執(zhí)行相應的方法，而on方法則是對于指定的事件添加監(jiān)聽函數。用程序來說，就是往事件對象中_events添加相應的屬性.程序流程圖如下所示：
接著我們來實現這個方法：
on(type,listener,prepend){
var m;
var events;
var existing;
events=this._events;
//添加事件的
if(events.newListener!==undefined){
this.emit('newListener',type,listener);
events=target._events;
}
existing=events[type];
//判斷相應的type的方法是否存在
if(existing===undefined){
//如果相應的type的方法不存在，這新增一個相應type的事件
existing=events[type]=listener;
++this._eventsCount;
}else{
//如果存在相應的type的方法,判斷相應的type的方法是一個數組還是僅僅只是一個方法
//如果僅僅是
if(typeof existing==='function'){
//如果僅僅是一個方法，則添加
existing=events[type]=prepend?[listener,existing]:[existing,listener];
}else if(prepend){
existing.unshift(listener);
}else{
existing.push(listener);
}
}
//鏈式調用
return this;
}- 在on方法中為了可以鏈式的調用我們返回了EventEmitter模塊的實例化本身。
- 且在on方法的參數中，第三個參數用于指定是在相應事件類型屬性所對應的數組頭部添加還是尾部添加，不傳的情況下實在尾部添加，如果指定prepend為true，則相同事件類型的新的監(jiān)聽事件會添加到事件數組的頭部。
- 如果_events存在newListener屬性，也就是說_event存在監(jiān)聽newListener監(jiān)聽事件，那么每次on方法添加事件的時候，都會emit出一個‘newListener’方法。
在on方法的基礎上可以實現addListener方法和prependListener方法。
addListener方法是on方法的別名：
EventEmitter.prototype.addListener=EventEmitter.prototype.on
prependListener方法相當于在頭部添加，指定prepend為true：
EventEmitter.prototype.prependListener =
function prependListener(type, listener) {
return EventEmitter.prototype.on(type, listener, true);
};(3) removeListener和removeAllListeners
接著來看移除事件監(jiān)聽的方法removeListener和removeAllListeners，下面我們來看removeListener的程序流程圖：
接著來看removeListener的代碼：
removeListener(type,listener){
var list,events,position,i,originalListener;
events=this._events;
list=events[type];
//如果相應的事件對象的屬性值是一個函數，也就是說事件只被一個函數監(jiān)聽
if(list===listener){
if(--this._eventsCount===0){
this._events=Object.create(null);
}else{
delete events[type];
//如果存在對移除事件removeListener的監(jiān)聽函數，則觸發(fā)removeListener
if(events.removeListener)
this.emit('removeListener',type,listener);
}
}else if(typeof list!=='function'){
//如果相應的事件對象屬性值是一個函數數組
//遍歷這個數組，找出listener對應的那個函數，在數組中的位置
for(i=list.length-1;i>=0;i--){
if(list[i]===listener){
position=i;
break;
}
}
//沒有找到這個函數，則返回不做任何改動的對象
if(position){
return this;
}
//如果數組的第一個函數才是所需要刪除的對應listener函數，則直接移除
if(position===0){
list.shift();
}else{
list.splice(position,1);
}
if(list.length===1)
events[type]=list[0];
if(events.removeListener!==undefined)
this.emit('removeListener',type,listener);
}
return this;
}- 如果在之間設置了對于移除這個特殊事件“removeListener”的監(jiān)聽，那么就會在移除事件時候觸發(fā)“removeListener”事件。
最后來看removeAllListener，這個與removeListener相似，只要找到傳入的type所對應屬性的值，沒有遍歷過程，直接刪除這個屬性即可。
除此之外，還有其他的類似與once、setMaxListeners、listeners也可以在此基礎上實現，就不一一舉例。
總結
本文從node的EventEmitter模塊的使用出發(fā)，介紹了EventEmitter提供的常用API，然后介紹了node中基于EventEmitter的異常處理，最后自己實現了一個較為完整的EventEmitter模塊，希望能夠有所幫助，更多關于node EventEmitter模塊的資料請關注腳本之家其它相關文章！
相關文章
大量開發(fā)者的貢獻使Node版本的迭代速度很快，版本很多（橫跨0.6到0.11），所以升級Node版本就成為了一個問題。目前有n和nvm這兩個工具可以對Node進行無痛升級，本文簡單介紹一下二者的使用。2015-10-10
本文主要介紹了Express.js 全局錯誤處理實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-06-06
這篇文章主要介紹了關于NodeJs和JAVA建立socket連接方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-06-06
Node.js使用NodeMailer發(fā)送郵件實例代碼
本篇文章主要介紹了Node.js使用NodeMailer發(fā)送郵件實例代碼，具有一定的參考價值，有興趣的可以了解一下。2017-03-03
這篇文章主要介紹了nodejs中轉換URL字符串與查詢字符串詳解,需要的朋友可以參考下2014-11-11
這篇文章主要介紹了node.js中跨域請求實現方法詳解,本文通過實例代碼給大家介紹的非常詳細,需要的朋友可以參考下2024-12-12
本篇文章主要介紹了node結合swig渲染摸板的方法，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-04-04
本文詳細的介紹了什么是Puppeteer以及使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-01-01
這篇文章主要給大家介紹了關于Node.js文本文件BOM頭的去除方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-11-11
Node.js報錯信息Error:?Cannot?find?module?'XXX'問題及解
這篇文章主要介紹了Node.js報錯信息Error:?Cannot?find?module?'XXX'問題及解決方案,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-10-10