events 模块只提供了一个对象: events.EventEmitter。
【EventEmitter 的核心就是事件触发与事件监听器功能的封装。】
EventEmitter 的每个事件由一个事件名和若干个参 数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter 支持 若干个事件监听器。当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作 为回调函数参数传递。
例子:
var events = require('events'); var emitter = new events.EventEmitter(); emitter.on('某个事件名', function(arg1, arg2) { console.log('监听器1', arg1, arg2) }); emitter.on('某个事件名', function(arg1, arg2) { console.log('监听器2', arg1, arg2) }); emitter.emit('某个事件名', 'hello', world);
运行的结果是:
监听器1 hello world
监听器2 hello world
在上面的例子中,emitter为某个事件注册了连个事件监听器,然后触发了某个事件。然后两个事件监听器被先后调用。
EventEmitter常用API:
EventEmitter.on(event, listener) //为指定事件注册一个监听器,接受一个字符串event 和一个回调函数listener。
EventEmitter.emit(event, [arg1], [arg2], [...])
// 触发 event 事件,传递若干可选参数到事件监听器的参数表。
EventEmitter.once(event, listener)
// 为指定事件注册一个单次监听器,即监听器最多只会触发一次,触发后立刻解除该监听器
EventEmitter.removeListener(event, listener)
// 移除指定事件的某个监听器,listener 必须是该事件已经注册过的监听器。
EventEmitter.removeAllListeners([event])
// 移除所有事件的所有监听器, 如果指定 event,则移除指定事件的所有监听器。
更多api可参考:http://nodejs.cn/api/events.html
【error事件】
EventEmitter 定义了一个特殊的事件 error,它包含了“错误”的语义,我们在遇到 异常的时候通常会发射 error 事件。当 error 被触发时,EventEmitter 规定如果没有响 应的监听器,Node.js 会把它当作异常,退出程序并打印调用栈。我们一般要为会发射 error 事件的对象设置监听器,避免遇到错误后整个程序崩溃。
例子:
var events = require('events'); var emitter = new events.EventEmitter(); emitter.emit('error');
运行时报错如下:
Error: Unhandled "error" event
at EventEmitter.emit (events.js:175:14)
【大多数情况下我们并不会直接去使用EventEmitter,而是在对象中继承它。】
包括 fs、net、 http 在内的,只要是支持事件响应的核心模块都是 EventEmitter 的子类。