美文网首页
02.node的events模块

02.node的events模块

作者: 讲武德的年轻人 | 来源:发表于2019-09-25 11:11 被阅读0次

    events 模块只提供了一个对象: events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。

    • 你可以通过require("events");来访问该模块。
    // 引入 events 模块
    var events = require('events');
    // 创建 eventEmitter 对象
    var eventEmitter = new events.EventEmitter();
    

    EventEmitter 对象如果在实例化时发生错误,会触发 error 事件。当添加新的监听器时,newListener 事件会触发,当监听器被移除时,removeListener 事件被触发。

    下面我们用一个简单的例子说明 EventEmitter 的用法:

    //event.js 文件
    var EventEmitter = require('events').EventEmitter; 
    var event = new EventEmitter(); 
    event.on('some_event', function() { 
        console.log('some_event 事件触发'); 
    }); 
    setTimeout(function() { 
        event.emit('some_event'); 
    }, 1000); 
    

    执行结果如下:

    运行这段代码,1 秒后控制台输出了 'some_event 事件触发'。其原理是 event 对象注册了事件 some_event 的一个监听器,然后我们通过 setTimeout 在 1000 毫秒以后向 event 对象发送事件 some_event,此时会调用some_event 的监听器。

    $ node event.js
    some_event 事件触发

    EventEmitter 的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter 支持若干个事件监听器。
    当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。
    EventEmitter 提供了多个属性,如 on 和 emit。on 函数用于绑定事件函数,emit 属性用于触发一个事件。接下来我们来具体看下 EventEmitter 的属性介绍。

    方法

    1. addListener(event, listener)
      为指定事件添加一个监听器到监听器数组的尾部。
    2. on(event, listener)
      为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。
    server.on('connection', function (stream) {
      console.log('someone connected!');
    });
    
    1. once(event, listener)
      为指定事件注册一个单次监听器,即 监听器最多只会触发一次,触发后立刻解除该监听器。
    server.once('connection', function (stream) {
      console.log('Ah, we have our first user!');
    });
    
    1. removeListener(event, listener)
      移除指定事件的某个监听器,监听器必须是该事件已经注册过的监听器。
      它接受两个参数,第一个是事件名称,第二个是回调函数名称。
    var callback = function(stream) {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
    
    1. removeAllListeners([event])
      移除所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。
    2. setMaxListeners(n)
      默认情况下, EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。
    3. listeners(event)
      返回指定事件的监听器数组。
    4. emit(event, [arg1], [arg2], [...])
      按监听器的顺序执行执行每个监听器,如果事件有注册监听返回 true,否则返回 false。

    类方法

    listenerCount(emitter, event)
    返回指定事件的监听器数量。

    events.emitter.listenerCount(eventName)

    事件

    1. newListener
      event - 字符串,事件名称
      listener - 处理事件函数
      该事件在添加新监听器时被触发。
    2. removeListener
      event - 字符串,事件名称
      listener - 处理事件函数
      从指定监听器数组中删除一个监听器。需要注意的是,此操作将会改变处于被删监听器之后的那些监听器的索引。

    error事件

    • EventEmitter 定义了一个特殊的事件 error,它包含了错误的语义,我们在遇到 异常的时候通常会触发 error 事件。
    • 当 error 被触发时,EventEmitter 规定如果没有响 应的监听器,Node.js 会把它当作异常,退出程序并输出错误信息。
      我们一般要为会触发 error 事件的对象设置监听器,避免遇到错误后整个程序崩溃。

    相关文章

      网友评论

          本文标题:02.node的events模块

          本文链接:https://www.haomeiwen.com/subject/fcoiyctx.html