Node.js 大部分异步操作使用事件驱动,所有可以触发事件的对象都继承了 EventEmitter

事件监听

on

  1. EventEmitter 实例会维护一个 listener 数组,每次 listener 默认会被添加到数组尾部
  2. 每次添加 listener 不会检查是否添加过,多次调用 on 传入相同的 eventName 和 listener,会导致 listener 被添加多次
    1. 当该事件触发时,注册过的回调函数,都会被执行 ```javascript const EventEmitter = require(‘events’) // 用于管理事件的实例 const eventEmitter = new EventEmitter()

// 监听事件 eventEmitter.on(‘foo’, () => console.log(‘foo1’)) eventEmitter.on(‘foo’, () => console.log(‘foo2’))

  1. <a name="CMjGt"></a>
  2. ## prependListener
  3. `emitter.prependListener(eventName, listener)` <br />通过 prependListener 可以把 listener 添加到 listener 数组头部
  4. > 决定了相同事件的回调函数的执行顺序
  5. ```javascript
  6. const EventEmitter = require('events')
  7. // 用于管理事件的实例
  8. const eventEmitter = new EventEmitter()
  9. // 监听事件
  10. eventEmitter.prependListener('foo', () => console.log('foo1'))
  11. eventEmitter.prependListener('foo', () => console.log('foo2'))
  12. // 当 foo 事件触发时,会先打印出 foo2,再打印出 foo1

once

如果希望 listener 被触发一次后就不再触发,可以使用 once 来绑定事件

多次触发事件,只执行一次。

  1. const EventEmitter = require('events')
  2. // 用于管理事件的实例
  3. const eventEmitter = new EventEmitter()
  4. // 监听事件
  5. eventEmitter.once('foo', () => console.log('foo1'))

事件触发

emitter.emit(eventName[, ...args])
在浏览器环境中开发者事件相关的大部分工作是订阅事件,也就是绑定事件处理函数 listener。
在 Node.js 事件编程中经常需要创建事件对象,在合理实际触发事件。使用 emit 方法可以按照 listener 注册的顺序,同步地调用每个注册到名为 eventName 的事件的监听器,并传入提供的参数。

  1. const EventEmitter = require('events')
  2. // 用于管理事件的实例
  3. const eventEmitter = new EventEmitter()
  4. // 监听事件
  5. eventEmitter.on('foo', (...args) => console.log('foo1', args))
  6. eventEmitter.on('foo', (...args) => console.log('foo2', args))
  7. eventEmitter.on('foo', (...args) => console.log('foo3', args))
  8. eventEmitter.emit('foo', 1, 2, 3)
  9. // foo1 [ 1, 2, 3 ]
  10. // foo2 [ 1, 2, 3 ]
  11. // foo3 [ 1, 2, 3 ]

this 的指向

eventEmitter.emit() 方法可以传任意数量的参数到 listener, this 会被指向 listener 所绑定的 EventEmitter 实例

  1. const EventEmitter = require('events')
  2. // 用于管理事件的实例
  3. const eventEmitter = new EventEmitter()
  4. // 监听事件
  5. eventEmitter.on('foo', function (...args) {
  6. console.log(this === eventEmitter) // true
  7. })
  8. eventEmitter.emit('foo', 1, 2, 3)

事件卸载

off / removeListener

off 方法是 removeListener 方法的别名,用于清理事件绑定。
emitter.removeListener(eventName, listener) 或者emitter.off(eventName, listener)

removeListener()/off() 最多只会从监听器数组中移除一个监听器。 如果监听器被多次添加到指定 eventName 的监听器数组中,则必须多次调用 removeListener() 才能移除所有实例

  1. const EventEmitter = require('events')
  2. // 用于管理事件的实例
  3. const eventEmitter = new EventEmitter()
  4. const callback1 = (...args) => console.log('foo1', ...args)
  5. const callback2 = (...args) => console.log('foo2', ...args)
  6. // 监听事件
  7. eventEmitter.on('foo', callback1)
  8. eventEmitter.on('foo', callback2)
  9. // 卸载事件
  10. eventEmitter.off('foo', callback1)
  11. // 派发事件
  12. eventEmitter.emit('foo') // foo2
  13. eventEmitter.removeListener('foo', callback2)

removeAllListener

emitter.removeAllListeners([eventName])
移除指定的 eventName 事件的 listener,如果没有指定 eventName,则移除事件对象的所有 listener。

  1. const EventEmitter = require('events')
  2. // 用于管理事件的实例
  3. const eventEmitter = new EventEmitter()
  4. const callback1 = (...args) => console.log('foo', ...args)
  5. const callback2 = (...args) => console.log('bar', ...args)
  6. // 监听事件
  7. eventEmitter.on('foo', callback1)
  8. eventEmitter.on('bar', callback2)
  9. // 卸载事件
  10. eventEmitter.removeAllListeners('foo')
  11. eventEmitter.emit('foo')
  12. eventEmitter.emit('bar') // bar

可以通过 emitter.eventNames() 获取事件对象上的 eventName 数组。

  1. const EventEmitter = require('events')
  2. // 用于管理事件的实例
  3. const eventEmitter = new EventEmitter()
  4. const callback1 = (...args) => console.log('foo', ...args)
  5. const callback2 = (...args) => console.log('bar', ...args)
  6. // 监听事件
  7. eventEmitter.on('foo', callback1)
  8. eventEmitter.on('bar', callback2)
  9. // 卸载事件
  10. eventEmitter.eventNames().forEach(eventName => eventEmitter.removeAllListeners(eventName))
  11. eventEmitter.emit('foo')
  12. eventEmitter.emit('bar')