【Rails】Active Record(モデル)の書き方《バリデーション篇》

2021年4月16日 13:14

はじめに

ActiveRecord(モデル)のバリデーション設定を行うことで、実際にデータが保存される前に不適合データを弾くことができます。ほとんどのデータベースはカラムに制約を設定することができますが、Railsアプリのモデルでバリデーションを行えば、Railsアプリとデータベース間の無駄なやり取りを減らすことができます。また、テストやメンテナンスのしやすさもメリットのひとつです。

本記事では、ActiveRecord(モデル)のバリデーションについてまとめています。

バリデーションの使い方

バリデーションの動作

バリデーションはコントローラーでデータを保存、作成、更新しようとしたときに実行されます。バリデーションチェックの結果が不適合だった場合、saveupdatefalseを返し、createはインスタンスの中身をそのまま返します。また、末尾に!(エクスクラメーションマーク)が付いているメソッドはActiveRecord::RecordInvalid例外が発生します。

メソッド 説明
save/save! newで作成したインスタンス、値を更新したインスタンスを保存する。
create/create! モデルのインスタンスを作成し保存する。
update/update! モデルのインスタンスを更新し保存する。

バリデーションチェックの結果が不適合だった場合、インスタンスのerrorsハッシュにエラー内容が格納されます。

# ユーザーモデル
validates :name, presence: true
validates :age, presence: true

# ユーザーコントローラー
user = User.new(name: 'Jane')
user.save
user.errors.messages
# => {:age=>["can't be blank"]}

エラー内容をビューに表示する時はerrors.full_messagesを使います。フォームのエラー表示については以下の記事を参照してください。

バリデーションの種類

モデルにはたくさんのバリデーションが用意されています。ここでは、よく使うであろうバリデーションのみを紹介します。

presence

presenceは指定された属性に値が入力されているかを確認します。入力された値がnil、空欄、ホワイトスペース("")の場合、不適合となります。

validates :name, presence: true

length

lengthは指定した長さと合致しているかを確認します。指定した長さに合致しなければ不適合となります。

validates :name, length: { minimum: 1 }
validates :content, length: { maximum: 300 }
validates :password, length: { in: 8..32 }
validates :cell_phone_number, length: { is: 11 }

format

formatwithオプションで指定した正規表現に合致しているかを確認します。入力された値が正規表現に合致しなければ不適合となります。

validates :content, format: { with: /[ぁ-んァ-ヶ一-龥]+?/ }

正規表現の内容が「数字のみ」の場合、numericalityを使うこともできます。デフォルトでは整数または浮動小数点の数字を許可します。整数のみを許可したい場合はonly_integerを有効にします。

validates :age, numericality: { only_integer: true }

# 以下と同じバリデーション
# validates :age, format: { with: /\A[+-]?\d+\z/ }

confirmation

confirmationは2つのテキストフィールドが完全に一致しているかを確認します。メールアドレスやパスワードの確認などで2つが一致していなければ不適合となります。このバリデーションを指定した属性に_confirmationを付け足した確認用の属性が自動で作成されます。

確認用の属性がnilの場合はこのバリデーションが行われないため、確認用の属性には必ずpresenceを指定しておきます。

validates :password, confirmation: true
validates :password_confirmation, presence: true

acceptance

acceptanceはフォームのチェックボックスがオンかを確認します。「利用規約に同意する」などのチェックボックスがオンになっていなければ不適合となります。このバリデーションを指定する属性は画面上でしか使われないため(データベースに保存する必要がないため)、テーブルに対応するカラムが存在する必要はありません。

validates :accept, acceptance: true

独自のエラーメッセージ

バリデーションチェックの結果が不適合だった場合にerrorsハッシュに格納される独自のエラーメッセージを定義できます。

validates :content, presence: true, format: { with: /[ぁ-んァ-ヶ一-龥]+?/, \
                    message: 'には日本語を含めてください Content must contain Japanese.' }

まとめ

最近のモダンブラウザはフォームに入力した値が送信される前に簡単なフォーマットチェック(メールアドレスなど)を行ってくれます。ですが、やはりそれだけでは不十分なことも多いので、Railsアプリでバリデーションを設定しておく必要があります。

本記事を参考にして、ActiveRecord(モデル)のバリデーションについて覚えていただければと思います。

関連記事

【Rails】Webサーバー「Unicorn」の基本情報と実装方法
# はじめに Railsアプリを本番環境で稼働させるには、クライアントからのリクエストを捌くWebサーバーを導入する必要があります。WebサーバーはクライアントからのリクエストをRailsアプリに伝達し、Railsアプリで処理されたレスポンスをク [...]
2021年4月15日 12:17
【Rails】デプロイツール「Capistrano」の基本情報と実装方法
# はじめに アプリを本番環境にアップロードして誰でもアクセスできる状態にすることをデプロイと言います。デプロイで行うべきことは多岐にわたります。Railsアプリの場合で言えば、本番環境にアップロードすることはもちろんですが、Gemのインストール [...]
2021年4月14日 9:56
【Rails】Webpackerの基本情報と実装方法
# はじめに Rails 6からWebpackerが正式採用されました。Rails 5ではオプションで追加することができたWebpackerですが、Rails 6からは普通にアプリを作成するだけでWebpackerがインストールされ、必要な設定も [...]
2021年4月12日 14:36
【Rails】アセットパイプライン(Sprockets)の基本情報と実装方法
# はじめに Ruby on Railsにはアセットパイプラインという機能があります。アセットパイプラインは画像、CSS、JavaScriptといったアセットファイルを連結/圧縮することでRailsアプリを高速化します。また、より高級な言語で書か [...]
2021年4月11日 14:08
【Rails】Turbolinksの基本情報と実装方法
# はじめに Ruby on Railsにはページの遷移を高速化するTurbolinksという機能があります。Turbolinksは優れたJavaScriptライブラリですが、Rails 5からは標準で有効化されているため、Turbolinksを [...]
2021年4月10日 17:59