Nodejs 的大部分核心 API 都是基于異步事件驅(qū)動設(shè)計的，事件驅(qū)動核心是通過 node 中 Events 對象來實現(xiàn)事件的發(fā)送和監(jiān)聽回調(diào)綁定，我們常用的 stream 模塊也是依賴于 Events 模塊是來實現(xiàn)數(shù)據(jù)流之間的回調(diào)通知，如在數(shù)據(jù)到來時觸發(fā) data 事件，流對象為可讀狀態(tài)觸發(fā) readable 事件,當數(shù)據(jù)讀寫完畢后發(fā)送 end 事件。

既然 Events 模塊如此重要，我們有必要來學(xué)習(xí)一下 Events 模塊的基本使用，以及如何模擬實現(xiàn) Events 模塊中常用的 api

一、Events 模塊的基本使用以及簡單實現(xiàn)

首先我們了解一下 Events 模塊的基本用法，其實 Events 模塊本質(zhì)上是觀察者模式的實現(xiàn)，所謂觀察者模式就是：

它定義了對象間的一種一對多的關(guān)系，讓多個觀察者對象同時監(jiān)聽某一個主題對象，當一個對象發(fā)生改變時，所有依賴于它的對象都將得到通知

觀察者模式有對應(yīng)的觀察者以及被觀察的對象，在 Events 模塊中，對應(yīng)的實現(xiàn)就是 on 和 emit 函數(shù)

const EventEmitter = require('events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('嗨', (str) => {
 console.log(str);
});
myEmitter.emit('嗨','你好');

從上述的使用中，我們可以知道 on 是用來監(jiān)聽事件的發(fā)生，而 emit 是用來觸發(fā)事件的發(fā)生，一旦 emit 觸發(fā)了事件，on 就會被通知到，從而執(zhí)行對應(yīng)的回調(diào)函數(shù)。

有了這個實例，我們可以思考下如何實現(xiàn)這個 EventEmitter 類。

思路：當我們執(zhí)行 on 函數(shù)時，我們可以將回調(diào)函數(shù)保存起來，等到 emit 觸發(fā)了事件時，將回調(diào)函數(shù)拿出來執(zhí)行，那么就可以實現(xiàn)了事件的監(jiān)聽以及訂閱了。

class EventEmitter{
 constructor(){
  #事件監(jiān)聽函數(shù)保存的地方
  this.events={};
 }
 on(eventName,listener){
  if (this.events[eventName]) {
   this.events[eventName].push(listener);
  } else {
   #如果沒有保存過，將回調(diào)函數(shù)保存為數(shù)組
   this.events[eventName] = [listener];
  }
 }
 emit(eventName){
  #emit觸發(fā)事件，把回調(diào)函數(shù)拉出來執(zhí)行
  this.events[eventName] && this.events[eventName].forEach(listener => listener())
 }
}

上述就實現(xiàn)了一個簡單的 EventEmitter 類，下面來實例一下：

let event = new EventEmitter();
event.on('嗨',function(){
 console.log('你好');
});
event.emit('嗨');
#輸出：你好

完善：我們注意到在原生的 EventEmitter 類中，emit 是可以傳遞參數(shù)到我們的回調(diào)函數(shù)中，那么我們實現(xiàn)的類也應(yīng)該支持傳遞參數(shù)。我們對 emit 進行如下更改

emit(eventName,...rest){
 #emit觸發(fā)事件，把回調(diào)函數(shù)拉出來執(zhí)行
 this.events[eventName] && this.events[eventName].forEach(listener => listener.apply(this,rest))
}

完善之后，重新實例化，如下:

let event = new EventEmitter();
event.on('嗨',function(str){
 console.log(str);
});
event.emit('嗨','你好');
#輸出：你好

二、Events 模塊中常用的 api

Events 模塊中除了 on、emit 函數(shù)之外，還包含了很多常用的 api，我們一一來介紹幾個實用的 api

1. addListener 與 on 方法使用與實現(xiàn)

在 Events 模塊中，addListener 與 on 方法的使用是完成相同的，只是名字不同，我們可以通過原型來給兩個函數(shù)建立相等關(guān)聯(lián)

EventEmitter.prototype.addListener=EventEmitter.prototype.on

2. removeListener 與 off 方法使用與實現(xiàn)

removeListener 方法可以從指定名字的監(jiān)聽器數(shù)組中移除指定的 listener，這樣的話，當再次 emit 事件的時候，不會觸發(fā) on 綁定的回調(diào)函數(shù)，如下：

