Sequelize

最新推荐文章于 2023-05-31 00:33:52 发布
最新推荐文章于 2023-05-31 00:33:52 发布
阅读量803 收藏 5
点赞数
分类专栏： 数据库 文章标签： mysql 数据库 node.js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38829069/article/details/109408025
版权

文章目录

一、安装

通过npm安装sequelize和mysql

npm install --save sequelize
npm install --save mysql2

二、建立mysql连接

接下来我们会用Sequelize的构造方法来创建一个mysql的连接实例。

先来看看sequelize官方文档中构造方法的定义

public constructor(database: string, username: string, password: string, options: Object)

再来看看我们实际代码中对构造方法的调用：

const Sequelize = require('sequelize');
 
const TcDb = new Sequelize(database, username, password, {
    host: DB_CONFIG.HOST,
    port: DB_CONFIG.PORT,
    dialect: 'mysql',
    timezone: '+08:00',
    logging: false,
    pool: {
        max: 5,
        min: 0,
        idle: 10000
    },
    define: {
        freezeTableName: true,//禁止自动修改表名
        timestamps: false,//不需要添加 createdAt 和 updatedAt 两个时间戳字段
    }
});

解释几个必要参数，以及日常使用频率较高的参数

  • database：数据库的名称
  • username：用来认证数据库连接的用户名
  • password：用来认证数据库连接的密码
  • host：数据库的host地址
  • port：数据库服务的端口
  • dialect：数据库语言，可以选mysql、postgres、sqlite等
  • timezone：时区，将数据库时间转换成js的date时候会用到，默认是：‘+00:00’，我们一般设置成中国的时区，避免一些时间转换的麻烦
  • logging：执行每次数据库操作，是否在在控制台输出原生sql的log
  • pool：数据库连接池的设置，用的是默认配置
  • freezeTableName：默认为false，是否需要固定表名，如果设置为
    true，js中定义表名会和数据库中创建的表名相同，如果为false，Sequelize会按照他的规则生成一个表名
  • timestamps：默认为true，默认情况下，Sequelize会为每个表创建2个字段，createdAt和updatedAt，设置为false则不会自动创建这2个字段

初始化完mysql的连接后，可以通过下面的代码来验证下是否连接成功：

TcDb.authenticate()
    .then(() => {
        console.log('Connection has been established successfully.');
    })
    .catch(err => {
        console.error('Unable to connect to the database:', err);
    });

三、编写表的model文件

一般情况下，一个表对应一个js文件，在js文件的开头我们先定义表结构，关于这张表的所有查询、更新、插入等数据库方法也会写在这个js文件里面。 接下来我们来看一个简单的用户表的model定义。

/**
 * 用户表
 * wx_user
 */
const {TcDb} = require('../db-info');
const Sequelize = require('sequelize');
const Model = Sequelize.Model;
 
class WxUserModel extends Model {
}
 
WxUserModel.init({
    id: {type: Sequelize.INTEGER, primaryKey: true, autoIncrement: true, comment: '主键'},
    openId: {type: Sequelize.STRING(32), comment: '公众号登录授权返回的openId', unique: true},
    mobile: {type: Sequelize.STRING(50), comment: '加密后的手机号'},
    realName: {type: Sequelize.STRING(100), comment: '真实姓名'},
    belongBank: {type: Sequelize.INTEGER, comment: '所属网点'},
    createTime: {
        type: Sequelize.DATE,
        defaultValue: Sequelize.literal('NOW()'),
        comment: '创建时间'
    },
    updateTime: {
        type: Sequelize.DATE,
        defaultValue: Sequelize.literal('NOW()'),
        comment: '更新时间'
    },
}, {
    sequelize: TcDb,
    modelName: 'wx_user'
});
 
module.exports = WxUserModel;

第一步：创建一个用户表对应的class类，继承于Model。这个Model类就是ORM框架的纽带，用来将我们js中定义的表结构映射到Mysql中。

第二步：调用我们用户表Model的init()方法来定义我们的表结构。

public static init(attributes: Object, options: Object): Model

init()方法需要传入2个对象就能完成一个表的定义的，我们来分别看看两个参数的主要属性分别有什么：

