nodejs事件的使用

nodejs所有的异步I/O操作在完成时都会发送一个事件到事件队列。

nodejs里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。 你可以通过require("events");来访问该模块。

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

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


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

EventEmitter介绍

    events 模块只提供了一个对象: events.EventEmitter。EventEmitter 的核心就是事件发射与事件监听器功能的封装。EventEmitter 的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。当事件发射时,注册到这个事件的事件监听器按照注册顺序依次调用,事件参数作为回调函数参数传递。

    当EventEmitter发生错误,会触发error事件,error事件在nodejs中被视为一种特殊情况,如果没有error事件的linstener,那么就打印stack trace,然后退出。

    所有的EventEmitters在有新的linstener被添加时都会触发newListener事件,在有linstener被移除的时候出发removeListener事件。

var events = require('events'); 
var emitter = new events.EventEmitter();
emitter.on('newListener', function () {
    console.log('newListener', arguments);
});
emitter.on('removeListener', function () {
    console.log('removeListener', arguments);
});
emitter.on('someEvent', function(arg1, arg2) { 
    console.log('listener1', arg1, arg2); 
}); 
emitter.once('someEvent', function(arg1, arg2) { 
    console.log('listener2', arg1, arg2); 
}); 
emitter.emit('someEvent', 'longmenwaideyu', 2015);

运行的结果是:

newListener { '0': 'removeListener', '1': [Function] }
newListener { '0': 'someEvent', '1': [Function] }
newListener { '0': 'someEvent', '1': [Function] }
listener1 longmenwaideyu 2015
removeListener { '0': 'someEvent',
  '1': { [Function: g] listener: [Function] } }
listener2 longmenwaideyu 2015

    上面运行结果的前三行是触发了newListener事件。第一个参数是添加的listener所监听的事件名,第二个参数是该listener的回调函数。once指定的linstener只会执行一次,当事件被触发后,它就立刻被溢出了,所有removeListener事件被触发。

EventEmitter常用的API

EventEmitter.on(event, listener)、emitter.addListener(event, listener) 为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数 listener。

EventEmitter.emit(event, [arg1], [arg2], [...]) 发射 event 事件,传 递若干可选参数到事件监听器的参数表。

EventEmitter.once(event, listener) 为指定事件注册一个单次监听器,即监听器最多只会触发一次,触发后立刻解除该监听器。

EventEmitter.removeListener(event, listener) 移除指定事件的某个监听器,listener 必须是该事件已经注册过的监听器。

var callback = function(stream) {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);


EventEmitter.removeAllListeners([event]) 移除所有事件的所有监听器, 如果指定 event,则移除指定事件的所有监听器。

继承 EventEmitter

大多数时候我们不会直接使用 EventEmitter,而是在对象中继承它。具有某个实体功能的对象实现事件符合语义,事件的监听和发射应该是一个对象的方法。下面是模拟了一个异步准备数据的Model类,他可以在数据准备好之后触发data事件,更新view或者其他。

var util = require("util");  
var events = require("events");
function Model() {
    //events.EventEmitter.call(this);
}
util.inherits(Model, events.EventEmitter);//使这个类继承EventEmitter 
Model.prototype.getData = function(args) {
    var me = this;
    //模拟异步获取数据,数据准备好之后触发data事件
    setTimeout(function () {
        me.emit("data", 'this is data'); 
    }, 1000);
}    
var model = new Model();  
console.log(model);
model.on("data", function(data) {
    console.log('Received data: "' + data + '"');  
})
model.getData();


留言: