Egg.js学习：新手入门指南与实战技巧

本文提供了Egg.js学习的全面指南，涵盖了从安装到基础配置、数据库集成、项目部署等各个方面的内容。文章详细介绍了Egg.js的优势、安装步骤以及如何使用配置文件和中间件。此外，还提供了数据库操作示例和常见问题的解决方法，帮助读者快速掌握Egg.js的使用技巧。Egg.js学习过程中，读者可以跟随文章逐步构建和优化自己的应用。

Egg.js是什么

Egg.js 是基于 Node.js 的应用开发框架，它由阿里巴巴团队开发和维护，旨在为开发者提供一个高效、稳定、可扩展的应用开发环境。Egg.js 被设计为一个模块化的框架，允许开发者根据项目需求选择不同的中间件和插件。此外，Egg.js 充分利用了 Node.js 的非阻塞 I/O 特性，提供了高性能的应用开发体验。

Egg.js的优势

• 高性能：Egg.js 是基于 Node.js 的非阻塞 I/O 特性构建的，能够提供高性能的应用。
• 模块化设计：Egg.js 支持模块化开发，开发者可以根据项目的实际需求选择和配置不同的中间件。
• 内置中间件：Egg.js 提供了丰富的内置中间件，如路由管理、日志管理、错误处理等，可以快速启动项目。
• 易于部署和维护：Egg.js 支持多种部署方式，如 Docker、PM2 等，方便开发者进行项目部署和维护。
• 社区支持：由于 Egg.js 是由阿里巴巴团队开发和维护的，因此它拥有强大的社区支持，开发者可以随时获得技术支持和帮助。

Egg.js的安装步骤

1. 安装 Node.js：首先需要安装 Node.js，可以在官网下载最新版本的 Node.js 安装包并进行安装。
2. 安装 Egg CLI：安装 Egg.js 的命令行工具（Egg CLI），该工具用于创建、初始化和管理 Egg.js 项目。

   npm install -g egg-init

3. 初始化项目：使用 Egg CLI 创建一个新的 Egg.js 项目。假设项目名称为 my-egg-app，则可以使用以下命令进行初始化：

   egg-init my-egg-app --type=official

4. 进入项目目录并安装依赖：

   cd my-egg-app
   npm install

5. 运行项目：安装完成后，使用以下命令启动项目：

   npm run dev

   此时，默认情况下，Egg.js 会监听 7001 端口，访问 http://localhost:7001 即可看到默认的欢迎页面。

初始化项目

Egg.js 提供了一个强大的 CLI 工具来帮助快速创建项目，使用 egg-init 命令可以生成一个完整的 Egg.js 项目结构。例如：

egg-init my-egg-app --type=official

项目目录结构如下：

my-egg-app/
├── app/
│   ├── controller/
│   ├── middleware/
│   ├── router.js
│   ├── service/
│   ├── config/
│   └── ...
├── config/
│   ├── config.default.js
│   └── ...
├── package.json
└── ...

编写第一个路由和控制器

1. 定义路由：在 app/router.js 文件中定义路由：

   module.exports = app => {
    const { router, controller } = app;
    router.get('/', controller.home.index);
   };

2. 创建控制器：在 app/controller/home.js 文件中创建控制器方法：

   const Controller = require('egg').Controller;
   
   class HomeController extends Controller {
    async index() {
      this.ctx.body = 'Hello, Egg.js!';
    }
   }
   
   module.exports = HomeController;

3. 运行项目：启动项目并访问 http://localhost:7001/，页面将显示 "Hello, Egg.js!"。

配置文件的使用

Egg.js 的配置文件位于 config 目录下，其中 config.default.js 是默认配置文件，用于定义项目的默认配置。例如：

module.exports = app => {
  // 设置端口
  app.config.cluster.port = 7001;

  // 设置数据库连接配置
  app.config.mysql = {
    client: {
      host: 'localhost',
      port: 3306,
      user: 'root',
      password: 'password',
      database: 'test',
    },
    app: true,
    agent: false,
  };

  // 设置日志配置
  app.config.logger = {
    level: 'debug',
  };
};

