Node 中的 Events

Node 的 Events 模塊只定義了一個(gè)類，就是 EventEmitter（以下簡(jiǎn)稱 Event ），這個(gè)類在很多 Node 本身以及第三方模塊中大量使用，通常是用作基類被繼承。

在 Node 中，事件的應(yīng)用遍及代碼的每一個(gè)角落。

1. 事件和監(jiān)聽(tīng)器

Node 程序中的對(duì)象會(huì)產(chǎn)生一系列的事件，它們被稱為事件觸發(fā)器（event emitter），例如一個(gè) HTTP Server 會(huì)在每次有新連接時(shí)觸發(fā)一個(gè)事件，一個(gè) Readable Stream 會(huì)在文件打開(kāi)時(shí)觸發(fā)一個(gè)事件等。

所有能觸發(fā)事件的對(duì)象都是 EventEmitter 類的實(shí)例。EventEmitter 定義了 on 方法，該方法的聲明如下：

emitter.on(eventName, listener)
eventName <String> | <Symbol> The name of the event.
listener <Function> The callback function

on 方法接受兩個(gè)參數(shù)：需要監(jiān)聽(tīng)的事件的名稱，當(dāng)事件觸發(fā)時(shí)需要調(diào)用的函數(shù)。因?yàn)?EventEmitter 是接口，從 EventEmitter 繼承的類需要使用 new 關(guān)鍵字來(lái)構(gòu)造。

觸發(fā)事件監(jiān)聽(tīng)器很簡(jiǎn)單，只要調(diào)用 EventEmitter實(shí)例的 emit 方法就行了。需要注意的是，這些事件是針對(duì)某個(gè)實(shí)例的，不存在全局的事件。當(dāng)你調(diào)用 on 方法的時(shí)候，需要綁定在特定的基于 EventEmitter 的對(duì)象上。EventEmitter 類不同的實(shí)例之間也不會(huì)共享事件。

下面是一個(gè)事件注冊(cè)和觸發(fā)事件的例子。

const eventEmitter = require('events');
const myEmitter = new eventEmitter();
myEmitter.on('begin', () => {
  console.log('begin');
});
myEmitter.emit('begin');

上面的代碼中，首先初始化了一個(gè) EventEmitter 實(shí)例，然后注冊(cè)了一個(gè)名為 begin 的事件，之后調(diào)用 emit 方法觸發(fā)了這一事件。

用戶可以注冊(cè)多個(gè)同名的事件，在上面的例子中，如果注冊(cè)兩個(gè)名為 begin 的事件，那么它們都會(huì)被觸發(fā)。

如果想獲取當(dāng)前的 emitter 一共注冊(cè)了哪些事件，可以使用 eventNames 方法。

console.log(myEmitter.eventNames());

該方法會(huì)輸出包括全部事件名稱的數(shù)組。就算注冊(cè)了兩個(gè)同名的 event，輸出結(jié)果也只有一個(gè)，說(shuō)明該方法的結(jié)果集并不包含重復(fù)結(jié)果。

2. 處理 error 事件

由于 Node 代碼運(yùn)行在單線程環(huán)境中，那么運(yùn)行時(shí)出現(xiàn)的任何錯(cuò)誤都有可能導(dǎo)致整個(gè)進(jìn)程退出。利用事件機(jī)制可以實(shí)現(xiàn)簡(jiǎn)單的錯(cuò)誤處理功能。

當(dāng) Node 程序出現(xiàn)錯(cuò)誤的時(shí)候，通常會(huì)觸發(fā)一個(gè)錯(cuò)誤事件，如果代碼中沒(méi)有注冊(cè)相應(yīng)的處理方法，會(huì)導(dǎo)致 Node 進(jìn)程崩潰退出。例如：

myEmitter.emit("error", new Error("crash!"));

上面的代碼主動(dòng)拋出了一個(gè) emor，相當(dāng)于：

throw new Error ("crash");

如果我們不想因?yàn)閽伋鲆粋€(gè) error 而使進(jìn)程退出，那么可以讓 uncaughtException 事件作為最后一道防線來(lái)捕獲異常。

const eventEmitter = require('events');
const myEmitter = new eventEmitter();
process.on('uncaughtException', () => {
  console.log('got error');
});
throw new Error('Error occurred');

這種錯(cuò)誤處理的方式雖然可以捕獲異常，避免了進(jìn)程的退出，但不值得提倡。

關(guān)于其常見(jiàn)的方法如下：

• emitter.addListener/on(eventName, listener) ：添加類型為 eventName 的監(jiān)聽(tīng)事件到事件數(shù)組尾部
• emitter.prependListener(eventName, listener)：添加類型為 eventName 的監(jiān)聽(tīng)事件到事件數(shù)組頭部
• emitter.emit(eventName[, ...args])：觸發(fā)類型為 eventName 的監(jiān)聽(tīng)事件
• emitter.removeListener/off(eventName, listener)：移除類型為 eventName 的監(jiān)聽(tīng)事件
• emitter.once(eventName, listener)：添加類型為 eventName 的監(jiān)聽(tīng)事件，以后只能執(zhí)行一次并刪除
• emitter.removeAllListeners([eventName])： 移除全部類型為 eventName 的監(jiān)聽(tīng)事件

3. 繼承 Events 模塊

在實(shí)際的開(kāi)發(fā)中，通常不會(huì)直接使用 Event 模塊來(lái)進(jìn)行事件處理，而是選擇將其作為基類進(jìn)行繼承的方式來(lái)使用 Event，在 Node 的內(nèi)部實(shí)現(xiàn)中，凡是提供了事件機(jī)制的模塊，都會(huì)在內(nèi)部繼承 Event 模塊。

4. 手寫 EventEmitter

下面我們來(lái)看看如何手寫一個(gè) EventEmitter。

class EventEmitter {
  constructor() {
    this.events = {};
  }
  on(type, handler) {
    if (!this.events[type]) {
      this.events[type] = [];
    }
    this.events[type].push(handler);
  }
  addListener(type, handler) {
    this.on(type, handler)
  }
  prependListener(type, handler) {
    if (!this.events[type]) {
      this.events[type] = [];
    }
    this.events[type].unshift(handler);
  }
  removeListener(type, handler) {
    if (!this.events[type]) {
      return;
    }
    this.events[type] = this.events[type].filter(item => item !== handler);
  }
  off(type, handler) {
    this.removeListener(type, handler)
  }
  emit(type, ...args) {
    this.events[type].forEach((item) => {
      Reflect.apply(item, this, args);
    });
  }
  once(type, handler) {
    this.on(type, this._onceWrap(type, handler, this));
  }
  _onceWrap(type, handler, target) {
    const state = {
      fired: false,
      handler,
      type,
      target
    };
    const wrapFn = this._onceWrapper.bind(state);
    state.wrapFn = wrapFn;
    return wrapFn;
  }
  _onceWrapper(...args) {
    if (!this.fired) {
      this.fired = true;
      Reflect.apply(this.handler, this.target, args);
      this.target.off(this.type, this.wrapFn);
    }
  }
}

到此這篇關(guān)于Node中的Events事件介紹及應(yīng)用的文章就介紹到這了,更多相關(guān)Node Events內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論