Egg.js 超级教程：初学者一文精通！

2023-10-30 12:05:32

前言

大家好，我是[您的名字]，今天我们一起来学习 Egg.js。Egg.js 是一个非常流行的 Node.js 框架，它可以帮助我们快速构建出强大的 web 应用。

Egg.js 基础

1. 安装 Egg.js

首先，我们需要安装 Egg.js，可以使用以下命令：

npm install -g egg-bin

安装完成后，就可以使用 egg-init 命令来创建一个新的 Egg.js 项目：

egg-init my-egg-app

2. 项目结构

新建的 Egg.js 项目目录结构如下：

my-egg-app/
├── app/  # 存放应用代码
├── config/  # 存放配置文件
├── logs/  # 存放日志文件
├── node_modules/  # 存放依赖库
├── package.json  # 存放项目依赖信息
├── public/  # 存放静态资源
├── test/  # 存放测试代码
└── views/  # 存放视图模板

3. 路由

在 Egg.js 中，路由是通过 app/router.js 文件来配置的。我们可以使用 router.get()、router.post() 等方法来定义路由。

例如，以下代码定义了一个 GET 请求的路由，当客户端访问 / 路径时，会执行 controller/home.js 文件中的 index() 方法：

router.get('/', 'home.index');

4. 控制器

控制器是处理请求的类，它位于 app/controller 目录下。每个控制器对应一个路由，控制器中的方法对应不同的请求方法。

例如，以下代码定义了一个 home 控制器，它包含了一个 index() 方法，该方法将返回一个简单的字符串：

// app/controller/home.js
module.exports = class HomeController {
  async index() {
    return 'Hello, Egg!';
  }
};

5. 服务

服务是提供特定功能的类，它位于 app/service 目录下。服务可以被控制器调用，也可以被其他服务调用。

例如，以下代码定义了一个 user 服务，它包含了一个 find() 方法，该方法可以查询用户数据：

// app/service/user.js
module.exports = class UserService {
  async find(id) {
    return await this.ctx.model.User.findById(id);
  }
};

6. 模型

模型是与数据库交互的类，它位于 app/model 目录下。模型可以被服务调用，也可以被其他模型调用。

例如，以下代码定义了一个 User 模型，它对应数据库中的 user 表：

// app/model/user.js
module.exports = app => {
  const { STRING, INTEGER } = app.Sequelize;

  const User = app.model.define('user', {
    id: { type: INTEGER, primaryKey: true, autoIncrement: true },
    username: { type: STRING(30), allowNull: false },
    password: { type: STRING(128), allowNull: false },
  });

  return User;
};