【attributes】第一个参数对象里面存放的是表中每一列的定义，key是表中的列名，vaule也是一个对象，包含了该列的属性，常用的属性如下：
type：必选参数，列的数据类型，展示下常用的类型以及和mysql中类型的对应关系，所有的类型请参考官方文档

https://sequelize.org/v5/manual/data-types.html

Sequelize.STRING                      // VARCHAR(255)
Sequelize.STRING(1234)                // VARCHAR(1234)
Sequelize.STRING.BINARY               // VARCHAR BINARY
Sequelize.TEXT                        // TEXT
Sequelize.TEXT('tiny')                // TINYTEXT
 
Sequelize.INTEGER                     // INTEGER
Sequelize.BIGINT                      // BIGINT
Sequelize.BIGINT(11)                  // BIGINT(11)
 
Sequelize.FLOAT                       // FLOAT
Sequelize.FLOAT(11)                   // FLOAT(11)
Sequelize.FLOAT(11, 10)               // FLOAT(11,10)
 
Sequelize.DOUBLE                      // DOUBLE
Sequelize.DOUBLE(11)                  // DOUBLE(11)
Sequelize.DOUBLE(11, 10)              // DOUBLE(11,10)
 
Sequelize.DECIMAL                     // DECIMAL
Sequelize.DECIMAL(10, 2)              // DECIMAL(10,2)
 
Sequelize.DATE                        // DATETIME for mysql / sqlite, TIMESTAMP WITH TIME ZONE for postgres
Sequelize.DATEONLY                    // DATE without time.
Sequelize.BOOLEAN                     // TINYINT(1)

  • allowNull：可选参数，默认为true，对应mysql中是否允许该列为空

  • defaultValue：可选参数，默认为null，对应mysql中该列的默认值

  • unique：可选参数，默认为false，标记该列是否唯一，如果设置为 ture，会为该列创建一个唯一索引

  • primaryKey：可选参数，默认为false，标记该列是否为主键

  • autoIncrement：可选参数，默认为false，该列是否自增，一般和主键联用

  • comment：可选参数，默认为null，列的注释，v5版本中会将comment字段同步的mysql中的注释，见下图

1

【options】第二个参数对象包含的主要属性再来看看：

  • sequelize：必选参数，对应是我们前面第二步中创建mysql库连接实例时候返回的对象
  • modelName：可选参数，数据库的表名，这个字段一般会自定义的，默认为class的名称
  • indexes：可选参数，用来定义表的索引，可以在此处设置表中字段的唯一索引、全文索引等

四、生成mysql中的表

刚刚我们完成了js中表model的定义，这时候我们需要在数据库中创建这个表了。Model提供了一个sync()方法用来创建表。

const WxUserModel = require('./model/wx-user');
 
WxUserModel.sync({force: true})
        .then((result) => {
            console.log(result);
        })
        .catch((err) => {
            console.error(err);
        });

sycn()方法中传了一个参数force（是否强制创建表），false表示如果数据库已存在这个表则不执行任何操作；true表示如果数据库中存在这个表，会先将原来的表以及里面的数据删除再创建。

五、增删改查

Sequelize的Model类为我们提供了对数据库CRUD操作的方法。在第三步的时候我们创建了一个WxUserModel继承于Model，Model类有很多自带的方法比如create()、findOne()、update()、destory()…

但是我们的实际项目中对数据库的操作不会是简单的增删改查，我们会对Model类提供的方法上添加很多自己的逻辑。比如查询用户列表的时候，可能涉及到很多过滤条件（年龄、名字以及分页信息等），所以我们一般会封装自己的方法。为了避免自定义的方法名和Model类的方法名重复，我的习惯是在自定义的方法前面加一个小写的c，表示是class方法，比如

WxUserModel.cCreateOne(param1, param2, param2)
WxUserModel.cFindAllByFilter(param1, param2, param2)
WxUserModel.cUpdateOne(param1, param2, param2)
WxUserModel.cDeleteOne(param1, param2, param2)

插入

//Sequelize Model定义的插入方法
public static create(values: Object, options: Object): Promise<Model>
 
//自定义方法
WxUserModel.cCreateOne = function (openId, mobile, realName) {
    return WxUserModel.create({openId: openId, mobile: mobile, realName: realName});
};
 
