node.JS事件機制與events事件模組的使用方法詳解

阿新 • • 發佈：2020-02-07

node.JS事件機制說明

多數 Node.js 核心 API 都是採用慣用的非同步事件驅動架構，其中某些型別的物件（稱為觸發器）會週期性地觸發命名事件來呼叫函式物件（監聽器）。例如，一個net.Server物件會在每次有新連線時觸發一個事件；一個 fs.ReadStream 會在檔案被開啟時觸發一個事件；一個 stream會在資料可讀時觸發事件。

EventEmitter

EventEmitter 類由 events 模組定義和開放的，所有能觸發事件的物件都是 EventEmitter 類的例項

var EventEmitter = require('events');
/*
{ [Function: EventEmitter]
 EventEmitter: [Circular],usingDomains: false,defaultMaxListeners: [Getter/Setter],init: [Function],listenerCount: [Function] }
 */
console.log(EventEmitter);

events模組的EventEmitter屬性指向該模組本身

var events = require('events');
console.log(events.EventEmitter === events);//true
EventEmitter是一個建構函式，可以用來生成事件發生器的例項emitter
var EventEmitter = require('events');
var emitter = new EventEmitter();
/*
EventEmitter {
 domain: null,_events: {},_eventsCount: 0,_maxListeners: undefined }
 */
console.log(emitter);

方法

emitter.emit(eventName[,...args])

eventName <any>

...args <any>

該方法按監聽器的註冊順序，同步地呼叫每個註冊到名為eventName事件的監聽器，並傳入提供的引數。如果事件有監聽器，則返回true，否則返回false

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test1',function(){});
console.log(emitter.emit('test1'));//true
console.log(emitter.emit('test2'));//false

emitter.on(eventName,listener)

該方法用於新增listener函式到名為eventName的事件的監聽器陣列的末尾

eventName <any> 事件名

listener <Function> 回撥函式

[注意]不會檢查listener是否已被新增。多次呼叫並傳入相同的eventName和listener會導致listener被新增與呼叫多次

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
});
emitter.on('test',function(){
  console.log(2);
});
emitter.emit('test');//1 2

該方法返回一個 EventEmitter 引用，可以鏈式呼叫

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).on('test',function(){
  console.log(2);
});
emitter.emit('test');//1 2

emitter.addListener(eventName,listener)

emitter.on(eventName,listener) 的別名

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test',function(){
  console.log(1);
});
emitter.emit('test');//1

emitter.prependListener()

與on()方法不同，prependListener()方法可用於將事件監聽器新增到監聽器陣列的開頭

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).prependListener('test',function(){
  console.log(2);
});
emitter.emit('test');//2 1

emitter.once(eventName,listener)

該方法新增一個單次 listener 函式到名為 eventName 的事件。下次觸發 eventName 事件時，監聽器會被移除，然後呼叫

eventName <any> 事件名

listener <Function> 回撥函式

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).once('test',function(){
  console.log(2);
});
emitter.emit('test');//1 2
emitter.emit('test');//1

emitter.prependOnceListener()

該方法用於將事件監聽器新增到監聽器陣列開頭。下次觸發eventName事件時，監聽器會被移除，然後呼叫

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).prependOnceListener('test',function(){
  console.log(2);
});
emitter.emit('test');//2 1
emitter.emit('test');//1

emitter.removeAllListeners([eventName])

eventName <any>

移除全部或指定 eventName 的監聽器，返回一個 EventEmitter 引用，可以鏈式呼叫

[注意]在程式碼中移除其他地方新增的監聽器是一個不好的做法，尤其是當 EventEmitter 例項是其他元件或模組（如 socket 或檔案流）建立的

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).removeAllListeners('test');
emitter.emit('test');//''

emitter.removeListener(eventName,listener)

eventName <any>

listener <Function>

從名為 eventName 的事件的監聽器陣列中移除指定的 listener

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('test',show).removeListener('test',show);
emitter.emit('test');//''

[注意]removeListener最多隻會從監聽器數組裡移除一個監聽器例項。如果任何單一的監聽器被多次新增到指定eventName的監聽器陣列中，則必須多次呼叫removeListener才能移除每個例項

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('test',show).on('test',show);
emitter.emit('test');//'1'

[注意]一旦一個事件被觸發，所有繫結到它的監聽器都會按順序依次觸發。這意味著，在事件觸發後、最後一個監聽器完成執行前，任何 removeListener() 或 removeAllListeners() 呼叫都不會從 emit() 中移除它們。隨後的事件會像預期的那樣發生

