【原创】Node核心API(二)Events

Events模块是Node对“发布/订阅”模式(publish/subscribe)的实现,一个对象通过这个模块,向另一个对象传递消息,几乎所有常用的node模块都继承了events模块,比如http、fs等。
Node中的Event模块仅仅提供了一个对象: EventEmitter, EventEmitter 的核心就是事件触发与事件监听器功能的封装。

1、订阅发布模式(Subscribe/Publish)

订阅发布模式(又称事件监听器模式)广泛用于异步编程中。events模块是订阅发布模式的一个简单实现。订阅发布模式定义了一种一对多的依赖关系,在Node中EventEmitter 对象上开放了一个可以用于监听的on(eventName,callback)函数,允许将一个或多个函数绑定到对应的事件上。当 EventEmitter 对象触发一个事件时,所有绑定在该事件上的函数都被同步地调用!

2、Events的API

Events API概览

大多数时候我们不会直接使用 EventEmitter,而是在对象中继承它。包括 fs、net、 http 在内的,只要是支持事件响应的核心模块都是 EventEmitter 的子类。
原因有两点:

  • 具有某个实体功能的对象实现事件符合语义, 事件的监听和发射应该是一个对象的方法。
  • JavaScript 的对象机制是基于原型的,支持 部分多重继承,继承 EventEmitter 不会打乱对象原有的继承关系。

3、方法

3.1 创建监听器

  • emitter.on(eventName, listener):添加 listener 函数到名为 eventName 的事件的监听器数组的末尾。 不会检查 listener 是否已被添加。 多次调用并传入相同的 eventName 与 listener 会导致 listener 会被添加多次。
  • emitter.addListener(eventName, listener):emitter.on(eventName, listener)的别名。
//引入events模块
const EventEmitter = require('events');
let count = 0;
//创建一个新实例
const myEmitter = new EventEmitter();
//给“去逛街”创建一个监听
myEmitter.on('去逛街', () => {
    console.log(`买了${++count}件衣服`);
});
// 再次给“去逛街”创建一个监听,不会检查 listener 是否已被添加,依然被放到监听器数组后面。
myEmitter.on('去逛街', () => {
    console.log(`买了${++count}条裤子`);
});
//触发监听“去逛街”这个事件
myEmitter.emit('去逛街');
myEmitter.emit('去逛街');
/** 输出结果:
 * 买了1件衣服
 * 买了2条裤子
 * 买了3件衣服
 * 买了4条裤子*/
  • emitter.once(eventName, listener):添加单次监听器 listener 到名为 eventName 的事件。 当 eventName 事件下次触发时,监听器会先被移除,然后再调用。
//引入events模块
const EventEmitter = require('events');
let count = 0;

//创建一个新实例
const myEmitter = new EventEmitter();
//给“去逛街”创建一个监听
myEmitter.once('去逛街', () => {
    console.log(`买了${++count}件衣服`);
});
//触发监听“去逛街”这个事件
myEmitter.emit('去逛街'); // 买了1件衣服

myEmitter.emit('去逛街'); // 没有被触发
  • emitter.prependListener(eventName, listener):添加 listener 函数到名为 eventName 的事件的监听器数组的开头。 不会检查 listener 是否已被添加。 多次调用并传入相同的 eventName 和 listener 会导致 listener 被添加多次。
  • emitter.prependOnceListener(eventName, listener):添加单次监听器 listener 到名为 eventName 的事件的监听器数组的开头。 当 eventName 事件下次触发时,监听器会先被移除,然后再调用。
//引入events模块
const EventEmitter = require('events');
//创建一个新实例
const myEmitter = new EventEmitter();
//给“去逛街”创建一个监听
myEmitter.on('去逛街', () => {
    console.log(`买衣服`);
});
// 添加 listener 函数到名为 eventName 的事件的监听器数组的开头。
myEmitter.prependListener('去逛街', () => {
    console.log(`买裤子`);
});
// 添加单次监听器 listener 到名为 eventName 的事件的监听器数组的开头
myEmitter.prependOnceListener('去逛街', () => {
    console.log(`买鞋子`);
});
//触发监听“去逛街”这个事件
myEmitter.emit('去逛街'); // 输出结果:买鞋子 买裤子 买衣服
myEmitter.emit('去逛街'); // 输出结果:买裤子 买衣服

3.2 调用监听器

  • emitter.emit(eventName[, ...args]):按照监听器注册的顺序,同步地调用每个注册到名为 eventName 的事件的监听器,并传入提供的参数。

3.3 移除监听器

  • emitter.removeListener(eventName, listener):从名为 eventName 的事件的监听器数组中移除指定的 listener。每次只会从监听器数组中移除一个监听器。 如果监听器被多次添加到指定 eventName 的监听器数组中,则必须多次调用 removeListener() 才能移除所有实例。
  • emitter.removeAllListeners([eventName]):移除全部监听器或指定的 eventName 事件的监听器。
  • emitter.off(eventName, listener)emitter.removeListener() 的别名。
