Sequelize 中文文档 v4 -Scopes - 作用域

Scopes - 作用域

此系列文章的应用示例已发布于 GitHub: sequelize-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star.

作用域允许你定义常用查询，以便以后轻松使用。 作用域可以包括与常规查找器 where, include, limit 等所有相同的属性。

定义

作用域在模型定义中定义，可以是finder对象或返回finder对象的函数，除了默认作用域，该作用于只能是一个对象：

const Project = sequelize.define('project', {
  // 属性
}, {
  defaultScope: {
    where: {
      active: true
    }
  },
  scopes: {
    deleted: {
      where: {
        deleted: true
      }
    },
    activeUsers: {
      include: [
        { model: User, where: { active: true }}
      ]
    },
    random: function () {
      return {
        where: {
          someNumber: Math.random()
        }
      }
    },
    accessLevel: function (value) {
      return {
        where: {
          accessLevel: {
            [Op.gte]: value
          }
        }
      }
    }
  }
});

通过调用 addScope 定义模型后，还可以添加作用域。 这对于具有包含的作用域特别有用，其中在定义其他模型时可能不会定义 include 中的模型。

始终应用默认作用域。 这意味着，通过上面的模型定义，Project.findAll() 将创建以下查询：

SELECT * FROM projects WHERE active = true

可以通过调用 .unscoped(), .scope(null) 或通过调用另一个作用域来删除默认作用域：

Project.scope('deleted').findAll(); // 删除默认作用域

SELECT * FROM projects WHERE deleted = true

还可以在作用域定义中包含作用域模型。 这让你避免重复 include，attributes 或 where 定义。

使用上面的例子，并在包含的用户模型中调用 active 作用域（而不是直接在该 include 对象中指定条件）：

activeUsers: {
  include: [
    { model: User.scope('active')}
  ]
}

使用

通过在模型定义上调用 .scope 来应用作用域，传递一个或多个作用域的名称。 .scope 返回一个全功能的模型实例，它具有所有常规的方法：.findAll，.update，.count，.destroy等等。你可以保存这个模型实例并稍后再次使用：

const DeletedProjects = Project.scope('deleted');

DeletedProjects.findAll();
// 过一段时间

// 让我们再次寻找被删除的项目！
DeletedProjects.findAll();

作用域适用于 .find, .findAll, .count, .update 和 .destroy.

可以通过两种方式调用作为函数的作用域。 如果作用域没有任何参数，它可以正常调用。 如果作用域采用参数，则传递一个对象：

Project.scope('random', { method: ['accessLevel', 19]}).findAll();

SELECT * FROM projects WHERE someNumber = 42 AND accessLevel >= 19

合并

通过将作用域数组传递到 .scope 或通过将作用域作为连续参数传递，可以同时应用多个作用域。

// 这两个是等价的
Project.scope('deleted', 'activeUsers').findAll();
Project.scope(['deleted', 'activeUsers']).findAll();

SELECT * FROM projects
INNER JOIN users ON projects.userId = users.id
AND users.active = true

如果要将其他作用域与默认作用域一起应用，请将键 defaultScope 传递给 .scope：

Project.scope('defaultScope', 'deleted').findAll();

SELECT * FROM projects WHERE active = true AND deleted = true

当调用多个作用域时，后续作用域的键将覆盖以前的作用域（类似于 _.assign ）。 考虑两个作用域：

{
  scope1: {
    where: {
      firstName: 'bob',
      age: {
        [Op.gt]: 20
      }
    },
    limit: 2
  },
  scope2: {
    where: {
      age: {
        [Op.gt]: 30
      }
    },
    limit: 10
  }
}

调用 .scope('scope1', 'scope2') 将产生以下查询

WHERE firstName = 'bob' AND age > 30 LIMIT 10

注意 scope2 覆盖 limit 和 age，而 firstName 被保留。 limit，offset，order，paranoid，lock和raw被覆盖，而where和include被浅层合并。 这意味着相同的键在同一个模型的对象以及随后的包含都将相互覆盖。

当将查找对象直接传递到作用域模型上的 findAll 时，适用相同的合并逻辑：

Project.scope('deleted').findAll({
  where: {
    firstName: 'john'
  }
})

WHERE deleted = true AND firstName = 'john'

这里的 deleted 作用域与 finder 合并。 如果我们要将 where: { firstName: 'john', deleted: false } 传递给 finder，那么 deleted 作用域将被覆盖。

关联

Sequelize 与关联有两个不同但相关的作用域概念。 差异是微妙但重要的：

• 关联作用域 允许您在获取和设置关联时指定默认属性 - 在实现多态关联时很有用。 当使用get，set，add和create相关联的模型函数时，这个作用域仅在两个模型之间的关联上被调用
• 关联模型上的作用域 允许您在获取关联时应用默认和其他作用域，并允许您在创建关联时传递作用域模型。 这些作用域都适用于模型上的常规查找和通过关联查找。

举个例子，思考模型Post和Comment。 注释与其他几个模型（图像，视频等）相关联，注释和其他模型之间的关联是多态的，这意味着除了外键 commentable_id 之外，注释还存储一个commentable列。

可以使用 association scope 来实现多态关联：

this.Post.hasMany(this.Comment, {
  foreignKey: 'commentable_id',
  scope: {
    commentable: 'post'
  }
});

当调用 post.getComments() 时，这将自动添加 WHERE commentable = 'post'。 类似地，当向帖子添加新的注释时，commentable 会自动设置为 'post'。 关联作用域是为了存活于后台，没有程序员不必担心 - 它不能被禁用。 有关更完整的多态性示例，请参阅 关联作用域

那么考虑那个Post的默认作用域只显示活动的帖子：where: { active: true }。 该作用域存在于相关联的模型（Post）上，而不是像commentable 作用域那样在关联上。 就像在调用Post.findAll() 时一样应用默认作用域，当调用 User.getPosts() 时，它也会被应用 - 这只会返回该用户的活动帖子。

要禁用默认作用域，将 scope: null 传递给 getter： User.getPosts({ scope: null })。 同样，如果要应用其他作用域，请像这样:

User.getPosts({ scope: ['scope1', 'scope2']});

如果要为关联模型上的作用域创建快捷方式，可以将作用域模型传递给关联。 考虑一个快捷方式来获取用户所有已删除的帖子：

const Post = sequelize.define('post', attributes, {
  defaultScope: {
    where: {
      active: true
    }
  },
  scopes: {
    deleted: {
      where: {
        deleted: true
      }
    }
  }
});

User.hasMany(Post); // 常规 getPosts 关联
User.hasMany(Post.scope('deleted'), { as: 'deletedPosts' });

User.getPosts(); // WHERE active = true
User.getDeletedPosts(); // WHERE deleted = true

如果这篇文章对您有帮助, 感谢 下方点赞 或 Star GitHub: sequelize-docs-Zh-CN 支持, 谢谢.