極簡 Node.js 入門 - 2.2 事件

謙行發表於2020-08-11
Node.js事件

極簡 Node.js 入門系列教程：https://www.yuque.com/sunluyong/node

本文更佳閱讀體驗：https://www.yuque.com/sunluyong/node/events

前端對事件肯定不陌生，為 window 繫結 scroll 事件

window.addEventListener('scroll', ev => {
	console.log(ev);
});

Node.js 大部分非同步操作使用事件驅動，所有可以觸發事件的物件都繼承了 EventEmitter 類

事件監聽

on

Node.js 事件監聽使用和 jQuery API 非常類似emitter.on(eventName, listener)

const ee = new EventEmitter();
ee.on('foo', () => console.log('a'));
  1. EventEmitter 例項會維護一個 listener 陣列，每次 listener 預設會被新增到陣列尾部
  2. 每次新增 listener 不會檢查是否新增過，多次呼叫 on 傳入相同的 eventName 和 listener，會導致 listener 被新增多次

prependListener

emitter.prependListener(eventName, listener) 
通過 prependListener 可以把 listener 新增到 listener 陣列頭部

const ee = new EventEmitter();
ee.prependListener('foo', () => console.log('a'));

once

如果希望 listener 被觸發一次後就不再觸發，可以使用 once 來繫結事件

const ee = new EventEmitter();
ee.once('foo', () => console.log('a'));

事件觸發

emitter.emit(eventName[, ...args])
在瀏覽器環境中開發者事件相關的大部分工作是訂閱事件，也就是繫結事件處理函式 listener，在 Node.js 事件程式設計中經常需要建立事件物件，在合理實際觸發事件。使用 emit 方法可以按照 listener 註冊的順序，同步地呼叫每個註冊到名為 eventName 的事件的監聽器，並傳入提供的引數

const EventEmitter = require('events');
const myEmitter = new EventEmitter();

// 第一個監聽器。
myEmitter.on('event', function firstListener() {
  console.log('第一個監聽器');
});
// 第二個監聽器。
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`第二個監聽器中的事件有引數 ${arg1}、${arg2}`);
});
// 第三個監聽器
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`第三個監聽器中的事件有引數 ${parameters}`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// 第一個監聽器
// 第二個監聽器中的事件有引數 1、2
// 第三個監聽器中的事件有引數 1, 2, 3, 4, 5

this 指向

eventEmitter.emit() 方法可以傳任意數量的引數到 listener， this 關鍵詞會被指向 listener 所繫結的 EventEmitter 例項

const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this, this === myEmitter);
  // 列印:
  //   a b MyEmitter {
  //     domain: null,
  //     _events: { event: [Function] },
  //     _eventsCount: 1,
  //     _maxListeners: undefined } true
});
myEmitter.emit('event', 'a', 'b');

也可以使用 ES6 的箭頭函式作為監聽器。但 this 關鍵詞不會指向 EventEmitter 例項：

const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
  // 列印: a b {}
});
myEmitter.emit('event', 'a', 'b');

非同步呼叫

EventEmitter 以註冊的順序同步地呼叫所有 listener，這樣可以確保事件的正確排序，listener 可以使用 setImmediate() 和 process.nextTick() 方法切換到非同步的操作模式

const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('非同步地發生');
  });
});
myEmitter.emit('event', 'a', 'b');

事件解除安裝

Node.js 提供了幾種解除安裝事件繫結的方法

off/removeListener

off 方法是 removeListener 方法的別名，用於清理事件繫結 emitter.removeListener(eventName, listener)

const callback = (stream) => {
  console.log('已連線');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() 最多隻會從監聽器陣列中移除一個監聽器。 如果監聽器被多次新增到指定 eventName 的監聽器陣列中，則必須多次呼叫 removeListener() 才能移除所有例項

removeAllListeners

emitter.removeAllListeners([eventName]) 
移除指定的 eventName 事件的 listener，如果沒有指定 eventName，則移除事件物件的所有 listener。可以通過 emitter.eventNames() 獲取事件物件上的 eventName 陣列

const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

myEE.eventNames().forEach(eventName => myEE.removeAllListeners);

相關文章