edge
詳細はrubyonrails.orgで: もっとRuby on Rails

Active Recordの基礎

このガイドはActive Recordの紹介です。

このガイドを読み終えると、以下のことがわかります：

1 Active Recordとは何ですか？

Active RecordはMVCのMであり、ビジネスデータとロジックを表すシステムのレイヤーであるモデルです。Active Recordは、永続的なストレージをデータに必要とするビジネスオブジェクトの作成と使用を容易にします。これは、Active Recordパターンの実装であり、それ自体がオブジェクトリレーショナルマッピングシステムの説明です。

1.1 Active Recordパターン

Active Recordは、Martin Fowlerの書籍「Patterns of Enterprise Application Architecture」で説明されています。Active Recordでは、オブジェクトは永続的なデータとそのデータに対して動作する振る舞いを持っています。Active Recordは、データアクセスロジックをオブジェクトの一部として確保することで、そのオブジェクトのユーザーにデータベースへの書き込みと読み取りの方法を教育するという意見を持っています。

1.2 オブジェクトリレーショナルマッピング

オブジェクトリレーショナルマッピング（ORMとしても知られています）は、アプリケーションの豊かなオブジェクトをリレーショナルデータベース管理システムのテーブルに接続する技術です。ORMを使用すると、アプリケーションのオブジェクトのプロパティや関係をSQL文を直接書かずに簡単にデータベースに保存および取得することができます。

注意：リレーショナルデータベース管理システム（RDBMS）と構造化クエリ言語（SQL）の基本知識は、Active Recordを完全に理解するために役立ちます。詳細については、このチュートリアル（またはこのチュートリアル）を参照するか、他の手段で学習してください。

1.3 ORMフレームワークとしてのActive Record

Active Recordには、次のようないくつかのメカニズムがありますが、最も重要なのは次の能力です：

  • モデルとそのデータを表現すること。
  • これらのモデル間の関連を表現すること。
  • 関連するモデルを介した継承階層を表現すること。
  • データベースに永続化される前にモデルを検証すること。
  • オブジェクト指向のスタイルでデータベース操作を実行すること。

2 Active Recordにおける設定の規約

他のプログラミング言語やフレームワークを使用してアプリケーションを作成する場合、多くの設定コードを記述する必要がある場合があります。これは、一般的にORMフレームワークに当てはまります。ただし、Railsが採用している規約に従う場合、Active Recordモデルを作成する際には非常に少ない設定（場合によってはまったく設定不要）しか必要ありません。アイデアは、ほとんどの場合にアプリケーションを同じように設定する場合は、これがデフォルトの方法であるべきだということです。したがって、標準の規約に従えない場合にのみ、明示的な設定が必要になります。

2.1 命名規則

デフォルトでは、Active Recordはいくつかの命名規則を使用して、モデルとデータベーステーブルのマッピング方法を判断します。Railsはクラス名を複数形にして対応するデータベーステーブルを見つけます。したがって、クラスBookにはデータベーステーブルがbooksという名前である必要があります。Railsの複数形化の仕組みは非常に強力であり、通常の単語と非規則的な単語の両方を複数形にすることができます。2つ以上の単語で構成されるクラス名を使用する場合、モデルクラス名はRubyの規則に従い、CamelCase形式を使用する必要がありますが、テーブル名はsnake_case形式を使用する必要があります。例：

  • モデルクラス - 各単語の最初の文字を大文字にした単数形（例：BookClub）。
  • データベーステーブル - 単語をアンダースコアで区切った複数形（例：book_clubs）。
モデル / クラス テーブル / スキーマ
Article articles
LineItem line_items
Deer deers
Mouse mice
Person people

2.2 スキーマの規約

Active Recordは、データベーステーブルの列に対して命名規則を使用します。これらの列の目的に応じて異なる命名規則があります。

  • 外部キー - これらのフィールドは、singularized_table_name_id（例：item_id、order_id）というパターンに従って名前を付ける必要があります。これらは、モデル間の関連を作成する際にActive Recordが探すフィールドです。

  • 主キー - デフォルトでは、Active Recordはidという名前の整数列をテーブルの主キーとして使用します（PostgreSQLとMySQLではbigint、SQLiteではinteger）。Active Record Migrationsを使用してテーブルを作成する場合、この列は自動的に作成されます。 Active Recordのインスタンスに追加の機能を追加するいくつかのオプションの列名もあります。

  • created_at - レコードが最初に作成されたときに現在の日付と時刻に自動的に設定されます。

  • updated_at - レコードが作成または更新されるたびに現在の日付と時刻に自動的に設定されます。

  • lock_version - モデルに楽観的ロックを追加します。

  • type - モデルが単一テーブル継承を使用することを指定します。

  • (association_name)_type - 多態性関連のタイプを格納します。

  • (table_name)_count - 関連するオブジェクトの数をキャッシュするために使用されます。たとえば、Commentのインスタンスを多数持つArticleクラスのcomments_count列は、各記事の存在するコメントの数をキャッシュします。