因為監聽器是使用內部陣列進行管理的，所以呼叫它會改變在監聽器被移除後註冊的任何監聽器的位置索引。雖然這不會影響監聽器的呼叫順序，但意味著由 emitter.listeners() 方法返回的監聽器陣列副本需要被重新建立

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show1(){
  console.log(1);
  emitter.removeListener('test',show2);
}
function show2(){
  console.log(2);
}
emitter.on('test',show1).on('test',show2);
emitter.emit('test');//1 2
emitter.emit('test');//1

設定

emitter.eventNames()

返回一個列出觸發器已註冊監聽器的事件的陣列。陣列中的值為字串或符號

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test1',function(){console.log(1);});
emitter.addListener('test2',function(){console.log(2);});
console.log(emitter.eventNames());//[ 'test1','test2' ]

emitter.listenerCount(eventName)

eventName <any> 正在被監聽的事件名

返回正在監聽名為 eventName 的事件的監聽器的數量

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test',function(){console.log(1);});
emitter.addListener('test',function(){console.log(1);});
console.log(emitter.listenerCount('test'));//2

emitter.listeners(eventName)

eventName <any>

返回名為 eventName 的事件的監聽器陣列的副本

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test',function(){console.log(2);});
console.log(emitter.listeners('test'));//[ [Function],[Function] ]
emitter.listeners('test')[0]();//1

emitter.getMaxListeners()

返回 EventEmitter 當前的最大監聽器限制值

var EventEmitter = require('events');
var emitter = new EventEmitter();
console.log(emitter.getMaxListeners());//10

emitter.setMaxListeners(n)

預設情況下，如果為特定事件添加了超過 10 個監聽器，則 EventEmitter 會列印一個警告。此限制有助於尋找記憶體洩露。但是，並不是所有的事件都要被限為 10 個。 emitter.setMaxListeners() 方法允許修改指定的 EventEmitter 例項的限制。值設為 Infinity（或 0）表明不限制監聽器的數量。返回一個 EventEmitter 引用，可以鏈式呼叫

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('a',function(){}).on('a',function(){});
/*
Warning: Possible EventEmitter memory leak detected. 11 a listeners added. Use emitter.setMaxListeners() to increase limit
 */
var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.setMaxListeners(11);
emitter.on('a',function(){});

EventEmitter.defaultMaxListeners

每個事件預設可以註冊最多10個監聽器。單個EventEmitter例項的限制可以使用emitter.setMaxListeners(n)方法改變。所有EventEmitter例項的預設值可以使用EventEmitter.defaultMaxListeners屬性改變

[注意]設定 EventEmitter.defaultMaxListeners 要謹慎，因為會影響所有EventEmitter 例項，包括之前建立的。因而，呼叫 emitter.setMaxListeners(n) 優先於 EventEmitter.defaultMaxListeners

var EventEmitter = require('events');
var emitter = new EventEmitter();
EventEmitter.defaultMaxListeners = 11;
emitter.on('a',function(){});

node.JS事件註冊與刪除

'newListener' 事件

eventName <any> 要監聽的事件的名稱

listener <Function> 事件的控制代碼函式

EventEmitter 例項會在一個監聽器被新增到其內部監聽器陣列之前觸發自身的 'newListener' 事件

註冊了 'newListener' 事件的監聽器會傳入事件名與被新增的監聽器的引用。事實上，在新增監聽器之前觸發事件有一個微妙但重要的副作用： 'newListener' 回撥中任何額外的被註冊到相同名稱的監聽器會在監聽器被新增之前被插入

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('newListener',function(){
  console.log(2);
})
emitter.on('test',function(){
  console.log(1);
})
emitter.emit('test');//2 1
var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
})
emitter.on('newListener',function(){
  console.log(2);
})
emitter.emit('test');//1

'removeListener' 事件

eventName <any> 事件名

listener <Function> 事件控制代碼函式

'removeListener' 事件在 listener 被移除後觸發

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('removeListener',function(){
  console.log(2);//2
})
emitter.on('test',show);
var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('test',show);
emitter.on('removeListener',function(){
  console.log(2);//''
})
var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.removeListener('test',function(){
  console.log(2);//''

更多關於node.js事件的相關文章大家可以點選下面的相關連結

node.JS事件機制與events事件模組的使用方法詳解

node.JS事件機制說明

EventEmitter

方法

emitter.emit(eventName[,...args])

emitter.on(eventName,listener)

emitter.addListener(eventName,listener)

emitter.prependListener()

emitter.once(eventName,listener)

emitter.prependOnceListener()

emitter.removeAllListeners([eventName])

emitter.removeListener(eventName,listener)

設定

emitter.eventNames()

emitter.listenerCount(eventName)

emitter.listeners(eventName)

emitter.getMaxListeners()

emitter.setMaxListeners(n)

EventEmitter.defaultMaxListeners

node.JS事件註冊與刪除

'newListener' 事件

'removeListener' 事件

相關推薦