此外，还可以通过环境变量覆盖默认配置。例如，可以在 .env 文件中定义环境变量：

PORT=7002
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASSWORD=password
MYSQL_DATABASE=test

然后在 config.default.js 中使用环境变量：

module.exports = app => {
  // 读取环境变量
  const { MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_PASSWORD, MYSQL_DATABASE } = process.env;

  app.config.mysql = {
    client: {
      host: MYSQL_HOST,
      port: MYSQL_PORT,
      user: MYSQL_USER,
      password: MYSQL_PASSWORD,
      database: MYSQL_DATABASE,
    },
    app: true,
    agent: false,
  };
};

生产环境配置示例

在 config/config.local.js 文件中配置生产环境的环境变量：

module.exports = app => {
  app.config.cluster.port = 8080;
  app.config.mysql.client = {
    host: '192.168.1.100',
    port: 3306,
    user: 'root',
    password: 'password',
    database: 'production',
  };
};
``

## 3. Egg.js常用中间件

### 什么是中间件

中间件（Middleware）是一种处理 HTTP 请求的通用组件，它可以在请求到达应用之前或响应返回客户端之前执行某些操作。Egg.js 提供了丰富的内置中间件，如路由管理、日志管理、错误处理等，还可以通过插件机制扩展其他中间件。

### 常用中间件介绍

1. **路由中间件**：
   - `egg-router`：处理路由配置，定义 HTTP 请求的处理逻辑。
   - `egg-router-plus`：扩展的路由中间件，提供更多的路由功能。

2. **日志中间件**：
   - `egg-logger`：默认的日志中间件，用于记录应用程序的日志信息。
   - `egg-errorlogger`：记录错误日志，帮助追踪和调试应用错误。

3. **错误处理中间件**：
   - `egg-errorhandler`：处理并响应错误，定义错误处理逻辑。
   - `egg-jsonp`：处理 JSONP 请求，适用于跨域场景。

4. **认证与授权中间件**：
   - `egg-jwt`：处理 JWT 认证，实现安全的用户认证。
   - `egg-session`：实现会话管理，用于用户状态跟踪。

5. **性能优化中间件**：
   - `egg-static`：提供静态文件服务，如图片、CSS、JavaScript 文件。
   - `egg-cache`：缓存中间件，用于提高应用性能。

### 使用中间件的步骤

