Node.js中核心API都采用异步事件驱动,所有可能触发事件的对象都是继承自events模块EventEmitter类的子类实例对象。核心API中特定类型的对象会触发命名事件来调用函数,这种特定类型的对象又称为事件触发器(Emitter),被调用的函数又称为事件监听器(Listener)。
Node.js中所有的异步I/O操作会在完成时发送一个事件到事件队列,Node.js中很多对象都会分发事件。
例如:
-
net.Server
对象每次会在新连接时会触发事件 -
fs.ReadStream
对象会在打开文件时触发事件 -
stream
会在数据可读时触发事件
简单来说,所有能产生事件的对象都是events.EventEmitter
类的实例。
订阅发布 Subscribe/Publish
Node.js基于事件驱动,其事件模型使用了发布订阅模式(Subscribe/Publish)。events模块的EventEmitter类实现发布订阅模式,通过on
方法对指定事件进行监听,在通过emit
方法对事件进行发布。
订阅发布模式定义了一种一对多的依赖关系,在Node.js中EventEmitter对象上开放了一个可以用于监听的on(eventName, callback)
函数允许将一个或多个函数绑定到对应的事件上。当EventEmitter对象触发某个事件时,所有绑定在该事件上的函数都会被同步地调用。
事件模块events
events
模块仅提供一个对象events.EventEmitter
,EventEmitter
类的核心是事件触发和事件监听功能的封装。
//引入events事件模块
const events = require("events");
//创建事件触发器EventEmitter实例对象
const emmiter = new events.EventEmitter();
事件触发器EventEmitter
创建
Node.js中所有能触发事件的对象都是EventEmitter
类的实例,此类对象都有一个emitter.on()
函数用于将一个或多个函数绑定到命名事件上。事件的命名方式通常采用驼峰式的字符串,也可以是任何有效的JavaScript属性键。当EventEmitter
对象触发一个事件时,所有绑定在该事件上的函数都会被同步地调用。被调用的监听器返回的任何值都将会被忽略并丢弃。
const EventEmitter = require("events").EventEmitter;
const emitter = new EventEmitter();
继承extends
使用中大多数时候并不会直接使用EventEmitter
类,而是在对象中继承它。比如在fs、net、http在内的,只要是支持事件响应的核心模块都是继承了EventEmitter类。这样做的好处在于首先具有某个实体功能的对象实现事件符合语义,事件的监听和发生应该是一个对象的方法。其次JavaScript的对象机制是基于原型的,支持部分多继承,继承EventEmitter类并不会打乱对象原有的继承关系。
const EventEmitter = require("events").EventEmitter;
//创建类并继承events模块提供的EventEmitter类
class Emitter extends EventEmitter{}
//创建触发器
const emitter = new Emitter();
注册on
方法 | 描述 |
---|---|
addListener(event, listener) | 为指定事件添加一个监听器到监听器数组尾部 |
on(event, listener) | addListener的别名,为指定事件注册一个事件监听器。 |
once(event, listener) | 为指定事件注册一个单次监听器,监听器最多只会触发一次,出发后立即会接触监听器。 |
例如:EventEmitter事件触发器绑定一个事件监听器,emitter.on()
用于注册监听器,emitter.emit()
用于触发事件。
//注册监听器
emitter.on("eventname", ()=>{
//触发事件
});
//触发事件
emitter.emmit("eventname");
触发emit
方法 | 描述 |
---|---|
emit(event, [arg1], [arg2], [...]) | 按监听器注册顺序依次执行监听器,若事件已注册监听则返回true,否则返回false。 |
移除off
移除方法 | 描述 |
---|---|
removeListener(event, listener) | 移除指定事件的某个事件监听器,该监听器必须是已注册的。 |
off(event, listener) | removeListener的别名 |
removeAllListeners([event]) | 移除所有事件的所有监听器,若指定事件则移除指定事件的所有监听器。 |
emitter.off("eventName", function(stream){
console.log("remove event listener");
});
默认事件
默认事件 | 描述 |
---|---|
error | 实例化时触发 |
newListener | 当添加新的事件监听器时触发,在订阅者被加入到订阅列表前触发。 |
removeListener | 当事件监听器被移除时触发,在订阅者被移除订阅列表后触发。 |
EventEmitter
事件触发器如果在实例化时发生错误会触发error
事件,在Node.js会被视为特殊情况。如果没有为error
事件注册事件监听器,当error
事件触发时会抛出错误并打印堆栈跟踪,最后会退出Node.js进程。
emitter.on("error", new Error("自定义错误信息"));
//抛出错误并使Node.js崩溃
作为最佳实践应该始终为error
错误事件注册事件监听器。
emitter.on("error", error=>console.log(error));
emitter.emit("error", new Error("error"));
当添加新的事件监听器时newListener
事件会被触发,当事件监听器被移除时removeListener
事件会被触发。
//注册事件监听器
emitter.on("eventname", function(){
console.log("eventname");
});
//延迟1秒后触发事件
setTimeout(function(){
emitter.emit("eventname");
}, 1000);
事件
EventEmitter
事件触发器的每个事件会由一个事件名称和若干个参数组成,事件名称是一个字符串,表达一定的语义。对于每个事件,EventEmitter
支持若干个事件监听器。当事件触发时,注册到事件触发器上的事件监听器会依次被调用,事件参数作为回调函数参数进行传递。
emitter.on("eventName1", function(arg1, args2){
console.log("eventName1", arg1, arg2);
});
emitter.on("eventName2", function(arg1, arg2){
console.log("eventName2", arg1, arg2);
});
emitter.emit("eventName1", "arg1Value", "arg2Value");
emitter.emit("eventName2", "arg1Value", "arg2Value");
事件监听器Listener
默认情况下每个事件触发器可注册最多10个事件监听器,可使用emitter.setMaxListeners(n)
函数改变单个EventEmitter事件触发器实例的限制。也可使用EventEmitter.defaultMaxListeners
属性改变所有EventEmitter
事件触发器实例的默认值。如果默认值不是一个正整数则会抛出TypeError
的错误。设置EventEmitter.defaultMaxListeners
属性要谨慎,因为会影响到所有EventEmitter
事件触发器实例,包括之前创建的。因此,应该优先使用emitter.setMaxListeners(n)
方法。若EventEmitter实例添加的事件监听器超过限制会向stderr
系统标准错误输出跟踪警告,警告中会表明检测到可能的内存泄露。对于单个EventEmitter
实例可使用emitter.getMaxListeners()
和emitter.setMaxListeners()
临时性地消除错误。
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once("event", ()=>{
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
异步执行setImmediate
EventEmitter
事件触发器以注册的事件顺序同步地调用所有的事件监听器,以确保事件的正确排序,并有卒于避免竞态条件和逻辑错误。事件监听器中可使用setImmediate()
函数和process.nextTick()
函数切换到异步模式。
emitter.on("eventName", function(){
setImmediate((arg1, arg2)=>{
console.log("async", arg1, arg2);
});
emitter.emit("eventName", "arg1Value", "arg2Value");
});
调用一次once
当使用emitter.on()
注册事件监听器时,事件监听器会在每次触发命名事件时被调用。可使用emitter.once()
注册最多可调用依次的事件监听器。当事件被触发时事件监听器会被注册然后再调用。
emitter.once("eventName", function(arg1, arg2){
console.log("eventName", arg1, arg2);
});
emitter.emit("eventName", "arg1Value", "arg2Value");
emitter.emit("eventName", "arg1Value", "arg2Value");