const EventEmitter = require('events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
let callback = (str) => {
 console.log(str);
}
myEmitter.on('嗨', callback);
myEmitter.emit('嗨','你好');#輸出：你好
myEmitter.removeListener('嗨',callback);
myEmitter.emit('嗨','你好');#無輸出

實現(xiàn)思路：我們只要在執(zhí)行 removeListener 函數(shù)的時候，將先前保存的回調(diào)函數(shù)去除掉即可

removeListener (eventName,listener) {
 #保證回調(diào)函數(shù)數(shù)組存在，同時去除指定的listener
 this.events[eventName] && this.events[eventName] = this.events[eventName].filter(l => l != listener);
}

同時 removeListener 與 off 方法也是功能完全相同，只是命名不同，因此可以通過如下方法賦值：

EventEmitter.prototype.removeListener=EventEmitter.prototype.off

3. removeAllListeners 方法使用與實現(xiàn)

removeAllListeners 移除全部監(jiān)聽器或指定的 eventName 事件的監(jiān)聽器，其實 removeAllListeners 就包含了 removeListener 的功能，只是 removeListener 只能指定特定的監(jiān)聽器，removeAllListeners 可以移除全部監(jiān)聽器。

實現(xiàn)思路：在執(zhí)行 removeAllListeners，將所有的回調(diào)函數(shù)都給去除即可

removeAllListeners (eventName) {
 #移除全部監(jiān)聽器
 delete this.events[eventName]
}

4. once 方法使用與實現(xiàn)

once 方法的描述是添加單次監(jiān)聽器 listener 到名為 eventName 的事件，其實就是通過 once 添加的監(jiān)聽器，只能執(zhí)行一次，執(zhí)行一次之后就會被銷毀，不能再次執(zhí)行

const EventEmitter = require('events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.once('嗨', (str) => {
 console.log(str);
});
myEmitter.emit('嗨','你好');
myEmitter.emit('嗨','你好');
myEmitter.emit('嗨','你好'); #只能輸出一次你好

實現(xiàn)思路：當 once 監(jiān)聽的事件回調(diào)函數(shù)執(zhí)行之后，通過 removeListener 將事件監(jiān)聽器給解綁掉，那么事件再次被 emit 的時候，就不會再次執(zhí)行回調(diào)，這樣就能保證事件回調(diào)只能執(zhí)行一次

once (eventName, listener) {
 #重新改變監(jiān)聽回調(diào)函數(shù)，使其執(zhí)行之后可以被銷毀
 let reListener = (...rest) => {
  listener.apply(this,rest);
  #執(zhí)行完之后解除事件綁定
  this.removeListener(type,wrapper);
 }
 this.on(eventName,reListener);
}

5. listeners 方法使用與實現(xiàn)

listeners 方法返回名為 eventName 的事件的監(jiān)聽器數(shù)組的副本，其實就是獲取 eventName 中所有的回調(diào)函數(shù)，這個實現(xiàn)起來很容易，就不多贅述了，代碼如下：

listeners (eventName) {
 return this.events[eventName]
}

6. setMaxListeners 方法使用與實現(xiàn)

默認情況下，如果為特定事件添加了超過 10 個監(jiān)聽器，則 EventEmitter 會打印一個警告。 這有助于發(fā)現(xiàn)內(nèi)存泄露， 但是，并不是所有的事件都要限制 10 個監(jiān)聽器。 emitter.setMaxListeners() 方法可以為指定的 EventEmitter 實例修改限制。 值設(shè)為 Infinity（或 0）表示不限制監(jiān)聽器的數(shù)量。

const EventEmitter = require('events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
let callback = (str) => {
 console.log(str);
}
for (let i = 0; i <= 11; i++) {
 myEmitter.on('嗨', callback);
}
myEmitter.emit('嗨', '你好');

輸入結(jié)果如圖：

實現(xiàn)思路：

我們先將特定事件的監(jiān)聽器最大設(shè)置為常量10

constructor(){
 #事件監(jiān)聽函數(shù)保存的地方
 this.events={};
 #最大監(jiān)聽器數(shù)量
 this._maxListeners = 10;
}

然后在我們的 on 函數(shù)中，對這個監(jiān)聽器的數(shù)量進行判斷，從而作出提示

on(eventName,listener){
 if (this.events[eventName]) {
  this.events[eventName].push(listener);
  #如果超過最大限度，以及不為0，則作出內(nèi)存泄漏提示
  if (this._maxListeners != 0 && this.events[type].length >= this._maxListeners) {
   console.error('超過最大的監(jiān)聽數(shù)量可能會導(dǎo)致內(nèi)存泄漏');
  }
 } else {
  #如果沒有保存過，將回調(diào)函數(shù)保存為數(shù)組
  this.events[eventName] = [listener];
 }
}

我們也支持對 _maxListeners 變量根據(jù)用戶的輸入進行更改，即我們的 setMaxListeners() 函數(shù)

setMaxListeners(MaxListeners) {
 this._maxListeners = MaxListeners
}

三、總結(jié)

本文從 node 的 Events 模塊出發(fā)，然后去介紹了 Events 模塊常用 API 的使用，從中通過一步一步簡易去思考這些 API 使用的內(nèi)部原理，簡易的實現(xiàn)了這些 API，希望大家看完文章之后，能對 Events 模塊有進一步的理解。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評論