Skip to content
This repository has been archived by the owner on Sep 25, 2023. It is now read-only.

给pomelo加个组件

imconfig edited this page Feb 26, 2016 · 4 revisions

pomelo的核心是由一系列松耦合的component组成,同时我们也可以实现我们自己的component来完成一些自己定制的功能。对于我们的chat应用,我们尝试给其增加一个component,目的是展示如何增加一个component,以及component的生命周期管理,而不会特别关注这个component的实际功能。我们现在就给其增加一个component HelloWorld,这个component仅仅在master服务器上加载运行,在master服务器的话,它将每隔一段时间在console上打印出来一个HelloWorld,具体的时间间隔由opts配置来指定。

chat中应用

具体的代码在分支tutorial-component上,使用如下命令切换分支:

$ git checkout tutorial-component
  • 首先,在app下建立components/HelloWorld.js文件, 大致代码如下:
// components/HelloWorld.js
module.exports = function(app, opts) {
  return new HelloWorld(app, opts);
};

var DEFAULT_INTERVAL = 3000;

var HelloWorld = function(app, opts) {
  this.app = app;
  this.interval = opts.interval || DEFAULT_INTERVAL;
  this.timerId = null;
};

HelloWorld.name = '__HelloWorld__';

HelloWorld.prototype.start = function(cb) {
  console.log('Hello World Start');
  var self = this;
  this.timerId = setInterval(function() {
    console.log(self.app.getServerId() + ": Hello World!");
    }, this.interval);
  process.nextTick(cb);
}

HelloWorld.prototype.afterStart = function (cb) {
  console.log('Hello World afterStart');
  process.nextTick(cb);
}

HelloWorld.prototype.stop = function(force, cb) {
  console.log('Hello World stop');
  clearInterval(this.timerId);
  process.nextTick(cb);
}

我们看到每一个component一般都要定义start,afterStart,stop这些hook函数,供pomelo管理其生命周期时进行调用。对于component的启动,pomelo总是先调用其加载的每一个component提供的start函数,当全部调用完后,才会去调用其加载的每一个component的afterStart方法,这里总是按顺序调用的。在afterStart中,一些需要全局就绪的工作可以放在这里完成,因为调用afterStart的时候,所有component的start已经调用完毕。stop用于程序结束时对component进行清理时使用。虽然我们这个例子非常简单,但是足以说明如何在pomelo中定制自己的component,并使用。我们在HelloWorld的start里面启用了一个定时器,每隔一段时间就向console打印一个HelloWorld。然后在stop里关闭它。

  • 然后,我们让master服务器来加载我们的这个component,具体代码如下:
// app.js
var helloWorld = require('./app/components/HelloWorld');

app.configure('production|development', 'master', function() {
  app.load(helloWorld, {interval: 5000});
});

好了, 我们通过实现一个简单的component,明白了如何实现自己的定制component,当然这个component很简单,也没有啥实际意义,但是它是一个完整的component,有完整的生命周期管理,我们通过这个例子已经了解到了component的创建以及加载。

一些说明

  • 这里定义的HelloWorld component中,往外导出的是一个工厂函数,而不是一个对象。当app加载component时,如果是一个工厂函数,那么app会将自己作为上下文信息以及后面的opts作为参数传给这个函数,使用这个函数的返回值作为component对象。同样,也可以直接给module.exports赋予一个对象,那样的话,就可以直接使用而不用调用工厂函数,不过这样的话丧失了使用app和具体配置参数, 不够灵活,因此,使用工厂方法的方式是一个好选择。

  • 对于start和afterStart的执行,pomelo总是会先按顺序执行完所有component的start后,才会按顺序执行所有component的afterStart,因此可以在afterStart里执行一些需要其他component执行了start后才可以执行的逻辑。

  • 实际上,pomelo应用的整个运行过程可以认为是管理其component的生命周期过程,pomelo的所有功能都是通过其内建的component来实现的。用户可以轻松地定制自己的component,然后将其load进去,这样就很轻松地实现了对pomelo的扩展。

小结

在这部分,我们给聊天应用“画蛇添足”般地添加了一个HelloWorld component,使得可以更好地理解如何定制自己的component,并加载它。pomelo的框架非常灵活,有很好的可扩展性,从我们的例子中,我们可以看出,可以很容易地对pomelo进行扩展。pomelo不仅可以扩展component,pomelo还提供了一个灵活的可扩展的服务器监控管理框架,下一步,我们将给我们的聊天应用增加一个监控模块,让应用服务器自动向master上报自己的本地时间,以此来示例如何在pomelo中定制自己的监控管理模块。

Clone this wiki locally