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 支持, 谢谢.