//方法调用
let result = await WxUserModel.cCreateOne('abcdefghij', '18888888888', 'wyk');

查找

//Sequelize Model定义的插入方法
public static findOne(options: Object): Promise<Model>
 
//自定义方法
WxUserModel.cFindOneByName = function (realName) {
    return WxUserModel.findOne({
        where: {realName: realName}
    });
};
 
//方法调用
let result = await WxUserModel.cFindOneByName('wyk');

更新

//Sequelize Model定义的插入方法
public update(values: Object, options: Object): Promise<Model>
 
//自定义方法，updateDict是我们需要更新成的新属性的对象
WxUserModel.cUpdateOneByOpenId = function (openId, updateDict) {
    updateDict.updateTime = new Date();
 
    return WxUserModel.update(updateDict, {
        where: {openId: openId}
    })
};
 
//方法调用
let result = await WxUserModel.cUpdateOneByOpenId('abcdefghij', {name:'newName', mobile: '19999999999'});

删除

//Sequelize Model定义的插入方法
public destroy(options: Object): Promise
 
//自定义方法
WxUserModel.cDeleteOneByOpenId = function (openId) {
    return WxUserModel.destroy({
        where: {openId: openId}
    })
};
 
//方法调用
let result = await WxUserModel.cDeleteOneByOpenId('abcdefghij');

六、事务

事务在mysql中是必不可少的。举个经典的例子，当用户购买某个产品服务时支付成功了，我们需要对数据库进行的操作有：置订单的状态、服务表插入记录、修改用户属性等等等。这些操作要么全部成功，要么全部失败，不能说其中2个成功，其他操作失败了。所以我们就需要把每一个逻辑单元中的所有操作放在一个事务里，如果所有数据库操作执行完成后没有异常，那就提交这次事务；如果出现异常，事务则执行回滚。

Sequelize中事务的文档请参考：https://sequelize.org/v5/manual/transactions.html

Sequelize为我们提供了2种使用事务方法

1、托管式：在这种模式下，顺利执行完成会自动提交事务，出现异常会自动执行回滚。它基于是promise的链式调用，在sequelize.transaction的回调中，必须返回一个promise对象。如果promise最终的状态为fulfilled，则自动提交事务；如果promise最终的状态为rejected，则自动回滚。看一个官方的例子：

//TcDb为第二步中创建的数据库连接对象
return TcDb.transaction(t => {
  //回调中务必返回一个promise对象
  return WxUserModel.create({
    openId: 'openId1'
  }, {transaction: t}).then(user => {
    return WxUserModel.create({
      openId: 'openId2'
    }, {transaction: t});
  });
}).then(result => {
  //执行完成，事务已自动提交callback
}).catch(err => {
  //出现异常，事务已回滚
});

2、非托管式：提交事务和回滚的操作需要用户手动调用。这个是我在项目中使用的方法，只要稍作封装，使用起来会很方便。详细介绍下用法：

比如有一个逻辑操作，需要创建一个用户A并且更新用户B的手机号，这2个操作需要放在事务中来保证一致性。我们要先对第五步中的创建方法和更新方法进行一点小改造：传入的参数增加一个transaction对象。

//创建
WxUserModel.cCreateOne = function (t, openId, mobile, realName) {
    return WxUserModel.create(
        {openId: openId, mobile: mobile, realName: realName},
        {transaction: t}
    );
};
 
//更新
WxUserModel.cUpdateOneByOpenId = function (t, openId, updateDict) {
    updateDict.updateTime = new Date();
 
    return WxUserModel.update(updateDict, {
        where: {openId: openId},
        transaction: t
    })
};

上面2个方法都增加了一个参数t（实际项目中每一个CRUD方法都需要传入t参数）。参数t是什么呢？他是一个数据库事务对象，通过TcDb.transaction()返回的promise中得到的。一般会在数据库连接对象（TcDb）上再封装一个getTransaction()方法，用来获取事务对象t，以及管理事务流程（commit和callback操作）。

/**
 * 封装开启数据库事务的方法
 *
 * @param callback
 * @returns {Promise<void>}
 */
