php sequelize,egg.js整合数据库ORM框架Sequelize

在上篇文章中我们写了egg.js怎么连接mysql数据库, 而在一些较为复杂的应用中，我们可能会需要一个 ORM 框架来帮助我们管理数据层的代码。Java中有Mybatis、Hibernate、Spring Data Jpa, 在Php中Thinkphp框架也集成ORM框架功能, 而在 Node.js 中，sequelize 是一个我们广泛使用的 ORM 框架，它支持 MySQL、PostgreSQL、SQLite 和 MSSQL 等多个数据源

安装

cnpm i -S egg-sequelize mysql2

开启sequelize插件

config/plugin.js

module.exports = {

sequelize: {

enable: true,

package: 'egg-sequelize',

}

};

配置sequelize

我们这里连接mysql数据库

/* eslint valid-jsdoc: "off" */

'use strict';

/**

* @param {Egg.EggAppInfo} appInfo app info

*/

module.exports = appInfo => {

/**

* built-in config

* @type {Egg.EggAppConfig}

**/

const config = exports = {

// sequelize配置

sequelize: {

dialect: 'mysql',

host: 'ip地址',

port: 3306,

database: 'test',

username: 'root',

password: '123456'

}

};

// use for cookie sign key, should change to your own and keep security

config.keys = appInfo.name + '_1565058424941_6691';

// add your middleware config here

config.middleware = [];

// add your user config here

const userConfig = {

// myAppName: 'egg',

};

return {

...config,

...userConfig,

};

};

数据库迁移(Migrations)

在实际开发中, 大部分情况下是多人协作的， 在项目的演进过程中， 每一次迭代都可能对数据库结构做变更, 怎么解决这个问题? 这时候我们就需要Migrations来帮我们管理数据结构的变更了

sequelize提供了sequelize-cli工具来实现Migrations

先安装sequelize-cli

cnpm i --save-dev sequelize-cli

在根目录创建.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 配置文件和目录

// 执行下面两条命令, 会根据根目录下我们刚才创建的.sequelizerc生成Migrations 配置文件和目录

npx sequelize init:config

npx sequelize init:migrations

执行完上面两条命令, 根目录多了个database文件夹

database

├── migrations

└── config.json

到这里, sequelize-cli和相关配置都初始化好了

创建表

在 Migration 文件来创建我们的表users

执行下面的命令

npx sequelize migration:generate --name=init-users

执行完后会在 database/migrations 目录下生成一个 migration 文件(${timestamp}-init-users.js)，我们修改它来处理初始化 users 表

我这里生成的是20190806050532-init-users.js, 修改该文件内容

'use strict';

module.exports = {

// 在执行数据库升级时调用的函数，创建 users 表

up: async (queryInterface, Sequelize) => {

const { INTEGER, DATE, STRING } = Sequelize;

await queryInterface.createTable('users', {

id: { type: INTEGER, primaryKey: true, autoIncrement: true },

name: STRING(30),

age: INTEGER,

created_at: DATE,

updated_at: DATE,

});

},

// 在执行数据库降级时调用的函数，删除 users 表

down: async queryInterface => {

await queryInterface.dropTable('users');

},

};

执行 migrate 进行数据库变更

# 升级数据库

npx sequelize db:migrate

# 如果有问题需要回滚，可以通过 `db:migrate:undo` 回退一个变更

# npx sequelize db:migrate:undo

# 可以通过 `db:migrate:undo:all` 回退到初始状态

# npx sequelize db:migrate:undo:all

执行npx sequelize db:migrate之后, 我们现在去查看数据库多两张表SequelizeMeta和users

接下来我们就可以编写代码进行数据库操作了

创建app/model/user.js

'use strict';

module.exports = app => {

const { STRING, INTEGER, DATE } = app.Sequelize;

const User = app.model.define('users', {

id: { type: INTEGER, primaryKey: true, autoIncrement: true },

name: STRING(30),

age: INTEGER,

created_at: DATE,

updated_at: DATE,

});

return User;

};

这里创建的Model模型可以在Controller和Service中通过app.model.User或ctx.model.User访问

我们创建一个app/controller/user.js

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

class UserController extends Controller {

async index() {

// 查询所有用户信息

ctx.body = await this.ctx.model.User.findAll();

}

}

module.exports = UserController;

最后一步配置路由

app/router.js

module.exports = app => {

const { router, controller } = app;

router.get('/user', controller.user.index);

};

测试