注意: これらの列名はオプションですが、実際にはActive Recordによって予約されています。余分な機能を必要としない限り、予約されたキーワードを避けてください。たとえば、typeは単一テーブル継承（STI）を使用してテーブルを指定するための予約キーワードです。STIを使用していない場合は、データモデリングを正確に説明する類似のキーワード（例：「context」）を試してみてください。

3 Active Recordモデルの作成

アプリケーションを生成すると、app/models/application_record.rbに抽象的なApplicationRecordクラスが作成されます。これはアプリ内のすべてのモデルの基本クラスであり、通常のRubyクラスをActive Recordモデルに変換します。

Active Recordモデルを作成するには、ApplicationRecordクラスをサブクラス化してください。

class Product < ApplicationRecord
end

これにより、Productモデルが作成され、データベースのproductsテーブルにマッピングされます。これにより、そのテーブルの各行の列をモデルのインスタンスの属性とマッピングすることもできます。たとえば、productsテーブルが次のようなSQL（またはその拡張）ステートメントを使用して作成されたとします。

CREATE TABLE products (
  id int(11) NOT NULL auto_increment,
  name varchar(255),
  PRIMARY KEY  (id)
);

上記のスキーマは、idとnameの2つの列を持つテーブルを宣言しています。このテーブルの各行は、これらの2つのパラメータを持つ特定の製品を表します。したがって、次のようなコードを書くことができます。

p = Product.new
p.name = "Some Book"
puts p.name # "Some Book"

4 命名規則のオーバーライド

異なる命名規則に従う必要がある場合や、Railsアプリケーションをレガシーデータベースで使用する必要がある場合はどうすればよいでしょうか？問題ありません、デフォルトの規則を簡単にオーバーライドできます。

ApplicationRecordはActiveRecord::Baseを継承しているため、アプリケーションのモデルには多くの便利なメソッドが利用できます。たとえば、ActiveRecord::Base.table_name=メソッドを使用して使用するテーブル名をカスタマイズできます。

class Product < ApplicationRecord
  self.table_name = "my_products"
end

これを行う場合、テスト定義でset_fixture_classメソッドを使用してフィクスチャ（my_products.yml）をホストするクラス名を手動で定義する必要があります。

# test/models/product_test.rb
class ProductTest < ActiveSupport::TestCase
  set_fixture_class my_products: Product
  fixtures :my_products
  # ...
end

また、ActiveRecord::Base.primary_key=メソッドを使用してテーブルの主キーとして使用する列をオーバーライドすることもできます。

class Product < ApplicationRecord
  self.primary_key = "product_id"
end

注意: Active Recordは、主キー以外の列にidという名前を使用することはサポートしていません。

注意: 主キーではないidという名前の列を作成しようとすると、Railsは次のようなマイグレーション中にエラーをスローします。 you can't redefine the primary key column 'id' on 'my_products'. To define a custom primary key, pass { id: false } to create_table.

5 CRUD: データの読み書き

CRUDは、データを操作するために使用する4つの動詞の頭文字です: Create（作成）、Read（読み取り）、Update（更新）、Delete（削除）。Active Recordは、テーブル内に格納されたデータを読み取り、操作するためのメソッドを自動的に作成します。

5.1 Create（作成）

Active Recordオブジェクトは、ハッシュ、ブロック、または作成後に属性を手動で設定することによって作成できます。newメソッドは新しいオブジェクトを返し、createはオブジェクトを作成してデータベースに保存します。

たとえば、属性nameとoccupationを持つUserモデルがある場合、createメソッド呼び出しは新しいレコードをデータベースに作成して保存します。

user = User.create(name: "David", occupation: "Code Artist")

newメソッドを使用すると、オブジェクトを保存せずにインスタンス化することができます。

user = User.new
user.name = "David"
user.occupation = "Code Artist"

user.saveを呼び出すと、レコードがデータベースにコミットされます。

最後に、ブロックが提供された場合、createとnewの両方が新しいオブジェクトをそのブロックに初期化するために使用されますが、createのみが結果のオブジェクトをデータベースに永続化します。

user = User.new do |u|
  u.name = "David"
  u.occupation = "Code Artist"
end

5.2 Read

Active Recordは、データベース内のデータにアクセスするための豊富なAPIを提供します。以下は、Active Recordが提供するさまざまなデータアクセスメソッドの例です。

# すべてのユーザーのコレクションを返す
users = User.all

# 最初のユーザーを返す
user = User.first

# 名前がDavidの最初のユーザーを返す
david = User.find_by(name: 'David')

# 名前がDavidで職業がCode Artistのユーザーをすべて検索し、created_atで逆の時系列順に並べ替える
users = User.where(name: 'David', occupation: 'Code Artist').order(created_at: :desc)

Active Recordモデルのクエリについて詳しくは、Active Record Query Interfaceガイドを参照してください。

