Sequelize 中 Model 的定义和使用详解

阅读时长 7 分钟读完

前言

在 Node.js 服务器端开发中,使用 ORM(Object-Relational Mapping)框架能够让我们避免直接操作数据库,使代码更加简洁清晰。而 Sequelize 是一个常用的 ORM 框架,支持多种数据库,包括 PostgreSQL、MySQL、MariaDB、SQLite 和 MSSQL。其中最常用的是 MySQL 和 PostgreSQL。

在 Sequelize 中,Model 是一个封装了数据库表的类。对于一个 Model,在其中定义一组属性,代表数据表中的字段,以及定义一些表之间的关联关系。同时,Model 也负责对表中的行进行 CRUD 操作,即增删改查等操作。

在本文中,我们将详细讲解 Sequelize 中 Model 的定义和使用方法,包括 Model 的属性和关联关系的定义,以及对数据的增删改查操作的实现。

Model 的定义

安装和引入 Sequelize

首先,我们需要在项目中安装 Sequelize 包和对应的数据库驱动。以 MySQL 为例,可以使用以下命令进行安装:

其中,mysql2 是 MySQL 所对应的数据库驱动。

在代码文件中引入 Sequelize 的方法如下:

定义 Model 的属性

使用 Sequelize 定义一个 Model 非常简单,只需要使用 Sequelize 定义一个实例,并调用其 define 方法即可。对于大多数情况,定义 Model 只需要传递两个参数,第一个参数是 Model 的名称,第二个参数是定义 Model 的属性。

下面是一个示例,定义了一个名为 User 的 Model,包含 id、username 和 password 三个属性:

-- -------------------- ---- -------
----- --------- - --- --------------------- ----------- ----------- -
  -------- -------
---

----- ---- - ------------------------ -
  --- -
    ----- ------------------
    ----------- -----
    -------------- ----
  --
  --------- -
    ----- -----------------
    ---------- -----
  --
  --------- -
    ----- -----------------
    ---------- -----
  -
---

在定义属性时,需要注意以下几点:

  • 指定类型(type):常用的数据类型包括 STRING、INTEGER、FLOAT、BOOLEAN 等,不同数据库的数据类型可能有所不同。Sequelize 还支持一些高级类型,例如 JSON、BLOB 等。如果需要使用高级类型,则需要安装对应的数据库驱动。
  • primaryKey:指定该属性是否为主键。主键是一个不能重复、不为空的属性,它用于确定表中的一行数据。一个表只能有一个主键。
  • autoIncrement:指定该属性是否自增。通常用于主键,autoIncrement 为 true 时,插入该属性时可以自动递增。
  • allowNull:指定该属性是否可以为空。默认情况下,所有属性都是可以为空的。如果设置为 false,则在插入和更新数据时,必须保证该属性有值。

定义 Model 的关联关系

在一个复杂的数据库中,数据表之间通常需要建立关联关系。在 Sequelize 中,我们可以使用 belongsTo、hasOne、hasMany 和 belongsToMany 这几个方法来定义表之间的关联关系。

下面是一个示例,定义了一个名为 User 的 Model 和另一个名为 Post 的 Model,它们之间的关联关系为 User 有多个 Post,每个 Post 只属于一个 User:

-- -------------------- ---- -------
----- ---- - ------------------------ -
  -----
---

----- ---- - ------------------------ -
  -----
---

-- ---- --- -----
-------------------

-- ---- ---- ----
---------------------

在上面的例子中,我们使用了 hasMany 和 belongsTo 两个方法,它们的作用分别是:

  • hasMany:在 User 中定义了一个名为 getPosts 的方法,用于获取该 User 关联的所有 Post。
  • belongsTo:在 Post 中定义了一个名为 getUser 的方法,用于获取该 Post 所属的 User。

Sequelize 还提供了另外两个方法:

  • belongsToMany:用于定义多对多关系。
  • hasOne:用于定义一对一关系。

定义 Model 的选项

在定义 Model 时,可以传递一些选项,来控制 Sequelize 的行为。

下面是一些常用的选项:

  • timestamps:指定是否在 Model 中添加 createdAt 和 updatedAt 两个字段。默认为 true。
  • underscored:指定 Model 中字段是否使用下划线分割命名,默认为 false。
  • underscoredAll:指定 Model 中所有字段是否使用下划线分割命名,默认为 false。
  • paranoid:指定是否启用软删除功能。启用后,删除数据时不会直接删除,而是将 deletedAt 字段设置为具体的时间,表示数据被删除的时间。默认为 false。

下面是一个例子,定义了一个名为 User 的 Model,并禁用了自动添加 createdAt 和 updatedAt 字段:

Model 的操作

数据的插入和更新

使用 Sequelize 对数据库进行增删改查操作非常简单。在 Model 中,Sequelize 自动为我们生成了 create、upsert 和 update 等方法,用于插入或更新数据。

使用 create 方法可以新建一条数据,并将其保存到数据库中:

使用 upsert 方法可以更新一条数据,如果该数据不存在,则会新建一条数据:

使用 update 方法可以更新数据库中的数据:

-- -------------------- ---- -------
-------------
  --------- --------
-- -
  ------ -
    --- -
  -
----------- -- -
  -----------------
---

数据的查询和删除

使用 Sequelize 进行查询数据和删除数据也非常简单。在 Model 中,Sequelize 自动为我们生成了 findAll、findOne 和 destroy 等方法,用于查询或删除数据。

findAll 方法可以查询符合条件的所有数据:

findOne 方法可以查询符合条件的第一条数据:

destroy 方法可以删除符合条件的所有数据:

总结

Sequelize 是 Node.js 中常用的 ORM 框架,支持多种数据库,提供了非常友好的 API,便于对数据库进行增删改查操作。在使用 Sequelize 的过程中,我们需要定义 Model 等概念来描述数据表和数据表之间的关系。通过本文的介绍,相信你已经学会了如何使用 Sequelize 定义和使用 Model,并对数据进行增删改查操作。在实际项目中,将本文所讲的知识熟练运用,可以提高开发效率,减少不必要的代码量,使项目代码更加简洁易读。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64c828275ad90b6d0412d932

纠错
反馈