Egg.js MySQL 插件使用教程

1. 项目目录结构及介绍

Egg.js 是一个为企业级应用而生的框架，它提供了丰富的插件来支持多种中间件和数据库操作。下面是 egg-mysql 插件的目录结构介绍：

egg-mysql/
├── app.js                # 应用启动时会加载的初始化代码
├── appveyor.yml          # Appveyor 持续集成配置文件
├── config/config.default.js # 插件的默认配置文件
├── History.md            # 插件的历史更新记录
├── package.json          # 插件包的元数据文件
├── Readme.md             # 插件的说明文档
├── test                 # 测试目录
│   ├── app              # 应用测试代码
│   ├── helper           # 辅助测试代码
│   └── index.test.js    # 插件测试入口文件
└── yarn.lock            # 依赖包的锁定文件

• app.js：应用级别的初始化代码，通常用来定义全局中间件或者初始化一些服务。
• config/config.default.js：插件的默认配置文件，提供了插件的基本配置项。
• History.md：记录了插件的更新历史和每个版本的改动内容。
• package.json：定义了插件的名称、版本、描述、依赖项等元数据。
• Readme.md：插件的详细说明文档，包含如何安装、使用以及配置插件等信息。

2. 项目的启动文件介绍

egg-mysql 插件的启动文件是 app.js。在这个文件中，你可以定义和应用相关的初始化代码。不过通常情况下，这个文件可以为空，因为插件的主要功能是通过配置文件来实现的。

3. 项目的配置文件介绍

config/config.default.js 是 egg-mysql 插件的主要配置文件。在这个文件中，你可以配置数据库连接参数以及一些其他相关设置。以下是一个配置示例：

// config/config.default.js
module.exports = {
  mysql: {
    // 单数据库信息配置
    client: {
      host: '127.0.0.1',
      port: '3306',
      user: 'root',
      password: 'password',
      database: 'your_database',
    },
    // 是否加载到 app 应用上下文
    app: true,
    // 是否加载到 agent 中
    agent: false,
  },
};

在这个配置中：

• client：包含了连接到 MySQL 数据库所需的参数，如主机地址、端口、用户名、密码和数据库名。
• app：配置插件是否需要在应用上下文中加载，通常设为 true。
• agent：配置插件是否需要在 agent 上下文中加载，一般设为 false。

确保正确配置这些参数，以便插件能够成功连接到你的 MySQL 数据库实例。