一聚教程网:一个值得你收藏的教程网站

最新下载

热门教程

node.js中EventEmitter使用方法

时间:2016-08-22 编辑:简简单单 来源:一聚教程网

EventEmitter是什么?

Node.js里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。

EventEmitter对象在使用时,必须先引入events 模块,如下代码:

 代码如下 复制代码

var event=require("events");
//创建EventEmitter对象
var eventEmitter=new event.EventEmitter();

EventEmitter 的核心就是事件触发与事件监听器功能的封装。ventEmitter 的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter 支持 若干个事件监听器。

当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。

EventEmitter使用方式

 代码如下 复制代码

//事件
var event=require("events");
//创建EventEmitter对象
var eventEmitter=new event.EventEmitter();
//创建时间处理程序
var connectHandler=function connecteds(){
    console.log("链接成功");
    eventEmitter.emit("data_received");
}
eventEmitter.on("connected",connectHandler);
//使用匿名函数绑定data_received函数
eventEmitter.on('data_received',function(){
     console.log('数据接收成功。');
    });
 
//触发connected函数
eventEmitter.emit('connected');
console.log("程序执行结束");

多参数使用:

 代码如下 复制代码


var events = require('events');
var emitter = new events.EventEmitter();
emitter.on('someEvent', function(arg1, arg2) {
    console.log('listener1', arg1, arg2);
});
emitter.on('someEvent', function(arg1, arg2) {
    console.log('listener2', arg1, arg2);
});
emitter.emit('someEvent', 'arg1 参数', 'arg2 参数');

EventEmitter 对象如果在实例化时发生错误,会触发 'error' 事件。当添加新的监听器时,'newListener' 事件会触发,当监听器被移除时,'removeListener' 事件被触发。

Nodejs中的EventEmitter例子

 代码如下 复制代码

var util = require("util");
var events = require("events");//EventEmitter通过events模块来访问

function MyStream() {//新建一个类
    events.EventEmitter.call(this);
}

util.inherits(MyStream, events.EventEmitter);//使这个类继承EventEmitter

MyStream.prototype.write = function(data) {//定义一个新方法
    this.emit("data", data);//在此触发名为"data"事件
}

var stream = new MyStream();

stream.on("data", function(data) {//注册监听器,监听名为"data"事件
    console.log('Received data: "' + data + '"');
})
stream.write("It works!"); // Received data: "It works!"


可看出通过继承EventEmitter可为对象注册和触发相关事件。
可与Ruby做个比较,通过block来实现。

 代码如下 复制代码

class MyStream 
  def write(data) 
    yield data 
  end 
end 
 
stream = MyStream.new 
stream.write('It works!') do |data| 
  puts "Received data: #{data}" 
end 

EventEmitter发送和接收事件

 代码如下 复制代码

/*
 EventEmitter发送和接收事件
 HTTPServer和HTTPClient类,它们都继承自EventEmitter

 EventEmitter被定义在Node的事件(events)模块中,直接使用EventEmitter类需要先声明require('events'),
 否则不必显式声明require('events'),因为Node中很多对象都无需你调用require('events')就会使用EventEmitter
 */
var events = require('events');
var util = require('util');

function Pulser(){
    events.EventEmitter.call(this);
}
util.inherits(Pulser, events.EventEmitter);

Pulser.prototype.start = function(){
    var self = this;
    this.id = setInterval(function(){
        util.log('>>>>pulse');
        self.emit('pulse');
        util.log('<<<     }, 1000);
}
//定义了一个类Pulser,该类(通过util.inherits)继承自EventEmitter,它的作用是每隔一秒钟向所有监听器发送一个定时事件。
//start方法使用了setInterval这个函数来定期重复执行回调函数,并调用emit方法将pulse事件发送给每一个监听器


//使用Pulser对象
/*
创建了一个Pulser对象并处理其pulse事件,执行pulser.on('pulse'..)为pulse事件和回调函数建立联系
 */
var pulser = new Pulser();
pulser.on('pulse', function(){
    util.log('pulse received');
});
pulser.start();


//对象使用emit函数发送事件,所有注册到对应事件的监听器都可以收到事件;
//通过调用.on方法注册监听器,参数是事件名,并用一个回调函数接收事件
//通常来说,有一些数据需要伴随着事件同时发送  self.emit('eventName', data1, data2, ..);
//emitter.on('eventName', function(data1, data2,..){
       //接收到事件后的操作
// });

EventEmitter的相关API

方法

序号 方法 & 描述

1 addListener(event, listener)

为指定事件添加一个监听器到监听器数组的尾部。

2 on(event, listener)

为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。

server.on('connection', function (stream) {
  console.log('someone connected!');});
3 once(event, listener)

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

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

4 removeListener(event, listener)

移除指定事件的某个监听器,监听器 必须是该事件已经注册过的监听器。

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

5 removeAllListeners([event])

移除所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。

6 setMaxListeners(n)

默认情况下, EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。

7 listeners(event)

返回指定事件的监听器数组。

8 emit(event, [arg1], [arg2], [...])

按参数的顺序执行每个监听器,如果事件有注册监听返回 true,否则返回 false。


热门栏目