一、Egg 快速入门、搭建环境、创建项目
环境准备
操作系统:支持 macOS,Linux,Windows
运行环境:Nodejs 建议选择 LTS 版本,Nodejs 最低要求 8.x。
安装 egg 脚手架以及使用 egg-init 创建项目
推荐直接使用脚手架,只需几条简单指令,即可快速生成项目:
$ npm i egg-init -g
$ mkdir hello-egg
$ cd hello-egg
$ egg-init hello-egg --type=simple
$ cd hello-egg
$ npm i
启动项目:
$ npm run dev
$ open http://127.0.0.1:7001/
二、项目使用sequelize连接数据库mysql
安装并配置 egg-sequelize 插件(它会辅助我们将定义好的 Model 对象加载到 app 和 ctx 上)和 mysql2 模块:
安装
cnpm install --save egg-sequelize mysql2
- 在 config/plugin.js 中引入 egg-sequelize 插件
'use strict';
/** @type Egg.EggPlugin */
module.exports.sequelize = {
// had enabled by egg
// static: {
// enable: true,
// }
enable: true,
package: 'egg-sequelize',
};
- 在 config/config.default.js 中编写 sequelize 配置
/* eslint valid-jsdoc: "off" */
'use strict';
/**
* @param {Egg.EggAppInfo} appInfo app info
*/
module.exports = appInfo => {
/**
* built-in config
* @type {Egg.EggAppConfig}
**/
const config = exports = {
};
// use for cookie sign key, should change to your own and keep security
config.keys = appInfo.name + '_1610673778973_1712';
// add your middleware config here
config.middleware = [];
// add your user config here
const userConfig = {
// myAppName: 'egg',
};
config.sequelize = {
dialect: 'mysql',
host: '127.0.0.1',
port: 3306,
database: 'redmark',
username: 'root',
password: 'mysql123',
};
return {
...config,
...userConfig,
};
};
初始化数据库和 Migrations
- 安装 sequelize-cli
cnpm install --save-dev sequelize-cli
在 egg 项目中,我们希望将所有数据库 Migrations 相关的内容都放在 database 目录下,所以我们在项目根目录下新建一个 .sequelizerc 配置文件:
'use strict';
const path = require('path');
module.exports = {
config: path.join(__dirname, 'database/config.json'),
'migrations-path': path.join(__dirname, 'database/migrations'),
'seeders-path': path.join(__dirname, 'database/seeders'),
'models-path': path.join(__dirname, 'app/model'),
};
- 初始化 Migrations 配置文件和目录
npx sequelize init:config
npx sequelize init:migrations
执行完后会生成 database/config.json 文件和 database/migrations 目录,我们修改一下 database/config.json 中的内容,将其改成我们项目中使用的数据库配置
此时 sequelize-cli 和相关的配置也都初始化好了,我们可以开始编写项目的第一个 Migration 文件来创建我们的一个 users 表了。
npx sequelize migration:generate --name=init-users
执行完后会在 database/migrations 目录下生成一个 migration 文件(${timestamp}-init-users.js),我们修改它来处理初始化 users 表
'use strict';
module.exports = {
up: async (queryInterface, Sequelize