Node.js Events

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.EventEmitterEventEmitter类的核心是事件触发和事件监听功能的封装。

//引入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");
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容