Rails - 透過計數快取 Counter Cache 提升效能

在許多場合需要統計 has_many 一對多關聯的資料數量，若使用單純的 Rails 關聯查詢，則每次讀取頁面都會重新再統計一次，影響網站效能。

情境

現有 Project model，has many Task model.

# project.rb
class Project < ApplicationRecord
  has_many :tasks
end
# ...

# projects_controller.rb
def index
  @projects = Project.all
end

對應的 view 長這樣：
views/projects/index.html.erb

<% @projects.each do |project| %>
  <tr>
    <td><%= project.name %>(<%= project.tasks.size %>)</td>
  </tr>
<% end %>

讀取頁面時就會出現 N+1 Query 問題，1 個專案若有 3 個任務便會做 3 + 1 次查詢：SELECT “tasks”.* FROM “tasks” WHERE “tasks”.”project_id” = ? ...

N + 1 Query

使用方法

在 projects table 中建立 tasks_count 欄位，將計數存在其中，更新專案的任務數量時，counter cache 會同步更新到對應的欄位裡面。

建立 migration

$ rails g migration add_tasks_count

編輯剛建立的 migration 檔：

在程式碼第一行加入 # frozen_string_literal: true 凍結此檔，可以稍微加快往後的讀取速度。

# frozen_string_literal: true

class AddTasksCount < ActiveRecord::Migration[5.2]
  def change
    add_column :projects, :tasks_count, :integer, default: 0
  end
end

執行 $ rails db:migrate

確認資料表內容：

schema.rb

create_table "projects", force: :cascade do |t|
  t.string "name"
  t.datetime "created_at", null: false
  t.datetime "updated_at", null: false
  t.integer "tasks_count", default: 0
end

create_table "tasks", force: :cascade do |t|
  t.string "name"
  t.integer "project_id"
  t.datetime "created_at", null: false
  t.datetime "updated_at", null: false
  t.index ["project_id"], name: "index_tasks_on_project_id"
end

編輯 Task model

開啟 counter cache 功能:

class Task < ApplicationRecord
  belongs_to :project, counter_cache: true
end

如果想指定其他欄位儲存 counter cache，需要將這裡的 true 改寫為 counter_cache: 'COLUMN_NAME'，例如這邊想要指定 candidate 資料表的 vote 欄位用來記錄得票數:
```
class Vote < ApplicationRecord
  belongs_to :candidate, counter_cache: 'vote'
end
```

建立 rake task 更新 counter cache

更新既有 projects 的 tasks count lib/tasks/update_tasks_count.rb

這邊使用我在五倍紅寶石學到的技巧，將這段 rake task 整理在 namespace: db 底下。

namespace :db do
  desc 'Reset counter cache of tasks count in project.'
  task update_tasks: :environment do
    print '開始更新任務數'
    Project.all.each do |p|
      Project.reset_counters(p.id, :tasks)
      print '.'
    end
    puts '更新完成！'
  end
end