EventEmitter class

在Node中，要实现观察者模式非常的简单，而且内置于EventEmitter类中，EventEmitter类允许我们注册一个或者多个函数作为监听者，当对应的事件触发后，它们就会被触发

64C16489-985B-4083-823C-0A426D4F3C68.png

EventEmitter是一个原型，可以通过events这个核心模块获取得到

const EventEmitter = require('events').EventEmitter;
const eventEmitter = new EventEmitter();

EventEmitter内部提供了几个API

  • on(event, listener) 注册监听者
  • once(event, listener)注册监听者，但是只会触发一次
  • emit(event, [arg1], [...]) 发布一个事件
  • removeListener(event, listener)移除监听者

上面的方法都支持链式调用。而且我们会发现listener和我们所知道的传统的Node回调函数是不同的，最突出的就是函数的第一个参数不是error，而是我们emit时候穿过去的参数

使用EventEmitter

使用它最简单的方式就是去创建一个新的实例，然后立刻使用它

const EventEmitter = require('events').EventEmitter;
const fs = require('fs');

function findPattern(files, regex) {
    const emitter = new EventEmitter();
    files.forEach((file, index) => {
        fs.readFile(file, (err, content) => {
            if(err) {
                emitter.emit('error', err);
            }
            emitter.emit('fileRead', file);
            if(regex.test(content)) {
                emitter.emit('found', content);
            }
        })
    })
    return emitter;
}

findPattern(['a.js', 'b.js', 'main.js'], new RegExp("main", 'i'))
    .on('error', function(err) {
        console.log(err);
    })
    .on('fileRead', function(file) {
        console.log(file + ' read\n');
    })
    .on('found', function(content) {
        console.log(content.toString());
        console.log('\n');
    })

传播错误

EventEmitter和回调函数一样，当异步事件发生错误的时候，直接抛出异常是无法被捕捉到的，因为它们所处的event loop是不相同的

const EventEmitter = require('events').EventEmitter;
const fs = require('fs');

function findPattern(files, regex) {
    const emitter = new EventEmitter();
    files.forEach((file, index) => {
        fs.readFile(file, (err, content) => {
            if(err) {
                // emitter.emit('error', err);
                throw new Error(err);
            }
            emitter.emit('fileRead', file);
            if(regex.test(content)) {
                emitter.emit('found', content);
            }
        })
    })
    return emitter;
}

findPattern(['a.js', 'b.js', 'main.js'], new RegExp("main", 'i'))
    .on('error', function(err) {
        console.log(err);
    })
    .on('fileRead', function(file) {
        console.log(file + ' read\n');
    })
    .on('found', function(content) {
        console.log(content.toString());
        console.log('\n');
    })

所以我们平时在写代码的时候，要注意，多增加一个关于error的事件进行监听，然后进一步处理

使任何对象可观察

有些时候，我们直接通过EventEmitter去创建一个可观察对象是不够的，因为它不能够为我们提供扩展的功能，所以更多的时候，我们通过继承EventEmitter这个类，去创建一个更具有扩展性的可观察的对象

为了进一步描述这种方法，我们通过重写上面的findPattern来说明

const fs = require('fs');
const EventEmitter = require('events').EventEmitter;

class FindPattern extends EventEmitter {
    constructor(regex) {
        super();
        this.regex = regex;
        this.files = [];
    }

    addFile(file) {
        this.files.push(file);
        return this;
    }

    find() {
        this.files.forEach((file, index) => {
            fs.readFile(file, (err, content) => {
                if(err) {
                    this.emit('error', err);
                }
                this.emit('fileRead', file);
                if(this.regex.test(content)) {
                    this.emit('found', content);
                }
            })
        })
    }
}



const interface = new FindPattern(new RegExp("main"));

interface.addFile('a.js')
    .addFile('b.js')
    .addFile('main.js')
    .on('error', function(err) {
        console.log(err);
    })
    .on('fileRead', function(file) {
        console.log(file + ' read\n');
    })
    .on('found', function(content) {
        console.log(content.toString());
        console.log('\n');
    })
    .find()

这种模式在Node的生态圈里十分常见，HTTP、TCP等模块里都大量了使用了这种模式

同步和异步事件

和回调函数一样，事件是可以同步触发，也可以是异步触发的，但是强调的是，在同一个EventEmitter内，不能混用两种模式

emit同步事件和异步事件最主要的区别取决于注册listener的方法，如果events是异步的emit，那么程序有充足的时间去注册listener，因为event不会在本次event loop被触发