TcDb.getTransaction = async (callback) => {
    let t = null;
    try {
        t = await TcDb.transaction();
        await callback(t);
        t.commit();
    } catch (err) {
        if (t)
            t.rollback();
        console.error(err);
        //try-catch只是为了能够在异常的时候rollback，如果有异常，可抛出
        //throw new Error(err);
    }
};

最后将获取事务方法和带事务参数插入和更新方法连起来使用。

async function dbTest() {
    await TcDb.getTransaction(async (t) => {
        let result = await WxUserModel.cCreateOne(t, 'openId1', '18888888888', 'wyk');
        console.log(result);
 
        let result2 = await WxUserModel.cUpdateOneByOpenId(t, 'abcdefghij', {name: 'newName', mobile: '19999999999'});
        console.log(result2);
    });
}
 
dbTest();
perwhy_wang
关注
  • 0
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
学会Sequelize，让你操作数据更丝滑
大转转FE
04-28 4479
Sequelize 是一个基于 promise 的 Node.js ORM, 目前支持 Postgres, MySQL, MariaDB, SQLite 以及 Microsoft SQL Server. 它具有强大的事务支持, 关联关系, 预读和延迟加载,读取复制等功能。一、前言本文希望通过下面的知识讲解及一些实战经验分享，给予即将入门或正在学习的同学一些帮助。在之前刚接...
Sequelize入门及简单的增删改查
最新发布
xu_xu_0924的博客
06-22 424
由于我是刚入门NodeJS，所以还只是对sequelize的简单了解，之后有更深的了解再继续分享。
Sequlize
yccaaa的博客
04-27 352
1.include关联时  加required：true为左关联 false为内关联2.sequlize 查询时需加上 raw: true（只返回数据） 否则数据在dataValues里
sequelize
南方有乔木的博客
07-18 235
sequelize 官方文档 https://github.com/sequelize/sequelize 例子 https://github.com/sequelize/express-example https://github.com/cmmkj/sequelize_demo 教程参考 https://www.liaoxuefeng.com/wiki/1022910821149312/110157...
Sequelize小记
daduryi的博客
07-24 268
&#13; http://docs.sequelizejs.com/   官方英文 Object-Relational Mapping 增 Model.create({field1:'a', field2:'b'})   删 m.destroy()   改 m = M.q_u_e_r_y({}) m.field1=1; m.save()   查 Model.findAll({...
sequelize数据库操作工具
10-12
**Sequelize数据库操作工具详解** Sequelize是一款流行的JavaScript ORM（对象关系映射）工具，主要用于Node.js环境，它支持多种数据库系统，包括MySQL、PostgreSQL、SQLite和Microsoft SQL Server。Sequelize使得...
Node服务端框架Express-Sequelize-Mysql模型架构设计封装
06-27
Node服务端框架Express-Sequelize-Mysql模型架构设计封装开箱即用。 Sequelize 是一个基于 promise 的 Node.js ORM, 目前支持 Postgres, MySQL, MariaDB, SQLite 以及 Microsoft SQL Server. 它具有强大的事务支持, ...
sequelize-docs-Zh-CN：Sequelize文档的中文版本：v4.42.0 | v5.21.5 | v6.3.5
02-27
续集文档中文版 此项目自 / 项目中的文档。除特殊情况，将保持每月一次的同步频率。 更新日志请参见： Sequelize是一个基于诺言的Node.js...const { Sequelize , Model , DataTypes } = require ( 'sequelize' ) ; con
koa2-sequelize：koa2 + mysql + sequelize分页api
02-03
**Koa2、Sequelize与MySQL：构建高效分页API** 在现代Web开发中，构建高效的API服务是至关重要的。本项目利用了Koa2（一个由Express团队开发的下一代Node.js Web应用框架）、Sequelize（一个流行的ORM，Object-...
Sequelize工具v1.1
03-21
新版mysql连接工具封装（sequelize），修复部分mysql类型不支持的问题。
sequelize入门
weixin_34004750的博客
12-12 163
最近在公司接触到了sequelize(Nodejs的ORM框架)，研究了一下官方文档，做了以下整理 Models Definition let DeviceInterface = Sequelize.define('DeviceInterface', { name: { type: Sequeliz...
NODE.JS ORM之sequelize 框架
坐在那边看天空 的博客
02-18 3228
1、安装： npm install sequelize   //ORM 主框架 npm install -g sequelize-auto // 已有数据库表生成modle工具 2、已有的数据库生成modle npm install -g tedious //安装MSSQL数据库驱动。 sequelize-auto -o "./models" -d zmc
Sequelize：Node.js 中的强大 ORM 框架
Codernmx
05-31 7974
在现代的 Web 开发中，与数据库进行交互是常见的任务。为了简化和加速与数据库的交互过程，许多开发人员选择使用 ORM（对象关系映射）框架。ORM 框架提供了一种将数据库记录映射到对象的方式，使开发人员可以使用面向对象的编程方式来处理数据库操作。在 Node.js 生态系统中，Sequelize 是一个备受青睐的 ORM 框架，本文将介绍 Sequelize 的特性和用法。Sequelize 是一个基于 Promise 实现的 Node.js ORM 框架，用于与关系型数据库进行交互。
sequelize（一）
aline200的博客
07-20 3372
Sequelize.js 提供对 MySQL，MariaDB，SQLite 和 PostgreSQL 数据库的简单访问，通过映射数据库条目到对象，或者对象到数据库条目。是一个实用 ORM（Object-Relational-Mapper），适用于 Node.js 的环境。 1、node项目中安装Sequelize npm install --save sequelize 2、引用
sequelize学习笔记
weixin_44328894的博客
09-07 3329
sequelize学习笔记 一、前言 1、sequelize简介【sequelize官方文档】、【sequelize-v3到v6文档】 sequelize是众多ORM框架的一种，ORM框架的作用就是就是可以把关系型数据库表结构映射为javascript对象。通过ORM框架，对数据库进行 CURD时，不需要直接去书写 SQL语句，而是通过操作对象，进而由框架转化为具体的SQL语句进行查询，将对象转化表中的一条记录。 2、sequelize模型 模型是sequelize的本质，sequelize同过一个个的模型
绝版Node--Sequlize搭建服务（Node全栈之路 二）
07-21 172
在Node全栈之路（一），也就是上篇文章中，我们讲到了sequlize的基本增删该查,这篇文章，我们在上篇文章的基础上继续探讨，讲一下关于sequlize创建的表之间的对应关系 参考资料：https://itbilu.com/nodejs/npm/VkYIaRPz-.html#induction-promise 本人联系方式：微信：jkxx123321 在这里，对上一篇文...
Sequelize入门
ccf19881030的专栏
11-10 1426
Getting Started - Sequelize入门 在本教程中,你将进行学习 Sequelize 的简单设置. 安装 Sequelize 的使用可以通过 npm (或 yarn). npm install --save sequelize 你还必须手动为所选数据库安装驱动程序： # 选择以下之一: $ npm install --save pg pg-hstore # Postgres $ npm install --save mysql2 $ npm install --save mariadb
sequelize mysql
08-19
`sequelize` 是一个基于 JavaScript 的 ORM（对象关系映射）库，用于在 Node.js 环境下操作数据库。`findOne` 是 `sequelize` 提供的一个方法，用于从数据库中查询符合条件的第一条记录。 下面是使用 `sequelize` 查询 MySQL 数据库中符合条件的第一条记录的示例代码： ```javascript const { Sequelize, Model, DataTypes } = require('sequelize'); // 创建 Sequelize 实例 const sequelize = new Sequelize('database', 'username', 'password', { host: 'localhost', dialect: 'mysql', }); // 定义模型 class User extends Model {} User.init({ username: DataTypes.STRING, email: DataTypes.STRING, }, { sequelize, modelName: 'user' }); // 查询符合条件的第一条记录 async function findOneUser() { try { const user = await User.findOne({ where: { username: 'john' }, }); console.log(user); } catch (error) { console.error(error); } } // 运行查询 findOneUser(); ``` 在上述示例中，我们首先创建了 `sequelize` 实例，并使用该实例定义了一个名为 `User` 的模型。然后，我们通过调用 `User.findOne` 方法查询了用户名为 "john" 的用户记录，并将结果打印到控制台。 请注意，以上代码只是一个示例，实际使用时需要根据数据库连接配置和模型定义进行相应的修改。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值