架构机制

Egg.js源码探秘

代码加载与依赖注入

集群模式的启动逻辑

首先是egg-scripts/start.js中封装启动参数，并且Fork新的进程来启动：

// 封装参数
this.serverBin = path.join(__dirname, '../start-cluster');
...
const eggArgs = [
  ...(execArgv || []),
  this.serverBin,
  clusterOptions,
  `--title=${argv.title}`
];
...
// 启动执行进程
spawn('node', eggArgs, options);

然后start-cluster中加载egg-cluster的启动代码：

// start-cluster
require(options.framework).startCluster(options);

egg-cluster/index.js中暴露了startCluster方法，其会构造Master对象实例：

exports.startCluster = function(options, callback) {
  new Master(options).ready(callback);
};

Master本身继承自EventEmitter，并且包含了Manager与Messenger这两个消息组件的实例以及AgentWorker与AppWorker两类具体的工作进程。messenger.js则是负责在Master、Agent与App Worker之间的通信：

        ┌────────┐
        │ parent │
        /└────────┘\
      /     |      \
      /  ┌────────┐  \
    /   │ master │   \
    /    └────────┘    \
  /     /         \    \
┌───────┐         ┌───────┐
│ agent │ ------- │  app  │
└───────┘         └───────┘

在Master的构造函数中，其会使用detectPort检测端口是否可用；若可用则调用forkAgentWorker创建AgentWorker:

// AgentWorker 创建完毕后创建 AppWorkers
this.once("agent-start", this.forkAppWorkers.bind(this));

// 使用 fork 创建新的 AgentWorker
const agentWorker = childprocess.fork(agentWorkerFile, args, opt);

在forkAppWorkers中调用cfork来创建多个AppWorker，并且将它们注册到管理中心：

cfork({
  exec: appWorkerFile,
  args,
  silent: false,
  count: this.options.workers,
  // don't refork in local env
  refork: this.isProduction
});

cluster.on('fork', worker => {
  ...
  this.workerManager.setWorker(worker);
  ...
});

// 子进程开始监听后，发送 app-start 消息
cluster.on('listening', (worker, address) => {
  this.messenger.send({
    action: 'app-start',
    ...
  });
});

app-start事件会触发onAppStart，并且启动所有的AppWorker：

// enable all workers when app started
for (const id in cluster.workers) {
  const worker = cluster.workers[id];
  worker.disableRefork = false;
}

egg-cluster允许传入sticky属性，来控制是否启动门面服务器；如果传入，则会调用startMasterSocketServer方法：

// manager.js
startMasterSocketServer(cb) {
  // Create the outside facing server listening on our port.
  require('net').createServer({ pauseOnConnect: true }, connection => {
    if (!connection.remoteAddress) {
      connection.close();
    } else {
      const worker = this.stickyWorker(connection.remoteAddress);
      worker.send('sticky-session:connection', connection);
    }
  }).listen(this[REALPORT], cb);
}

这里的stickyWorker会根据IP地址动态分配具体的Worker实例，每个Worker是完整的Node.js应用：

// app_worker.js
const Application = require(options.framework).Application;
const app = new Application(options);

应用创建完毕后会调用startServer方法来启动本地服务器：

// app_worker.js
if (options.https) {
  const httpsOptions = Object.assign({}, options.https, {
    key: fs.readFileSync(options.https.key),
    cert: fs.readFileSync(options.https.cert)
  });
  server = require("https").createServer(httpsOptions, app.callback());
} else {
  server = require("http").createServer(app.callback());
}

如果是Sticky模式，则监听127.0.0.1，否则共享连接：

// app_worker.js
if (options.sticky) {
  server.listen(0, "127.0.0.1");
} else {
  server.listen(...args);
}

最近更新于0001-01-01