Sequelize 是一个基于 promise 的 Node.js ORM, 目前支持 Postgres, MySQL, SQLite 和 Microsoft SQL Server. 它具有强大的事务支持, 关联关系, 读取和复制等功能[2]. 下面主要介绍如何使用sequelize-cli工具快速构建nodejs的数据访问层。
基于express创建nodejs web应用
基于express建立nodejs的web应用,在此基础上再使用sequlize建立数据访问层和数据库。
1 | mkdir myapp |
基于sequelize创建数据访问层和数据库
安装sequlize
1 | npm install --save sequelize |
安装sequelize-cli
首先应安装sequelize-cli工具,可以选择全局安装,也可以选择本地安装。
1 | npm install --save-dev sequelize-cli |
建立初始的ORM引导框架
使用如下命令在Nodejs Web应用中建立初始的数据访问层。
1 | mkdir db |
这将创建以下文件夹:
- config, 包含配置文件,它告诉CLI如何连接数据库
- models,包含您的项目的所有模型
- migrations, 包含所有迁移文件
- seeders, 包含所有种子文件
修改配置文件以连接到数据库管理系统,并创建数据库
在建立模型之前,应先修改config/config.json,以告诉 CLI 如何连接到数据库。config/config.json内容如下:
1 | { |
上述配置修改了数据库的字符集,使之能支持中文。当然在创建数据库之前,应配置mysql数据库管理系,使其支持utf8字符集。可执行如下命令查看其支持的字符集,如果其不支持uft字符集,请按照参考链接[3]进行修改。
1 | mysql> show variables like '%char%'; |
使用如下命令创建数据库:
1 | ../node_modules/.bin/sequelize db:create |
使用如下命令删除数据库:
1 | ../node_modules/.bin/sequelize db:drop |
创建模型
我们将使用 model:generate 命令。 此命令需要两个选项:
- name, 模型的名称
- attributes, 模型的属性列表
创建一个名叫 User 的模型:
1 | ../node_modules/.bin/sequelize model:generate --name User --attributes firstName:string,lastName:string,email:string |
这将发生以下事情:
- 在 models 文件夹中创建了一个 user 模型文件
- 在 migrations 文件夹中创建了一个名字像 XXXXXXXXXXXXXX-create-user.js 的迁移文件
注意: _Sequelize 将只使用模型文件,它是表描述。另一边,迁移文件是该模型的更改,或更具体的是说 CLI 所使用的表。 处理迁移,如提交或日志,以进行数据库的某些更改。
再创建一个名为Role的模型,它跟User是一对多的关系:
1 | ../node_modules/.bin/sequelize model:generate --name Role --attributes roleName:string |
定义关系
Role和User是一对多的关系,因此需要修改它们的模型定义。
修改models/role.js如下:
1 | 'use strict'; |
修改models/user.js如下:
1 | 'use strict'; |
修改和运行迁移
Role和User是一对多的关系,因此需要修改User迁移文件的定义。
修改migrates/20180622153152-create-user.js如下:
1 | 'use strict'; |
注意:这里主要给User添加了外键字段,外键字段命名有规则:通常为小写的模型名加Id,即驼峰风格。例如这里加了roleId的外键字段。
直到目前为止,CLI没有将任何东西插入数据库。 刚刚为模型 User和Role创建了必需的模型和迁移文件。 现在要在数据库中实际创建该表,需要运行 db:migrate 命令。
1 | ../node_modules/.bin/sequelize db:migrate |
此命令将执行这些步骤:
- 将在数据库中创建一个名为 SequelizeMeta 的表。 此表用于记录在当前数据库上运行的迁移
- 开始寻找尚未运行的任何迁移文件。 这可以通过检查 SequelizeMeta 表。 在这个例子中,它将运行创建的 XXXXXXXXXXXXXX-create-role.js和XXXXXXXXXXXXXX-create-user.js 迁移。
- 创建一个名为 Roles 的表,其中包含其迁移文件中指定的所有列。
- 创建一个名为 Users 的表,其中包含其迁移文件中指定的所有列。
除了使用sequelize db:migrate命令创建数据库表之外,可以使用models同步创建或删除数据库表,例如:
1 | if (appConfig.dbCreated === false) { |
创建种子,生成测试数据
假设我们希望在默认情况下将一些数据插入到几个表中。 例如创建几个用户和角色:
1 | ../node_modules/.bin/sequelize seed:generate --name demo-role |
这个命令将会在 seeders 文件夹中创建两个种子文件。文件名看起来像是 XXXXXXXXXXXXXX-demo-role.js和XXXXXXXXXXXXXX-demo-user.js,它遵循相同的 up/down 语义,如迁移文件。
现在我们应该编辑这两个文件,将演示角色插入Role表,将演示用户插入User表。修改XXXXXXXXXXXXXX-demo-role.js如下:
1 | 'use strict'; |
修改XXXXXXXXXXXXXX-demo-user.js如下:
1 | 'use strict'; |
种子文件修改后,即可使用如下命令将演示数据插入数据库中:
1 | ../node_modules/.bin/sequelize db:seed:all |
工程实践经验总结
在工程实践中,只需使用sequelize-cli创建数据库,生成models即可,然后使用代码直接根据models创建数据库表,并生成测试数据。
参考链接
- Sequelize Reference,by sequelizejs.
- Sequelize 中文文档,by demopark.
- 解决Mysql中文乱码问题, by 最怕认真.
- How to set primary key type to UUID via Sequelize CLI,by stackoverflow.
- 数据库表主键设计方法,by jackhuang.
- Variable,by sequelize.
- cascade delete does not work,by sequelize.
- Adding foreign key to a table using Sequelize,by Nathan Sebhastian.
- Eager Loading - 预先加载,by demopark.