淺析Node的events模組

在 vue 的專案中，有時我們會用到全域事件匯流排來管理元件之間的通訊。 vue2 專案裡我們可以自己使用$emit、 $on 和$off 封裝一個eventHub;vue3 中$on 和$off 被移除了，我們可以使用mitt 函式庫或tiny-emitter 函式庫。在 node 裡，則不用這麼麻煩，其有個內建的 events 模組就可以幫我們實現對於事件的監聽和發射。

事件的監聽和發射

先使用CommonJS 的語法導入得到EventEmitter 類，然後產生實例emitter#（ EventEmitter 十分重要，例如後續文章會介紹的stream 就是EventEmitter 的實例）：

const EventEmitter = require('events')
const emitter = new EventEmitter()

接著就可以使用emitter .on() 對事件進行監聽，傳入的第1 個參數就是事件名稱，第2 個參數為監聽到事件被發射後要執行的回調，如果發射事件時有傳入參數，會傳遞給回呼函數，可以一個個單獨獲取，也可以像下面這樣使用函數的剩餘參數獲取：  【相關教程推薦：nodejs視頻教程、編程教學】

// 监听事件
emitter.on('test', (...args) => {
  console.log(args) // [ 1, 2, 3 ]
})
// 发射事件
emitter.emit('test', 1, 2, 3)

如果只需要監聽一次事件，可以使用emitter.once()：

emitter.once('test', () => {
  console.log('监听到了事件发射')
})

emitter.emit('test')
emitter.emit('test') // 本次发射不会触发打印

如果有多個地方如下例所示對事件進行了監聽，一旦事件發射，那麼監聽回調會按順序依次觸發：

emitter.on('test', () => {
  console.log('监听到了事件发射，1')
})
emitter.on('test', () => {
  console.log('监听到了事件发射，2')
})
emitter.emit('test')

執行結果：

如果想把監聽事件添加到最前面，可以使用emitter.prependListener()（或emitter.prependOnceListener()，即提前但只監聽一次）：

emitter.on('test', () => {
  console.log('监听到了事件发射，1')
})
emitter.prependListener('test', () => {
  console.log('监听到了事件发射，2')
})

emitter.emit('test')

現在的結果如下：

移除事件監聽

可以使用emitter.off()（或emitter.removeListener ()）移除對事件的監聽，但需要傳入對應的事件名稱和回呼函數，所以我們在監聽時的回呼就不能直接像上面這樣定義在emitter.on() 內部了，需要在外部定義然後傳入對該回調的引用：

function handler(...args) {
  console.log(args) // [ 1, 2, 3 ]
}
emitter.on('test', handler)
emitter.emit('test', 1, 2, 3) 
emitter.off('test', handler)
emitter.emit('test', '无法被监听到')

emitter.off()只能移除一個監聽，且必須傳入監聽回調，如果有多次監聽，想全部移除，可以使用emitter.removeAllListeners()：

emitter.on('test', handler)
emitter.on('test', handler)
emitter.on('test', handler)

emitter.removeAllListeners()

emitter.removeAllListeners()如果不傳入任何參數，則移除所有事件名稱的所有事件監聽。其也可以傳入事件名稱，則移除所有對應事件名稱的事件監聽。

其它一些方法

監聽器數量限制

1 個EventEmitter 物件上，某個事件名稱的最大監聽器數量預設為10，可以透過emitter.getMaxListeners() 來驗證：

console.log(emitter.getMaxListeners()) // 10

例如寫了11 次emitter.on('test ', handler)，就會報錯，提示說要用emitter.setMaxListeners() 來增加最大限制數量：

如果我們想知道目前EventEmitter 物件上某個事件名稱的監聽器有多少個，有沒有超過最大限制，可以使用emitter.listenerCount() 傳入事件名稱查看：

console.log(emitter.listenerCount('test'))

取得事件名稱和監聽器

使用emitter.eventNames() 可以取得目前EventEmitter 物件上註冊的所有事件名稱，傳回的是由事件字串組成的陣列：

emitter.on('test1', handler)
emitter.on('test2', handler)

console.log(emitter.eventNames()) // [ 'test1', 'test2' ]

如果想要取得某個事件對應的所有監聽器，可以使用emitter.listeners() 並傳入事件名稱：

function handler1() {}
function handler2() {}
emitter.on('test', handler1)
emitter.on('test', handler2)

console.log(emitter.listeners('test'))

得到的結果如下：

更多node相關知識，請造訪：nodejs 教學！

以上是淺析Node的events模組的詳細內容。更多資訊請關注PHP中文網其他相關文章！