使用 Egg.js 连接 MySQL 数据库教程

介绍

在 Egg.js 中使用 MySQL 数据库是非常常见的场景，本文将教你如何使用 Egg.js 连接和操作 MySQL 数据库。通过本教程，你将学会如何完成以下任务：

  1. 创建一个 Egg.js 项目
  2. 配置 MySQL 数据库连接
  3. 安装并使用 Egg.js 的 MySQL 插件
  4. 使用 Egg.js 操作 MySQL 数据库

整体流程

下面是整个流程的步骤表格：

步骤 描述
步骤一 创建一个 Egg.js 项目
步骤二 配置 MySQL 数据库连接
步骤三 安装并使用 Egg.js 的 MySQL 插件
步骤四 使用 Egg.js 操作 MySQL 数据库

接下来，我们将按照步骤依次进行讲解。

步骤一：创建一个 Egg.js 项目

首先，我们需要创建一个 Egg.js 项目。打开命令行工具，执行以下命令：

$ npm init egg --type=simple

这个命令将会创建一个简单的 Egg.js 项目，并且会询问你一些配置信息。按照提示填写相关信息，完成项目的创建。

步骤二：配置 MySQL 数据库连接

在 Egg.js 项目中，我们需要配置 MySQL 数据库的连接信息。打开 config/config.default.js 文件，添加如下配置：

// config/config.default.js

exports.mysql = {
  // 单数据库信息配置
  client: {
    // 数据库类型
    dialect: 'mysql',
    // 数据库主机地址
    host: 'localhost',
    // 数据库端口
    port: '3306',
    // 数据库名
    database: 'your_database',
    // 数据库用户名
    username: 'your_username',
    // 数据库密码
    password: 'your_password',
  },
};

根据你的实际情况修改上述配置中的数据库信息，确保正确连接到你的 MySQL 数据库。

步骤三：安装并使用 Egg.js 的 MySQL 插件

为了方便地操作 MySQL 数据库，我们可以使用 Egg.js 提供的 MySQL 插件。在项目的根目录下执行以下命令安装该插件：

$ npm install egg-mysql --save

安装完成后，打开 config/plugin.js 文件，启用 MySQL 插件：

// config/plugin.js

exports.mysql = {
  enable: true,
  package: 'egg-mysql',
};

然后，重启项目以使插件生效。

步骤四：使用 Egg.js 操作 MySQL 数据库

现在我们可以使用 Egg.js 的 MySQL 插件来操作 MySQL 数据库了。下面是一个简单的示例，演示了如何插入一条数据到数据库中：

// app/controller/home.js

const Controller = require('egg').Controller;

class HomeController extends Controller {
  async index() {
    const { ctx, app } = this;
    const result = await app.mysql.insert('user', { name: 'John' });
    ctx.body = result;
  }
}

module.exports = HomeController;

在上述示例中，我们使用了 app.mysql.insert 方法来向名为 user 的表中插入一条数据。name: 'John' 是要插入的数据对象。

至此，我们已经完成了在 Egg.js 中使用 MySQL 数据库的教程。你可以根据实际需求，使用其他的方法和操作 MySQL 数据库。

关系图

下面是该教程中涉及到的关系图：

erDiagram
  User ||--o{ Article : has

流程图

下面是该教程的流程图：

flowchart TD
  A[创建一个 Egg.js 项目] --> B[配置 MySQL 数据库连接]
  B --> C[安装并使用 Egg.js 的 MySQL 插件]
  C --> D[使用 Egg.js 操作 MySQL 数据库]

希望本教程能帮助你快速上手在 Egg.js 中使用 MySQL 数据库，祝你成功！