はじめに

マルチテナントアプリケーションでは、複数の顧客（テナント）が同じアプリケーションを利用するため、データの分離が必要です。

activerecord-multi-tenantは、このようなマルチテナント環境をサポートするための便利なGemです。これにより、テナントごとにデータを分離し、セキュリティとパフォーマンスを向上させることができます。

activerecord-multi-tenantについて

activerecord-multi-tenantは、ActiveRecordにマルチテナンシー機能を追加するためのGemです。このGemを使用すると、モデルにテナントを関連付け、各テナントのデータが他のテナントと混在しないように管理できます。主な特徴は以下の通りです。

テナントのスコープ：テナントごとにデータを自動的にフィルタリング
マルチテナント対応モデル：特定のモデルをマルチテナント対応に設定
シンプルな設定：少ないコード変更でマルチテナンシーを実現

使用方法

インストール

まず、Gemfileにactiverecord-multi-tenantを追加し、bundle installを実行します。

Gemfile

gem 'activerecord-multi-tenant'

テナントモデルの作成

テナントモデルを作成します。ここでは、Tenantモデルを使用します。

% rails generate model Tenant name:string
% rails db:migrate

テナント対応モデルの作成

テナントに関連付けられるモデルを作成します。例えば、Postモデルをテナント対応にします。

% rails generate model Post title:string content:text tenant:references
% rails db:migrate

Postモデルにactiverecord-multi-tenantを設定します。

app/models/post.rb

class Post < ApplicationRecord
  multi_tenant :tenant

  belongs_to :tenant
end

この設定により、Postモデルはtenant_idを持つことが前提となり、テナントごとにデータがスコープされます。

テナントスコープの設定

アプリケーションコントローラーで現在のテナントを設定します。例えば、サブドメインベースのテナント設定を行う場合は以下のように実装します。

app/controllers/application_controller.rb

class ApplicationController < ActionController::Base
  set_current_tenant_through_filter
  before_action :set_tenant

  private

  def set_tenant
    tenant_name = request.subdomain
    @current_tenant = Tenant.find_by!(name: tenant_name)
    set_current_tenant(@current_tenant)
  end
end

set_current_tenantメソッドは、現在のテナントをグローバル変数に設定し、モデルでのデータアクセス時に自動的に適用されます。

データ操作

テナントスコープが設定されると、Postモデルの操作は自動的に現在のテナントにスコープされます。

# 現在のテナントの投稿を作成
Post.create(title: 'New Post', content: 'This is a new post')

# 現在のテナントの投稿を取得
@posts = Post.all

テナントの継承

モデル間での関連付けもテナントスコープを考慮します。例えば、CommentモデルがPostモデルに属する場合、Commentもtenant_idを持ちます。

app/models/comment.rb

class Comment < ApplicationRecord
  multi_tenant :tenant

  belongs_to :post
  belongs_to :tenant
end

app/models/post.rb

class Post < ApplicationRecord
  multi_tenant :tenant

  has_many :comments
  belongs_to :tenant
end

これにより、CommentはPostを通じてテナントスコープを継承し、適切にフィルタリングされます。

マルチテナントデータベースの設定

データベーススキーマは、テナントごとに適切な外部キー制約を持つように設計されます。例えば、postsテーブルにはtenant_idが必要です。

db/migrate/yyyymmddhhmmss_create_posts.rb

class CreatePosts < ActiveRecord::Migration[6.0]
  def change
    create_table :posts do |t|
      t.string :title
      t.text :content
      t.references :tenant, null: false, foreign_key: true

      t.timestamps
    end
  end
end