[NodeJS]核心模块--Events

Posted 2020-09-23 小碎石

Events是Node中的一个很重要的核心模块，Stream, 网络，文件系统统统都是继承自这个模块。

Streams模块就是继承自EventEmitter，所以说弄明白Events模块，特别是EventEmitter对象, 对于理解Node中的很多模块都是有好处的。

Stream非常擅长处理数据，无论是读，写或者是转换。比如，你可以用Stream接收数据库中的数据，将其流出到csv的流中，导出成为csv格式。

接着你可以再传入一个http请求(也是一种流)将数据再流入到http流中，这样就可以直接将数据显示在浏览器中。

或者你可以将数据流入到一个可写的文件流中，通过创建文件将文件发送给浏览器。

除了Node自身的核心模块，很多第三方开源项目也都是基于EventEmitter构建的。如 Express, Connect, RedisClient 

 

EventEmitter

通常来说，我们都希望自定义类能够实现EventEmitter类提供的基本功能。

于是我们可以使用util模块提供的util.inherits()方法来实现原型链上的继承。

而EventEmitter类提供了on() 和 emit() 方法用于绑定事件和触发事件。

也可以使用removeListener() 方法来删除监听器，但是需要注意，和定时器一样，你需要将监听器保存在某个函数变量中。

同样，可以使用 once() 方法来绑定只执行一次的监听事件。

// musicPlayer.js
// 通过继承EventEmitter来实现一个基于事件的音乐播放器

var util = require("util");
var events = require("events");

function MusicPlayer(){
    this.playing = false;
        events.EventEmitter.call(this);
}

util.inherits(MusicPlayer, events.EventEmitter);


var audioDevice = {
    play: function(track){
        console.log("play in ", track);
    },
    stop: function(){
        console.log("stop play");
    }
};

// 实例化播放器类
var myMusicPlayer = new MusicPlayer();
myMusicPlayer.on(‘play‘, function() {
    this.playing = true;
});
myMusicPlayer.on(‘stop‘, function() {
    this.playing = false;
    audioDevice.stop();
});
myMusicPlayer.once(‘play‘, function(){
    console.log("begin play");
});
myMusicPlayer.on(‘play‘, function(track) {
    audioDevice.play(track);
});

myMusicPlayer.emit("play", "The roots - the fire");

setTimeout(function(){
    myMusicPlayer.emit("stop");
    setTimeout(function(){
        myMusicPlayer.emit("play", "Country Road");
    }, 3000);
}, 2000);

 

混合EventEmitter类

有些时候你使用的类是别人提供给你的类，这个时候不能简单的将其继承自EventEmitter类。那么可以通过for ... in 循环将一个原型对象上的属性拷贝到另外一个原型对象上。

前面那个音乐播放器类可以升级为

// musicPlayer 音乐播放器类升级版

var EventEmitter = require("events").EventEmitter;

function MusicPlayer(track){
    this.track = track;
    this.playing = false;

    for(var method in EventEmitter.prototype){
        this[method] = EventEmitter.prototype[method];
    }
}

MusicPlayer.prototype.toString = function(){
    if(this.playing){
        return "Now playing: " + this.track;
    }else{
        return "Stopped";
    }
};

var myMusicPlayer = new MusicPlayer("Girl Talk - Still Here");
myMusicPlayer.on(‘play‘, function() {
    this.playing = true;
    console.log(this.toString());
});

myMusicPlayer.on("stop", function(){
    this.playing = false;
    console.log(this.toString());
});

myMusicPlayer.emit("play");

setTimeout(function(){
    myMusicPlayer.emit("stop");
},3000);

 

异常处理

在Node中，error事件被当做特殊情况。如果没有针对error的监听器，那么一旦发生错误，则系统将会按照默认的方式进行处理，即打印一个堆栈并且退出程序。

建议使用 on() 方法来监听 error 事件。上面这种是常用的处理异常的一种方式，其实到这一步，就可以了。

但是如果想了解更多如何集中处理多个异常操作，特别是当你正在执行多个非阻塞IO操作时，如何有效处理异常则是需要认真学习的地方。这里需要使用到node的核心模块 domain

domain接口提供了用异常处理封装已有的非阻塞API以及错误的方法。能够帮助我们集中处理所有的异常，特别是有多个相互依赖的IO操作时非常有用。

domain模块使用create() 方法创建实例，给实例绑定一个error事件监听器，于是在实例的run 方法中运行回调函数导致的error都会被domain覆盖。

根据最新Node官方文档，一旦有新的可替代方案出现，domain模块就会被彻底废弃。所以第二种方法就不介绍了。

 

反射

Node的events模块提供了一个 newListener 事件，用于跟踪监听器何时被添加，而监听这个事件的监听器函数会接收到事件名称和事件处理程序(监听器的方法)

也就是说当你通过 on() 方法添加事件监听器时就会触发 newListener 事件。在这个回调函数中，新注册的同名事件都会被插入到同名事件监听器队列的前面。

eventEmitter.on("newListener", function(eventName, function){ });

EventEmitter实例的 listeners(eventName) 方法会返回指定事件名称的监听器数组的副本，通过 length属性检查当前监听器的数量。

 

接下来说到一个小技巧: 如何管理模块中众多的事件名，而不会出现混乱。

解决方案就是给你的模块定义一个events对象专门用来存放事件名。

 

 

结语

虽然EventEmitter模块很重要，并且很多开源项目都是基于EventEmitter开发的。但是，并不能说EventEmitter就是完美的。所以就出现了替代品。如 AMQP, ZeroMQ, js-signals, Redis等等