5.3 Update

Active Recordオブジェクトを取得した後、その属性を変更してデータベースに保存することができます。

user = User.find_by(name: 'David')
user.name = 'Dave'
user.save

属性を一度に複数更新する場合は、属性名を所望の値にマッピングするハッシュを使用すると便利です。

user = User.find_by(name: 'David')
user.update(name: 'Dave')

これは、複数の属性を更新する場合に最も便利です。

コールバックやバリデーションを行わずに複数のレコードを一括で更新する場合は、update_allを使用してデータベースを直接更新できます。

User.update_all max_login_attempts: 3, must_change_password: true

5.4 Delete

同様に、取得したActive Recordオブジェクトは破棄することができ、それによりデータベースから削除されます。

user = User.find_by(name: 'David')
user.destroy

複数のレコードを一括で削除する場合は、destroy_byまたはdestroy_allメソッドを使用できます。

# 名前がDavidのすべてのユーザーを検索して削除する
User.destroy_by(name: 'David')

# すべてのユーザーを削除する
User.destroy_all

6 バリデーション

Active Recordを使用すると、データベースに書き込む前にモデルの状態を検証することができます。モデルをチェックし、属性の値が空でないこと、一意であり、すでにデータベースに存在しないこと、特定の形式に従っていることなどを検証するために使用できるいくつかのメソッドがあります。

save、create、updateなどのメソッドは、モデルをデータベースに永続化する前に検証を行います。モデルが無効な場合、これらのメソッドはfalseを返し、データベース操作は実行されません。これらのメソッドには、バリデーションが失敗した場合にActiveRecord::RecordInvalid例外を発生させるより厳しいバージョン（save!、create!、update!）もあります。以下は簡単な例です。

class User < ApplicationRecord
  validates :name, presence: true
end

irb> user = User.new
irb> user.save
=> false
irb> user.save!
ActiveRecord::RecordInvalid: Validation failed: Name can’t be blank

バリデーションについて詳しくは、Active Record Validations guideを参照してください。

7 コールバック

Active Recordコールバックを使用すると、モデルのライフサイクルの特定のイベントにコードを関連付けることができます。これにより、新しいレコードを作成、更新、削除するときなど、これらのイベントが発生したときにコードを実行してモデルに動作を追加することができます。

class User < ApplicationRecord
  after_create :log_new_user

  private
    def log_new_user
      puts "A new user was registered"
    end
end

irb> @user = User.create
A new user was registered

コールバックについて詳しくは、Active Record Callbacks guideを参照してください。

8 マイグレーション

Railsは、マイグレーションを介してデータベーススキーマの変更を管理する便利な方法を提供します。マイグレーションは、ドメイン固有の言語で記述され、Active Recordがサポートするデータベースに対して実行されるファイルに保存されます。

以下は、publicationsという新しいテーブルを作成するマイグレーションの例です。

class CreatePublications < ActiveRecord::Migration[7.1]
  def change
    create_table :publications do |t|
      t.string :title
      t.text :description
      t.references :publication_type
      t.references :publisher, polymorphic: true
      t.boolean :single_issue

      t.timestamps
    end
  end
end

上記のコードはデータベースに依存しないため、MySQL、PostgreSQL、SQLiteなどで実行されます。

Railsは、どのマイグレーションがデータベースにコミットされたかを追跡し、同じデータベース内の隣接するテーブルでそれらを保存します。テーブルの名前はschema_migrationsです。 マイグレーションを実行してテーブルを作成するには、bin/rails db:migrateを実行します。テーブルをロールバックして削除するには、bin/rails db:rollbackを実行します。

マイグレーションについては、Active Recordマイグレーションガイドで詳細を学ぶことができます。

9 関連付け

Active Recordの関連付けを使用すると、モデル間の関係を定義することができます。関連付けは、一対一、一対多、多対多の関係を記述するために使用できます。たとえば、「Authorは多くのBooksを持つ」という関係は、次のように定義できます。

class Author < ApplicationRecord
  has_many :books
end

Authorクラスには、著者に本を追加したり削除したりするためのメソッドなどが追加されます。

関連付けについては、Active Record関連付けガイドで詳細を学ぶことができます。

フィードバック

このガイドの品質向上にご協力ください。

タイポや事実の誤りを見つけた場合は、ぜひ貢献してください。 開始するには、ドキュメントへの貢献セクションを読んでください。

不完全なコンテンツや最新でない情報も見つかるかもしれません。 メインのドキュメントに不足しているドキュメントを追加してください。 修正済みかどうかは、まずEdge Guidesを確認してください。 スタイルと規約については、Ruby on Rails Guides Guidelinesを確認してください。

修正すべき点を見つけたが、自分で修正できない場合は、 問題を報告してください。

そして最後に、Ruby on Railsのドキュメントに関するあらゆる議論は、公式のRuby on Railsフォーラムで大歓迎です。