Railsにおけるエンティティ識別：複合主キー vs ユニークオブジェクトIDフィールド

2024-04-06

Railsにおける複合主キーとユニークオブジェクトIDフィールド

Railsでエンティティを表すモデルを作成する際、主キーとして単一のフィールドを使用するケースが一般的です。しかし、特定の状況では、複数のフィールドを組み合わせた複合主キーの方が適切な場合があります。

本記事では、複合主キーとユニークオブジェクトIDフィールドの概念を解説し、それぞれの特徴と使い分けについて説明します。さらに、複合主キーを使用する際の注意点と、関連するデザインパターンについても紹介します。

複合主キーとは、複数のフィールドを組み合わせた主キーです。単一のフィールドよりも、より詳細なエンティティの識別に役立ちます。

例

ユーザーモデル：user_idとemailの組み合わせ
商品モデル：product_idとcolor_idの組み合わせ

ユニークオブジェクトIDフィールドは、エンティティを一意に識別するためのフィールドです。主キーとして使用することもできますが、単一のフィールドで構成されるため、複合主キーよりも汎用性が高いのが特徴です。

uuidフィールド
sequenceフィールド

複合主キーとユニークオブジェクトIDフィールドの使い分け

複合主キーを使用するべきケース

エンティティをより詳細に識別する必要がある場合
複数のフィールドの組み合わせでエンティティが唯一に決定される場合

ユニークオブジェクトIDフィールドを使用するべきケース

エンティティをシンプルに識別したい場合
主キーに特定の意味を持たせたくない場合

複合主キーは、データベースのインデックスに登録する必要がある
複合主キーは、変更が難しい
複合主キーは、パフォーマンスに影響を与える可能性がある

関連するデザインパターン

Composite Key Pattern：複合主キーを実装するためのデザインパターン
Identity Field Pattern：ユニークオブジェクトIDフィールドを実装するためのデザインパターン

まとめ

複合主キーとユニークオブジェクトIDフィールドは、それぞれ異なる役割を持つため、状況に応じて使い分けることが重要です。

補足

上記は概要であり、詳細については各資料を参照してください。
具体的な実装方法は、使用しているフレームワークやデータベースによって異なります。

class User < ApplicationRecord
  self.primary_key = :user_id, :email

  # ...
end

上記コードでは、Userモデルの主キーとしてuser_idとemailの組み合わせを使用しています。

class Product < ApplicationRecord
  # ...

  def generate_unique_id
    loop do
      self.unique_id = SecureRandom.uuid
      break unless Product.exists?(unique_id: unique_id)
    end
  end

  before_create :generate_unique_id
end

上記コードでは、Productモデルにunique_idというユニークオブジェクトIDフィールドを追加しています。

注文モデル：order_id
メッセージモデル：message_id

上記はあくまで例であり、実際のコードは状況に合わせて変更する必要があります。
複合主キーを使用する場合は、データベースのインデックス設定に注意が必要です。

複合主キーとユニークオブジェクトIDフィールドの代替案

サロゲートキーは、複合主キーやユニークオブジェクトIDフィールドの代替案として使用できます。

class User < ApplicationRecord
  # ...

  has_primary_key :user_id
end

上記コードでは、Userモデルにuser_idというサロゲートキーを追加しています。

自然キーとは、エンティティの属性からなる主キーです。複合主キーはこの自然キーの一種とみなすこともできます。

自然キーは、人間にとって分かりやすいというメリットがあります。

class Product < ApplicationRecord
  self.primary_key = :product_code

  # ...
end

上記コードでは、Productモデルの主キーとしてproduct_codeという自然キーを使用しています。

エンティティIDとは、外部システムで使用されるエンティティの識別子です。

エンティティIDは、異なるシステム間でエンティティを連携させる際に役立ちます。

class User < ApplicationRecord
  # ...

  has_column :external_id, :string

  def to_external_id
    external_id || generate_external_id
  end

  private

  def generate_external_id
    loop do
      self.external_id = SecureRandom.uuid
      break unless User.exists?(external_id: external_id)
    end
  end
end