1. **安装中间件**：
   - 例如，安装 `egg-logger`：
     ```bash
     npm install egg-logger

1. 启用中间件：

   • 在 config/config.default.js 文件中启用中间件：

     module.exports = app => {
     app.configure(() => {
      app.use(app.eggLogger());
     });
     };

2. 配置中间件：
   • 例如，配置 egg-logger 的输出级别：

     module.exports = app => {
     app.config.logger.level = 'debug';
     };

数据库连接配置

Egg.js 支持多种数据库，如 MySQL、PostgreSQL、MongoDB 等。以 MySQL 为例，配置数据库连接需要在 config/config.default.js 中进行：

module.exports = app => {
  app.config.mysql = {
    client: {
      host: 'localhost',
      port: 3306,
      user: 'root',
      password: 'password',
      database: 'test',
    },
    app: true,
    agent: false,
  };
};

ORM操作数据库

Egg.js 默认集成了 egg-mysql，使用 ORM（对象关系映射）来操作数据库。例如，创建一个 User 模型：

const Sequelize = require('sequelize');
const db = app.datasource; // 获取数据库实例

const User = db.define('user', {
  name: {
    type: Sequelize.STRING,
    allowNull: false,
  },
  age: {
    type: Sequelize.INTEGER,
    allowNull: false,
  },
});

module.exports = User;

常见数据库操作示例

1. 查询数据：

   const User = app.model.User;
   
   const users = await User.findAll();
   console.log(users);

2. 新增数据：

   const User = app.model.User;
   
   const user = await User.create({
    name: 'John Doe',
    age: 25,
   });
   console.log(user);

3. 更新数据：

   const User = app.model.User;
   
   const user = await User.findOne({
    where: { name: 'John Doe' },
   });
   
   if (user) {
    await user.update({ age: 26 });
   }

4. 删除数据：

   const User = app.model.User;
   
   const user = await User.findOne({
    where: { name: 'John Doe' },
   });
   
   if (user) {
    await user.destroy();
   }

5. 执行 SQL 语句：

   const db = app.datasource;
   
   const users = await db.query('SELECT * FROM user');
   console.log(users);

项目打包与发布

1. 打包项目：

   • 使用 npm run build 命令打包项目，生成 dist 目录：

     npm run build

2. 配置环境变量：

   • 在 config/config.local.js 文件中配置生产环境的环境变量：

     module.exports = app => {
     app.config.cluster.port = 8080;
     app.config.mysql.client = {
      host: '192.168.1.100',
      port: 3306,
      user: 'root',
      password: 'password',
      database: 'production',
     };
     };

3. 发布到服务器：

   • 将打包后的文件通过 FTP 或其他方式上传到服务器指定目录。
4. 启动 Egg.js 服务：
   • 在服务器上启动 Egg.js 服务，使用 npm run start 命令：

     npm run start

使用PM2进行进程管理

1. 安装 PM2：

   • 使用 npm 安装 PM2：

     npm install pm2 -g

2. 启动 PM2：

   • 使用 PM2 启动 Egg.js 应用：

     pm2 startOrReload ecosystem.json

   • 生态系统配置文件 ecosystem.json 示例：

     {
     "apps": [
      {
        "name": "my-egg-app",
        "script": "node_modules/.bin/egg",
        "args": "start",
        "env": {
          "PORT": "8080",
          "NODE_ENV": "production"
        }
      }
     ]
     }

3. 监控和管理应用：
   • 使用 PM2 管理应用：
     • 查看应用状态：

       pm2 list

     • 重启应用：

       pm2 restart my-egg-app

部署到云服务器

1. 配置服务器环境：

   • 安装 Node.js 和 Egg.js 依赖。

   • 配置服务器的 Nginx 或 Apache 作为反向代理。例如，Nginx 配置文件 nginx.conf 示例：

     server {
     listen 80;
     server_name example.com;
     
     location / {
      proxy_pass http://localhost:8080;
      proxy_set_header Host $host;
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     }
     }

常见错误及解决方法

1. 启动失败：

   • 检查是否有未安装的依赖或环境变量配置错误。
   • 查看 logs/error.log 文件，找到错误日志并解决。

2. 数据库连接失败：

   • 确认数据库服务是否正常运行。
   • 检查 config/config.default.js 中的数据库连接配置。
3. 路由未生效：
   • 检查 app/router.js 文件中的路由配置是否正确。
   • 确认控制器方法是否已正确实现。

性能优化技巧

1. 使用缓存：

   • 通过 egg-cache 中间件缓存请求，减少数据库访问次数。
   • 配置缓存策略，如缓存时间、缓存失效条件等。

2. 异步处理：

   • 利用 Promise 和 async/await 实现异步操作，避免阻塞主进程。
   • 优化数据库查询，减少不必要的数据加载。
3. 压缩和 GZIP：
   • 通过配置服务器（如 Nginx、Apache）开启 GZIP 压缩，减少数据传输量。

代码调试与日志管理

1. 调试代码：

   • 使用 console.log 打印调试信息。
   • 使用 egg-logger 记录日志信息，便于追踪问题。
2. 日志管理：
   • 配置 egg-logger 中间件，设置日志级别和输出格式。
   • 查看 logs 目录下的日志文件，追踪应用运行状态。