隠された宝石：ActiveRecordストア

この記事で「データベース」と言うときは、Railsコミュニティで最も広く使用されているリレーショナルデータベース、特にPostgreSQLとMySQLを指していることを明確にする必要があります。

JSONをリレーショナルデータベースに保存する理由を尋ねられるかもしれません。実際、リレーショナルデータベースの利点を活用する方法は、データを分割して関係にすることです。 それらの間はデータベース（外部キーなど）によって適用でき、データにインデックスを付けてクエリのパフォーマンスを向上させることができます。

リレーショナルデータベースモデルの欠点の1つは、データ構造を事前に知っておく必要があることです。 テーブルの各行で同じです。アプリケーションがこれらの要件を満たさないデータを中心に構築されている場合は、NoSQLデータベースを調査することをお勧めします。ただし、ほとんどのWebアプリでは、ほとんどのデータについて知っている~~ devil ~~リレーショナルデータベースに固執し、これらの動的データ構造に慎重に「振りかける」必要があります。このような場合、JSON列のようなものが非常に理にかなっています。

JSONとJSONB

PostgreSQLには2種類のJSON列があります：json およびjsonb 。主な違いは、jsonb は書き込み時に解析されます。つまり、データはデータベースがより高速にクエリできる形式で保存されます。注意点は、JSONはすでに解析されているため、テキストとして出力すると、ユーザーが入力した内容と正確に一致しなくなる可能性があることです。たとえば、重複するキーが削除されたり、キーの順序が元のキーと一致しなかったりする可能性があります。

PostgreSQLのドキュメントには、ほとんどの場合、jsonbと記載されています 特に理由がない限り、これが必要です。

MySQLのjson 列はjsonbと同様に動作します PostgreSQLで。 「ユーザーが入力した内容だけ」の出力をサポートするには、おそらくvarcharを使用する必要があります。 列または類似のもの。

JSON vs. Text

データを事前に解析できるようにすることに加えて、テキストフィールドに同じデータを格納する代わりにJSON列を使用すると、データ自体を使用するクエリが可能になります。たとえば、特定のキーと値のペアが列に存在するすべてのレコードをクエリできます。 Rails自体は、データベース固有であるため、多くの（存在する場合）JSON固有のクエリをサポートしていないことに注意してください。したがって、これらの機能を活用する場合は、SQLクエリを使用する必要があります。

RailsのJSON列

Railsはjsonの作成をサポートしています （およびjsonb PostgreSQLの場合）移行の列：

class CreateItems < ActiveRecord::Migration[7.0]
  def change
    create_table :items do |t|
      t.jsonb :user_attributes

    ...
    end
  end
end

この列を読むと、返される結果はハッシュです：

> Item.first.user_attributes
  Item Load (0.6ms)  SELECT "items".* FROM "items" ORDER BY "items"."id" ASC LIMIT $1  [["LIMIT", 1]]
=> {"color"=>"text-red-400"}
> Item.first.update!(user_attributes: {color: "text-blue-400"})
> Item.first.user_attributes.dig(:color)
=> "text-blue-400"

ハッシュ属性ができたので、値を読み書きするためにいくつかのヘルパーメソッドをモデルに追加したくなるかもしれません：

class Item < ApplicationRecord
  def color=(value)
    self.user_attributes["color"] = value
  end

  def color
    user_attributes.dig("color")
  end
end

このようなメソッドは完全に機能しますが、処理するJSONキーがたくさんあると、すぐに扱いにくくなる可能性があります。幸い、Railsは私たちをカバーしてくれました。

ActiveRecordのストアとstore_accessor

JSONをデータベースに保存するには、シリアル化とアクセスの2つの側面があります。 jsonを使用している場合 -データベースに列を入力すると、シリアル化の側面について心配する必要はありません。 Railsとデータベースアダプタがそれを処理します（store_accessorに直接スキップできます ）。データをテキスト列に保存する場合は、ActiveRecordのstore メソッドはあなたにぴったりです。これにより、列に書き込むデータが選択した形式にシリアル化されます。

ActiveRecordのストア

ActiveRecordにはstoreがあります 読み取りまたは列に書き込むデータを自動的にシリアル化する方法：

class Item < ApplicationRecord
  store :user_attributes, accessors: [:color], coder: JSON
end

ここでは、:user_attributes は使用する列ですが、accessors アクセスしたいキーのリストです（colorのみ） ここでは）、最後に、データのエンコード方法を指定します。 JSONを使用していますが、YAMLやカスタムエンコーディングなど、ここでは好きなものを使用できます。このメソッドは、（選択したコーダーを使用して）シリアル化を処理し、store_accessorを呼び出します。 ボンネットの下。

ActiveRecordのstore_accessor

store_accessorを使用して、モデルにget/setメソッドを作成します。 ：

class Item < ApplicationRecord
  store_accessor :user_attributes, :color
  store_accessor :user_attributes, :name, prefix: true
  store_accessor :user_attributes, :location, prefix: 'primary'
end

ここでも、user_attributes は使用するデータベース列であり、その後にJSONデータで使用するキーが続きます。最後に、プレフィックス（またはサフィックス）を使用するオプションがあります。 store_accessorに注意してください ネストされたデータはサポートせず、最上位のキーと値のペアのみをサポートします。 prefix およびsuffix オプションは、ブール値、文字列、または記号のいずれかを取ります。ブール値のtrueの場合 が渡されると、列の名前がプレフィックス/サフィックスとして使用されます。

=>item = Item.create!(color: 'red', user_attributes_name: 'Jonathan', primary_location: 'New Zealand')
>#<Item:0x000055d63f4f0360
 id: 4,
 user_attributes: {"color"=>"red", "name"=>"Jonathan", "location"=>"New Zealand"}>
=>item.color
>"red"
=> item.user_attributes_name
>"Jonathan"
=> item.name
>NoMethodError: undefined method `name'...
=> item.primary_location
>"New Zealand"