什么是 Sequelize
Sequelize 是一种基于 Node.js 的 ORM(对象关系映射)框架,它支持多种数据库类型的操作,包括但不限于 MySQL、MariaDB、SQLite、PostgreSQL 和 MSSQL 等。
Sequelize 提供了一种比较高效且易于维护的方式来操作数据库。在 Sequelize 中,表被映射为模型,每个模型对应着一个表格。通过模型,我们可以方便地进行数据的 CRUD(增删改查)及其他的查询。
在 Sequelize 中,我们可以使用 Scope 来封装模型的查询条件。
Scope 是什么
Scope 是 Sequelize 中的一个特性,它允许我们封装模型的查询条件,从而让代码更加简洁、易于维护。
通过 Scope,我们可以在模型定义中定义一些查询方法,这些方法可以接收一些条件,然后根据条件生成相应的查询语句。
接下来,我们会通过示例代码来详细介绍 Scope。
如何使用 Scope
为了更好地说明使用 Scope 的方法,我们对 Sequelize 进行了一些配置工作,具体的代码如下:
-- -------------------- ---- ------- ----- --------- - -------------------- ----- --------- - --- ----------- -------- -------- ----- ------------ ----- ----- --------- ------- --------- ----------- --------- ---------- -- ----- ---- - ------------------------ - --- - ----- ------------------ ----------- ----- -------------- ---- -- ----- - ----- ----------------- ---------- ----- -- ---- - ----- ------------------ ---------- ----- -- ------- - ----- ---------------------- ---------- ---------- ------ ------------- ------ - -- - ------------ ---- -- ----------------
以上代码定义了一个 User 模型,并进行了 Sequelize 的一些基本配置。其中,User 模型有 id、name、age、gender 四个属性,分别表示用户的 ID、姓名、年龄和性别。
接下来,我们会使用 Scope 来对 User 模型进行封装。
基础 Scope
首先,我们来实现一个最基本的 Scope,它可以根据指定的 name 属性进行模糊查询。代码如下:
User.addScope('byName', (name) => ({ where: { name: { [Sequelize.Op.like]: `%${name}%` } } }))
以上代码定义了一个 Scope,名为 byName,它接收一个参数 name。当我们调用 User.scope('byName').findAll() 时,会返回一个根据 name 模糊查询的结果集。
在上述代码中,我们使用了 Sequelize.Op.like 来表示模糊查询,%${name}%
表示匹配 name 属性中包含 name 字符串的数据。
接下来,我们使用 byName Scope 来查询符合条件的用户数据:
const users = await User.scope('byName').findAll({ where: { age: { [Sequelize.Op.gt]: 10 } } })
以上代码实现了根据年龄和姓名进行查询,其中 age > 10,name 中包含 'lisi' 字符串。可以看到,Scope 可以与普通的 where 查询条件组合使用。
匿名 Scope
如果我们不想为一个 Scope 指定名字,可以使用匿名 Scope,代码如下:
User.addScope((name) => ({ where: { name: { [Sequelize.Op.like]: `%${name}%` } } }), { override: true })
以上代码定义了一个匿名 Scope,它同样可以进行模糊查询。
多条件 Scope
我们还可以定义多个条件的 Scope,代码如下:
User.addScope('byAgeAndGender', (age, gender) => ({ where: { age, gender } }))
在以上代码中,我们定义了一个 byAgeAndGender Scope,它接收两个参数:age 和 gender。该 Scope 可以根据 age 和 gender 两个属性进行查询。
然后,我们可以通过 User.scope('byAgeAndGender', { age: 20, gender: 'female' }).findAll() 进行查询,代表查询年龄为 20,性别为 female 的用户数据。
Scope 组合
在实际使用中,我们可能需要将多个 Scope 进行组合使用。这时,我们可以使用 combine 方法,代码如下:
-- -------------------- ---- ------- ---------------------- ----- -- -- ------ - --- - --- ------------------------- -------- -- -- ------ - ------ - --- ------------------------------- ---------- ----- ------- -- -- ------ - ---- ------ - --- ------------------------------------- ---------- ----- ------- ----- -- -- ------ - ------------------ - - ---- ------ -- - ----- - -------------------- ----------- - - - - --- ----- ----- - ----- ------------ ----------------- -------- ------------ ------ - ---- --- ------- -------- - --
此时,我们已经定义了 byAge、byGender、byAgeAndGender 和 byAgeAndGenderOrName 四个 Scope。其中,byAgeAndGender Scope 组合了 byAge 和 byGender 两个 Scope,byAgeAndGenderOrName Scope 则对两个查询条件进行了或运算。
最后,我们在查询时使用了 byAgeAndGender 和 byName 两个 Scope 进行组合使用,以查询符合条件的用户数据。
总结
以上就是 Sequelize 中 Scope 的介绍,通过 Scope,我们可以灵活地使查询条件更加易于维护,提高代码的可读性。在实际开发中,我们也可以根据业务需求设计出更加复杂的 Scope。
值得注意的是,当多个 Scope 进行组合时,它们的执行先后顺序是根据添加的顺序来决定的。如果遇到冲突,则后面添加的 Scope 会覆盖前面的 Scope。
了解了 Scope 的基本使用方法后,我们可以在实际开发中应用该特性,从而使代码更加高效、简洁。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64c3346783d39b488172b81b