如果events是同步的被emit，那么就需要在emit之前去注册listener

class SycnEmitter extends EventEmitter {
    constructor() {
        super();
        this.emit('ready', 'ready');
    }
}

const interface = new SycnEmitter();

interface.on('ready', (ready) => {
    console.log(ready);
})

上面的代码，就是因为没有在emit之前进行注册，导致没有任何的输出结果，如果是异步的去emit的话，就不会这样。

所以我们在使用EventEmitter的时候，需要考虑好使用的场景，再根据场景决定使用同步的方式还是异步的方式

EventEmitter VS callbacks

在定义异步API时，常见的难点是检查是否使用EventEmitter的事件机制或仅接受回调函数。一般区分规则是这样的：当一个结果必须以异步方式返回时，应该使用回调函数，当需要结果不确定其方式时，应该使用事件机制来响应。

但是，由于这两者实在太相近，并且可能两种方式都能实现相同的应用场景，所以产生了许多混乱。以下列代码为例：

function helloEvents() {
  const eventEmitter = new EventEmitter();
  setTimeout(() => eventEmitter.emit('hello', 'hello world'), 100);
  return eventEmitter;
}

function helloCallback(callback) {
  setTimeout(() => callback('hello world'), 100);
}

helloEvents()和helloCallback()在其功能上可以被认为是等价的，第一个使用事件机制实现，第二个则使用回调来通知调用者，而将事件作为参数传递。但是真正区分它们的是可执行性，语义和要实现或使用的代码量。虽然我们不能给出一套确定性的规则来选择一种风格，但我们当然可以提供一些提示来帮助你做出决定。

相比于第一个例子，即观察者模式而言，回调函数在支持不同类型的事件时有一些限制。但是事实上，我们仍然可以通过将事件类型作为回调的参数传递，或者通过接受多个回调来区分多个事件。然而，这样做的话不能被认为是一个优雅的API。在这种情况下，EventEmitter可以提供更好的接口和更精简的代码。

EventEmitter更优秀的另一种应用场景是多次触发同一事件或不触发事件的情况。事实上，无论操作是否成功，一个回调预计都只会被调用一次。但有一种特殊情况是，我们可能不知道事件在哪个时间点触发，在这种情况下，EventEmitter是首选。

最后，使用回调的API仅通知特定的回调，但是使用EventEmitter函数可以让多个监听器都接收到通知。

在定义异步API时，常见的难点是检查是否使用EventEmitter的事件机制或仅接受回调函数。一般区分规则是这样的：当一个结果必须以异步方式返回时，应该使用回调函数，当需要结果不确定其方式时，应该使用事件机制来响应。

但是，由于这两者实在太相近，并且可能两种方式都能实现相同的应用场景，所以产生了许多混乱。以下列代码为例：

function helloEvents() {
  const eventEmitter = new EventEmitter();
  setTimeout(() => eventEmitter.emit('hello', 'hello world'), 100);
  return eventEmitter;
}

function helloCallback(callback) {
  setTimeout(() => callback('hello world'), 100);
}

helloEvents()和helloCallback()在其功能上可以被认为是等价的，第一个使用事件机制实现，第二个则使用回调来通知调用者，而将事件作为参数传递。但是真正区分它们的是可执行性，语义和要实现或使用的代码量。虽然我们不能给出一套确定性的规则来选择一种风格，但我们当然可以提供一些提示来帮助你做出决定。

相比于第一个例子，即观察者模式而言，回调函数在支持不同类型的事件时有一些限制。但是事实上，我们仍然可以通过将事件类型作为回调的参数传递，或者通过接受多个回调来区分多个事件。然而，这样做的话不能被认为是一个优雅的API。在这种情况下，EventEmitter可以提供更好的接口和更精简的代码。

EventEmitter更优秀的另一种应用场景是多次触发同一事件或不触发事件的情况。事实上，无论操作是否成功，一个回调预计都只会被调用一次。但有一种特殊情况是，我们可能不知道事件在哪个时间点触发，在这种情况下，EventEmitter是首选。

总结

最后，使用回调的API仅通知特定的回调，但是使用EventEmitter函数可以让多个监听器都接收到通知。

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,332评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,508评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,812评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,607评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,728评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,919评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,071评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,802评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,256评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,389评论 4赞 332
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,032评论 3赞 316
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2赞 350

推荐阅读更多精彩内容