egg运行原理

关于egg

egg是阿里开源的一个框架，为企业级框架和应用而生，相较于express和koa，有更加严格的目录结构和规范，使得团队可以在基于egg定制化自己的需求或者根据egg封装出适合自己团队业务的更上层框架

 

egg所处的定位

天猪曾经在这篇优秀的博文中给出关于egg的定位，如下图：

 

 

可以看到egg处于的是一个中间层的角色，基于koa，不同于koa以middleware为主要生态，egg根据不同的业务需求和场景，加入了plugin,extends等这些功能，可以让开发者摆脱在使用middleware功能时无法控制使用顺序的被动状态，而且还可以增加一些请求无关的一些功能。除此之外，egg还有很多其他优秀的功能，在这里不详述。想了解更多可以移步这里

 

初始化项目

egg有直接生成整个项目的脚手架功能，只需要执行如下几条命令，就可以生成一个新的项目：

 

$ npm i egg-init -g
$ egg-init helloworld --type=simple
$ cd egg-helloworld
$ npm i

启动项目：

 

$ npm run dev
$ open localhost:7001

 

egg是如何运行起来的

下面通过追踪源码来讲解一下egg究竟是如何运行起来的：

 

查看egg-init脚手架生成的项目文件，可以看到整个项目文件是没有严格意义上的入口文件的，根据package.json中的script命令，可以看到执行的直接是egg-bin dev的命令。找到egg-bin文件夹中的dev.js,会看到里面会去执行start-cluster文件：

 

//dev.js构造函数中
this.serverBin = path.join(__dirname, '../start-cluster');
// run成员函数
* run(context) {
  //省略
    yield this.helper.forkNode(this.serverBin, devArgs, options);
}

移步到start-cluster.js文件，可以看到关键的一行代码：

 

require(options.framework).startCluster(options);

 

其中options.framework打印信息为:

 

/Users/wyf/Project/egg-example/node_modules/egg

 

找到对应的egg目录中的index.js文件：

 

exports.startCluster = require('egg-cluster').startCluster;

继续追踪可以看到最后运行的其实就是egg-cluster中的startCluster,并且会fork出agentWorker和appWorks，官方文档对于不同进程的fork顺序以及不同进程之间的IPC有比较清晰的说明,
主要的顺序如下：

 

• Master 启动后先 fork Agent 进程

• Agent 初始化成功后，通过 IPC 通道通知 Master

• Master 再 fork 多个 App Worker

• App Worker 初始化成功，通知 Master

• 所有的进程初始化成功后，Master 通知 Agent 和 Worker 应用启动成功

 

通过代码逻辑也可以看出它的顺序:

 

//在egg-ready状态的时候就会执