Node.js Events模塊

概述

基本用法

Events模塊是node.js對“發(fā)布/訂閱”模式（publish/subscribe）的部署。一個對象通過這個模塊，向另一個對象傳遞消息。該模塊通過EventEmitter屬性，提供了一個構造函數(shù)。該構造函數(shù)的實例具有on方法，可以用來監(jiān)聽指定事件，并觸發(fā)回調函數(shù)。任意對象都可以發(fā)布指定事件，被EventEmitter實例的on方法監(jiān)聽到。

下面是一個實例，先建立一個消息中心，然后通過on方法，為各種事件指定回調函數(shù)，從而將程序轉為事件驅動型，各個模塊之間通過事件聯(lián)系。

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

var ee = new EventEmitter();
ee.on("someEvent", function () {
  console.log("event has occured");
});

ee.emit("someEvent");

上面代碼在加載events模塊后，通過EventEmitter屬性建立了一個EventEmitter對象實例，這個實例就是消息中心。然后，通過on方法為someEvent事件指定回調函數(shù)。最后，通過emit方法觸發(fā)someEvent事件。

on方法

默認情況下，Node.js允許同一個事件最多可以指定10個回調函數(shù)。

ee.on("someEvent", function () { console.log("event 1"); });
ee.on("someEvent", function () { console.log("event 2"); });
ee.on("someEvent", function () { console.log("event 3"); });

超過10個回調函數(shù)，會發(fā)出一個警告。這個門檻值可以通過setMaxListeners方法改變。

ee.setMaxListeners(20);

emit方法

EventEmitter實例的emit方法，用來觸發(fā)事件。它的第一個參數(shù)是事件名稱，其余參數(shù)都會依次傳入回調函數(shù)。

var EventEmitter = require('events').EventEmitter;
var myEmitter = new EventEmitter;

var connection = function(id){
  console.log('client id: ' + id);
};

myEmitter.on('connection', connection);
myEmitter.emit('connection', 6);

EventEmitter接口的部署

Events模塊的作用，還在于其他模塊可以部署EventEmitter接口，從而也能夠訂閱和發(fā)布消息。

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

function Dog(name) {
  this.name = name;
}

Dog.prototype.__proto__ = EventEmitter.prototype;
// 另一種寫法
// Dog.prototype = Object.create(EventEmitter.prototype);

var simon = new Dog('simon');

simon.on('bark', function(){
  console.log(this.name + ' barked');
});

setInterval(function(){
  simon.emit('bark');
}, 500);

上面代碼新建了一個構造函數(shù)Dog，然后讓其繼承EventEmitter，因此Dog就擁有了EventEmitter的接口。最后，為Dog的實例指定bark事件的監(jiān)聽函數(shù)，再使用EventEmitter的emit方法，觸發(fā)bark事件。

Node內置模塊util的inherits方法，提供了另一種繼承EventEmitter的寫法。

var util = require('util');
var EventEmitter = require('events').EventEmitter;

var Radio = function(station) {

    var self = this;

    setTimeout(function() {
        self.emit('open', station);
    }, 0);

    setTimeout(function() {
        self.emit('close', station);
    }, 5000);

    this.on('newListener', function(listener) {
        console.log('Event Listener: ' + listener);
    });

};

util.inherits(Radio, EventEmitter);

module.exports = Radio;

上面代碼中，Radio是一個構造函數(shù)，它的實例繼承了EventEmitter接口。下面是使用這個模塊的例子。

var Radio = require('./radio.js');

var station = {
  freq: '80.16',
  name: 'Rock N Roll Radio',
};

var radio = new Radio(station);

radio.on('open', function(station) {
  console.log('"%s" FM %s 打開', station.name, station.freq);
  console.log('? ??');
});

radio.on('close', function(station) {
  console.log('"%s" FM %s 關閉', station.name, station.freq);
});

事件類型

Events模塊默認支持兩個事件。

• newListener事件：添加新的回調函數(shù)時觸發(fā)。
• removeListener事件：移除回調時觸發(fā)。

ee.on("newListener", function (evtName){
  console.log("New Listener: " + evtName);
});

ee.on("removeListener", function (evtName){
  console.log("Removed Listener: " + evtName);
});

function foo (){}

ee.on("save-user", foo);
ee.removeListener("save-user", foo);

// New Listener: removeListener
// New Listener: save-user
// Removed Listener: save-user

上面代碼會觸發(fā)兩次newListener事件，以及一次removeListener事件。

EventEmitter實例的方法

once方法

該方法類似于on方法，但是回調函數(shù)只觸發(fā)一次。

var EventEmitter = require('events').EventEmitter;
var myEmitter = new EventEmitter;

myEmitter.once('message', function(msg){
  console.log('message: ' + msg);
});

myEmitter.emit('message', 'this is the first message');
myEmitter.emit('message', 'this is the second message');
myEmitter.emit('message', 'welcome to nodejs');

上面代碼觸發(fā)了三次message事件，但是回調函數(shù)只會在第一次調用時運行。

下面代碼指定，一旦服務器連通，只調用一次的回調函數(shù)。

server.once('connection', function (stream) {
  console.log('Ah, we have our first user!');
});

該方法返回一個EventEmitter對象，因此可以鏈式加載監(jiān)聽函數(shù)。

removeListener方法

該方法用于移除回調函數(shù)。它接受兩個參數(shù)，第一個是事件名稱，第二個是回調函數(shù)名稱。這就是說，不能用于移除匿名函數(shù)。

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

var emitter = new EventEmitter;

emitter.on('message', console.log);

setInterval(function(){
  emitter.emit('message', 'foo bar');
}, 300);

setTimeout(function(){
  emitter.removeListener('message', console.log);
}, 1000);

上面代碼每300毫秒觸發(fā)一次message事件，直到1000毫秒后取消監(jiān)聽。

另一個例子是使用removeListener方法模擬once方法。

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

var emitter = new EventEmitter;

function onlyOnce () {
    console.log("You'll never see this again");
    emitter.removeListener("firstConnection", onlyOnce);
}

emitter.on("firstConnection", onlyOnce);

（3）removeAllListeners方法

該方法用于移除某個事件的所有回調函數(shù)。

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

var emitter = new EventEmitter;

// some code here

emitter.removeAllListeners("firstConnection");

如果不帶參數(shù)，則表示移除所有事件的所有回調函數(shù)。

emitter.removeAllListeners();

（4）listener方法

該方法接受一個事件名稱作為參數(shù)，返回該事件所有回調函數(shù)組成的數(shù)組。

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

var ee = new EventEmitter;

function onlyOnce () {
    console.log(ee.listeners("firstConnection"));
    ee.removeListener("firstConnection", onlyOnce);
    console.log(ee.listeners("firstConnection"));
}

ee.on("firstConnection", onlyOnce)
ee.emit("firstConnection");
ee.emit("firstConnection");

// [ [Function: onlyOnce] ]
// []

上面代碼顯示兩次回調函數(shù)組成的數(shù)組，第一次只有一個回調函數(shù)onlyOnce，第二次是一個空數(shù)組，因為removeListener方法取消了回調函數(shù)。

參考鏈接

• Hage Yaapa, Node.js EventEmitter Tutorial