//引入events模块
const EventEmitter = require('events');
//创建一个新实例
const myEmitter = new EventEmitter();
const buyClothes = () => {
    console.log(`买衣服`);
    myEmitter.removeListener('去逛街', buyPants);
}
const buyPants = () => {
    console.log(`买裤子`);
}
myEmitter.on('去逛街', buyClothes);
myEmitter.on('去逛街', buyPants);
// buyClothes 移除了监听器 buyPants,但它依然会被调用。
// 触发时内部的监听器数组为 [buyClothes, buyPants]
myEmitter.emit('去逛街'); // 买衣服 买裤子
// buyPants 现已被移除。
// 内部的监听器数组为 [buyClothes]
myEmitter.emit('去逛街'); // 买衣服

4、事件

  • 'newListener' 事件: EventEmitter 实例在新的监听器被添加到其内部监听器数组之前,会触发自身的 'newListener' 事件。在 'newListener' 回调中注册到相同 eventName的任何其他监听器将插入到正在添加的监听器之前。
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
// EventEmitter 实例会在一个监听器被添加到其内部监听器数组之前触发自身的 'newListener' 事件;
// 只处理一次,避免无限循环。
myEmitter.once('newListener', (event, listener) => {
    if (event === '去逛街') {
        console.log('逛街前的准备');
        myEmitter.on('去逛街', () => {
            console.log('涂防晒霜');
        });
    }
});
myEmitter.on('去逛街', () => {
    console.log('买护肤品');
});
myEmitter.emit('去逛街'); // 逛街前的准备 涂防晒霜 买护肤品
myEmitter.emit('去逛街'); // 涂防晒霜 买护肤品

注意:对'newListener' 事件的监听要放在普通监听前面。如下'newListener' 事件不起作用。

const EventEmitter = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('去逛街', () => {
    console.log('买护肤品');
});
myEmitter.once('newListener', (event, listener) => {
    if (event === '去逛街') {
        console.log('逛街前的准备');
        myEmitter.on('去逛街', () => {
            console.log('涂防晒霜');
        });
    }
});
myEmitter.emit('去逛街'); // 买护肤品
myEmitter.emit('去逛街'); // 买护肤品
  • 'removeListener' 事件:'removeListener' 事件在 listener 被移除后触发
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
const buySkinProd = () => {
    console.log('买护肤品');
    myEmitter.removeListener('去逛街', buySkinProd);
}
myEmitter.once('removeListener', (event, listener) => {
    if (event === '去逛街') {
        console.log('逛街结束');
    }
});
myEmitter.on('去逛街', buySkinProd);
myEmitter.emit('去逛街'); // 买护肤品 逛街结束

5、自定义的类继承 events

// blog.js
const EventEmitter=require('events');

class Base extends EventEmitter {
    constructor() {
        super();
    }
    onEvent(eventName,callback){
        super.on(eventName,callback);
    }
    emitEvent(eventName,arg){
        super.emit(eventName,arg);
    }
};

class BlogInfo extends Base {
    constructor() {
        super();
    }
    onSave() {
        super.onEvent('saveStart',function(blog){
            console.log('saveStart',blog);
        });

        super.onEvent('blogCount',function(blog){
            console.log('blogCount',blog.length);
        });

        super.onEvent('saveEnd',function(blog){
            console.log('saveEnd',blog);
        });
    }
    emitEvent(blog) {
        super.emitEvent('saveStart',blog);

        super.emitEvent('blogCount',blog);

        super.emitEvent('saveEnd',blog);
    }
}

exports.blogSave=function(newblog){
    console.log(BlogInfo.__proto__.__proto__ === EventEmitter); // true
    console.log(BlogInfo.__proto__ === Base); // true
    const blogInfo=new BlogInfo();
    blogInfo.onSave(newblog);
    blogInfo.emitEvent(newblog);
};
// index.js
const http = require('http');
const blog = require('./blog');
const serve = http.createServer((req, res) => {
    if (req.url === '/') {
        const newblog = {title: "标题", content: "内容"};
        blog.blogSave(newblog);
        res.writeHead(200, {'Content-Type': 'text/html;charset=utf-8'});
        res.write('<html><body>');
        res.write('<h2>Hello World!</h2>');
        res.end('</body></html>');
    }
});
serve.listen(8000);
console.log('listen 8000');
/** 运行index.js结果
 * listen 8000
 * true
 * true
 * saveStart [ { title: '标题', content: '内容' } ]
 * saveEnd [ { title: '标题', content: '内容' } ]
 */

参考文章:
https://www.jb51.net/article/124799.htm
https://www.jianshu.com/p/fd1f8c998a2c
https://www.jianshu.com/p/152fddf0628c

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

推荐阅读更多精彩内容

  •   events模块是node的核心模块,几乎所有常用的node模块都继承了events模块,比如http、fs等...
    小小的开发人员阅读 474评论 0 1
  •   在 js 中事件驱动的代码随处可见,这篇文章就介绍一下 node 中的 Events 模块,以及理解如何实现。...
    涯丨角阅读 451评论 0 1
  • 前言: 因为以前学习Node.js并没有真正意义上的去学习它,而是粗略的学习了npm的常用命令和Node.js一些...
    Srtian阅读 980评论 1 17
  • Node.js EventEmitter Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队...
    FTOLsXD阅读 310评论 1 2
  • https://nodejs.org/api/documentation.html 工具模块 Assert 测试 ...
    KeKeMars阅读 6,305评论 0 6