Egg.js 开源项目启动与配置教程

1. 项目的目录结构及介绍

Egg.js 是一个基于 Koa 开发的高级框架，用于构建企业级服务端应用。以下是 Egg.js 项目的典型目录结构及其组成部分的介绍：

egg-project
├── app.js                # 应用的入口文件
├── app
│   ├── controller        # 控制器目录
│   ├── service           # 服务层目录
│   ├── middleware        # 中间件目录
│   ├── public            # 静态文件目录
│   ├── view              # 视图文件目录
│   └── model             # 数据模型目录（可选）
├── config                # 配置文件目录
│   ├── config.default.js # 默认配置文件
│   └── config.local.js   # 本地开发配置文件（可选）
├── test                  # 单元测试目录
├── run                  # 本地开发启动文件
└── package.json          # 项目依赖和配置文件

• app.js：应用的主入口文件，用于启动和配置应用。
• app：应用目录，包含控制器（controller）、服务（service）、中间件（middleware）、静态文件（public）、视图（view）和模型（model）等子目录。
• config：配置文件目录，包含应用的默认配置（config.default.js）和本地开发配置（config.local.js）。
• test：单元测试目录，用于存放测试用例。
• run：本地开发启动文件，用于启动应用。
• package.json：定义项目依赖和配置。

2. 项目的启动文件介绍

在 Egg.js 项目中，本地开发的启动文件通常是 run 目录下的 start.js 文件。以下是启动文件的基本内容：

const egg = require('egg');

egg.startCluster({
  baseDir: __dirname,
  port: 7001,
  workers: 1,
});

该文件通过 egg 模块的 startCluster 方法启动应用。baseDir 指定项目的根目录，port 设置应用监听的端口号，workers 指定工作进程的数量。

3. 项目的配置文件介绍

Egg.js 的配置文件位于 config 目录下，主要有 config.default.js 和 config.local.js。

• config.default.js：应用的默认配置文件，定义了应用的通用配置，如中间件、跨域、数据库配置等。

module.exports = appInfo => {
  const config = {};

  // 中间件配置
  config.middleware = ['robot', 'gzip'];

  // 更多配置...

  return config;
};

• config.local.js：本地开发时的配置文件，通常用于覆盖默认配置中的某些设置，如数据库连接信息、日志等级等。

module.exports = appInfo => {
  const config = {};

  // 数据库配置
  config.mysql = {
    client: {
      host: 'localhost',
      port: '3306',
      user: 'root',
      password: 'password',
      database: 'egg',
    },
  };

  // 更多配置...

  return config;
};

这些配置文件确保了应用在不同的环境中能够正确地加载和运行。在部署到生产环境时，可能还需要创建对应的 config.prod.js 等配置文件，以适应生产环境的特殊要求。