Node.js 大部分异步操作使用事件驱动,所有可以触发事件的对象都继承了 EventEmitter
类
事件监听
on
- EventEmitter 实例会维护一个 listener 数组,每次 listener 默认会被添加到数组尾部
- 每次添加 listener 不会检查是否添加过,多次调用 on 传入相同的 eventName 和 listener,会导致 listener 被添加多次
- 当该事件触发时,注册过的回调函数,都会被执行 ```javascript const EventEmitter = require(‘events’) // 用于管理事件的实例 const eventEmitter = new EventEmitter()
// 监听事件 eventEmitter.on(‘foo’, () => console.log(‘foo1’)) eventEmitter.on(‘foo’, () => console.log(‘foo2’))
<a name="CMjGt"></a>
## prependListener
`emitter.prependListener(eventName, listener)` <br />通过 prependListener 可以把 listener 添加到 listener 数组头部
> 决定了相同事件的回调函数的执行顺序
```javascript
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
// 监听事件
eventEmitter.prependListener('foo', () => console.log('foo1'))
eventEmitter.prependListener('foo', () => console.log('foo2'))
// 当 foo 事件触发时,会先打印出 foo2,再打印出 foo1
once
如果希望 listener 被触发一次后就不再触发,可以使用 once 来绑定事件
多次触发事件,只执行一次。
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
// 监听事件
eventEmitter.once('foo', () => console.log('foo1'))
事件触发
emitter.emit(eventName[, ...args])
在浏览器环境中开发者事件相关的大部分工作是订阅事件,也就是绑定事件处理函数 listener。
在 Node.js 事件编程中经常需要创建事件对象,在合理实际触发事件。使用 emit 方法可以按照 listener 注册的顺序,同步地调用每个注册到名为 eventName 的事件的监听器,并传入提供的参数。
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
// 监听事件
eventEmitter.on('foo', (...args) => console.log('foo1', args))
eventEmitter.on('foo', (...args) => console.log('foo2', args))
eventEmitter.on('foo', (...args) => console.log('foo3', args))
eventEmitter.emit('foo', 1, 2, 3)
// foo1 [ 1, 2, 3 ]
// foo2 [ 1, 2, 3 ]
// foo3 [ 1, 2, 3 ]
this 的指向
eventEmitter.emit()
方法可以传任意数量的参数到 listener, this
会被指向 listener 所绑定的 EventEmitter 实例
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
// 监听事件
eventEmitter.on('foo', function (...args) {
console.log(this === eventEmitter) // true
})
eventEmitter.emit('foo', 1, 2, 3)
事件卸载
off / removeListener
off 方法是 removeListener 方法的别名,用于清理事件绑定。emitter.removeListener(eventName, listener)
或者emitter.off(eventName, listener)
removeListener()/off()
最多只会从监听器数组中移除一个监听器。 如果监听器被多次添加到指定 eventName 的监听器数组中,则必须多次调用 removeListener() 才能移除所有实例
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
const callback1 = (...args) => console.log('foo1', ...args)
const callback2 = (...args) => console.log('foo2', ...args)
// 监听事件
eventEmitter.on('foo', callback1)
eventEmitter.on('foo', callback2)
// 卸载事件
eventEmitter.off('foo', callback1)
// 派发事件
eventEmitter.emit('foo') // foo2
eventEmitter.removeListener('foo', callback2)
removeAllListener
emitter.removeAllListeners([eventName])
移除指定的 eventName 事件的 listener,如果没有指定 eventName,则移除事件对象的所有 listener。
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
const callback1 = (...args) => console.log('foo', ...args)
const callback2 = (...args) => console.log('bar', ...args)
// 监听事件
eventEmitter.on('foo', callback1)
eventEmitter.on('bar', callback2)
// 卸载事件
eventEmitter.removeAllListeners('foo')
eventEmitter.emit('foo')
eventEmitter.emit('bar') // bar
可以通过 emitter.eventNames()
获取事件对象上的 eventName 数组。
const EventEmitter = require('events')
// 用于管理事件的实例
const eventEmitter = new EventEmitter()
const callback1 = (...args) => console.log('foo', ...args)
const callback2 = (...args) => console.log('bar', ...args)
// 监听事件
eventEmitter.on('foo', callback1)
eventEmitter.on('bar', callback2)
// 卸载事件
eventEmitter.eventNames().forEach(eventName => eventEmitter.removeAllListeners(eventName))
eventEmitter.emit('foo')
eventEmitter.emit('bar')