Egg：阿里企业级 Node.js 框架快速初始化与开发指南

一、项目官方信息

Egg 是阿里开源的企业级 Node.js 框架，基于 Koa 封装，约定优于配置，内置进程管理、插件系统与框架定制能力，适合大型团队协作开发。

二、官方图片

上图为 Egg 仓库在 GitHub 上的社交预览图。

三、环境要求

• Node.js 16+；
• npm/yarn；
• 支持 Linux/macOS/Windows。

四、快速开始

1. 安装脚手架

npm install --global egg-init

2. 初始化项目

mkdir egg-example && cd egg-example
npm init egg --type=simple
npm install

3. 启动开发

npm run dev
open http://localhost:7001

4. 编写业务

// app/controller/home.js
class HomeController extends Controller {
  async index() {
    this.ctx.body = 'hi, egg';
  }
}
module.exports = HomeController;

5. 生产部署

npm start
npm stop

五、使用方法

• 目录约定：app/controller、app/service、app/router 等；
• 插件体系：如 egg-mysql、egg-sequelize、egg-jwt；
• 多环境配置：config/config.default.js、config.unittest.js；
• 定时任务：agent 与 schedule；
• 部署：支持 PM2、Docker。

六、常见问题 FAQ

1. Egg 和 Koa 关系？ Egg 基于 Koa 封装，约定优于配置。

2. 怎么新建项目？ 用 egg-init 或 npm init egg。

3. 默认端口？ 7001。

4. 怎么连数据库？ 用 egg-mysql 或 egg-sequelize 插件。

5. 支持 TypeScript 吗？ 官方提供 TS 模板。

6. 生产怎么启动？ npm start，配合 Egg 集群进程管理。

七、跳转链接

• GitHub 仓库：eggjs/egg
• 官网：eggjs.org
• 插件：egg-plugin