> For the complete documentation index, see [llms.txt](https://kelby.gitbook.io/rails-beginner-s-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kelby.gitbook.io/rails-beginner-s-guide/activerecord_db_opertion/db_opt_scoping.md).

# Scoping

虽然只有 4 个方法，但很实用。

| 方法             | 解释         |
| -------------- | ---------- |
| scope          | 命名 scope   |
| default\_scope | 设置默认 scope |

和

| 方法       | 解释                |
| -------- | ----------------- |
| unscoped | 跳过之前设置的 scope     |
| all      | all 方法，默认已经 scope |

## scope

重点说说这个方法。

两个参数：第一个是名字，第二个是内容，需要以 proc 的形式定义。

**scope 相当于类方法，可检索、查询对象**

可执行一系列的查询语句，如：

```ruby
where(color: :red).select('shirts.*').includes(:washing_instructions)
```

```ruby
class Shirt < ActiveRecord::Base
  scope :red, -> { where(color: 'red') }
  scope :dry_clean_only, -> { joins(:washing_instructions)
                              .where('washing_instructions.dry_clean_only = ?', true) }
end
```

可以调用 `Shirt.red` 和 `Shirt.dry_clean_only`. `Shirt.red` 功能和 `Shirt.where(color: 'red')` 一样。

也就是说，功能上和以下代码一样:

```ruby
class Shirt < ActiveRecord::Base
  def self.red
    where(color: 'red')
  end
end
```

**scope 返回的是 Relation，而不是数组**

你可以调用 `Shirt.red.first`, `Shirt.red.count`, `Shirt.red.where(size: 'small')` 等. 但是 Relation 也可以有数组的行为, 如 `Shirt.red.each(&block)`, `Shirt.red.first`, 和 `Shirt.red.inject(memo, &block)` 等。

**scope 可以链式调用**

`Shirt.red.dry_clean_only` 运行结果是 `red` 和 `dry_clean_only` 综合的结果。 \
&#x20;`Shirt.red.dry_clean_only.count` 返回的是 `red` 和 `dry_clean_only` 综合结果的数目。在这里和 `Shirt.red.dry_clean_only.average(:thread_count)` 类似。

**scope 是一步步走下去的**

```ruby
class Person < ActiveRecord::Base
  has_many :shirts
end
```

假设，elton 是 Person 的实例对象，则 elton.shirts.red.dry\_clean\_only 返回的是 elton(限制条件) 的 red 和 dry\_clean\_only shirts.

**scope 后可直接跟 extensions**

和 has\_many 类似的：

```ruby
class Shirt < ActiveRecord::Base
  scope :red, -> { where(color: 'red') } do
    def dom_id
      'red_shirts'
    end
  end
end
```

**scope 后可直接跟 creating/building 等方法**

用于创建 record

```ruby
class Article < ActiveRecord::Base
  scope :published, -> { where(published: true) }
end

Article.published.new.published    # => true
Article.published.create.published # => true
```

**scope 后可直接跟类方法**

定义如下：

```ruby
class Article < ActiveRecord::Base
  scope :published, -> { where(published: true) }
  scope :featured, -> { where(featured: true) }

  def self.latest_article
    order('published_at desc').first
  end

  def self.titles
    pluck(:title)
  end
end
```

调用如下:

```ruby
Article.published.featured.latest_article
Article.featured.titles
```

## default\_scope

1\) 一个参数，需要以 proc 的形式定义：

```ruby
class Article < ActiveRecord::Base
  default_scope { where(published: true) }
end
```

2\) 始终起作用，不能覆盖，冲突时取合集。

3\) 会影响 initialization 过程。例如以上示例，默认新创建的对象 published 为 true.

4\) 基于第2、3点请慎用。

## unscoped

前面说过 scope 可以链式调用，但如果调用了 `unscoped` 的话，它可以把之前的 scope 给清除掉，包括 default\_scope.

示例：

```ruby
class Post < ActiveRecord::Base
  def self.default_scope
    where published: true
  end
end

Post.all
# Fires "SELECT * FROM posts WHERE published = true"

Post.unscoped.all
# Fires "SELECT * FROM posts"

Post.where(published: false).unscoped.all
# Fires "SELECT * FROM posts"
```

## all

`all` 方法，本身已经 scope，返回的是 Relation 对象。如果已调用了别的 scope 方法，则没必要使用它，因为默认返回的就已经是所有符合条件的数据。

## 为什么参数要是 proc 类型？

```ruby
scope :recent, -> { where("created_at > ?", 2.day.ago) }
```

可以看到这里的 `2.day.ago` 是动态生成的，每一次执行的时候才知道结果。不使用 proc 类型的话，这里立即执行，就和想像中的结果不同了。

> Note: 并不是所有的方法都可以做为 scope 的内容，更多内容 [Active Record Query Interface](http://guides.rubyonrails.org/active_record_querying.html#retrieving-objects-from-the-database)

## scope 可以调用的时候带参数

```ruby
scope :find_lazy, -> (id) { where(:id => id) }

# 带默认值
scope :recent_applies, ->(day=3){ where("created_at > ?", day.days.ago) }
```

注意，使用后不能再进行链式调用。