更新日: 2014年5月8日
Rails

Rails4でserializeしてデータをDBに保存させる

Rails で配列やハッシュなどコレクション的なデータを、データベースにシリアライズして保存しておく方法。find で読み出すと元のオブジェクトの形式で読み出してくれるので超便利です。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

— 環境 —
rails 4.0.1

マイグレーション

マイグレーションファイルでは、serialize して保存するフィールドのデータ型に text を指定しておきます。tags をシリアライズ。

db/migrate/***_create_post.rb

class CreatePost < ActiveRecord::Migration
  def change
    create_table :post do |t|
      t.string :content
      t.text :tags # => array of tag

      t.timestamps
    end
  end
end

class CreatePost < ActiveRecord::Migration

def change

create_table :post do |t|

t.string :content

t.text :tags # => array of tag

t.timestamps

end

モデルで serialize する属性を指定

モデルで ActiveRecord の serialize メソッドに対象の属性を指定するだけ。ここでは、tags をシリアライズする。

app/models/post.rb

class Post < ActiveRecord::Base
  serialize :tags
end

class Post < ActiveRecord::Base

serialize :tags

end

あとは普通に create や save で保存でき、find などで取得すると元のオブジェクトの形で取得できます。以下 pry で試しました。


pry(main)> post = Post.new
pry(main)> post.content = "パソコン買った"
pry(main)> post.tags = ["diary", "pc"]
pry(main)> post.save
pry(main)> Post.find(1).tags
["diary", "pc"]

pry(main)> post = Post.new

pry(main)> post.content = "パソコン買った"

pry(main)> post.tags = ["diary", "pc"]

pry(main)> post.save

pry(main)> Post.find(1).tags

["diary", "pc"]

直接 MySQL を覗くと分かりますが、シリアライズされたデータは DB には yaml 形式の文字列で保存されています。ActiveRecord のメソッド find などで取得すると元のオブジェクトの形式で取得できます。素晴らしい。

ArgumentError: undefined class/module への対処

独自に定義したクラスのインスタンスを含む配列やハッシュなどを serialize して保存した場合、find の際に以下のようにクラス名/モジュール名を見つけられないエラーが出る時がありました。


ArgumentError: undefined class/module

ArgumentError: undefined class/module

少々これではまりましたが、これは DB から deserialize する際に、Rails の autoload の機能が呼ばれないためらしい…。あまり自信ないですが、英語圏ブログでそのような情報がいくつか見つけた。

なので、deserialize に必要なクラスが定義されているファイルを、事前に明示的に require しておくと無事に deserialize できます。


pry(main)> SomeModel.find(1).some_attributes
ArgumentError: undefined class/module ****
pry(main)> require "some_attributes_file"
=> true
pry(main)> SomeModel.find(1).some_attributes
=> [#<SomeAttribute:0x007f86e1e7a350
  ...,
  ...>]

pry(main)> SomeModel.find(1).some_attributes

ArgumentError: undefined class/module ****

pry(main)> require "some_attributes_file"

=> true

pry(main)> SomeModel.find(1).some_attributes

=> [#<SomeAttribute:0x007f86e1e7a350

...,

...>]

serialize 便利です。

パーフェクト Ruby on Rails は、最近読んだ Rails 本の中では一番役に立った本です。Chef や Capistrano など Rails と共によく使用される技術にも触れてあります。Ruby on Rails 4 アプリケーションプログラミングは、入門的な内容で Rails の機能全体を網羅されています。

パーフェクト Ruby on Rails

Ruby on Rails 4 アプリケーションプログラミング