はじめに
備忘録
目的
データベースに不正なデータが保存されないようにすること。
手段
1.データベースカラムに対して制御を記述する。
2.モデルに対して検証を記述する。
両者の違い
データベースカラムに対する制御
➡︎一意性の検証
➡︎ユーザーへエラーメッセージを届けられない
➡︎モデルでは弾けないような、直接データベースに他のシステムから操作を加える作業に対しての制御
モデルに対する検証
➡︎データベースでは制御しきれない部分の補完
➡︎ユーザーへエラーメッセージを届ける事ができる
※今回は、制御に関する機能の説明のみです。
1.データベースカラムへの制御でよく行われる方法4つ
※データベースカラムへの制御はマイグレーションファイルに記述していくこと。
1.データ型を付与する。
➡︎データ型を付与する事で、そのデータ型以外のデータが格納されることを阻止する。
→例えば、「名前カラムには文字列しか格納させたくない」場合には、名前カラムに文字列のデータ型を付与すると良い。
2.NOT NULL制約を付与する。
➡︎カラムに対して、必ず何かしらの値が格納されるようにしたい場合に空の値が格納されることを阻止する。
→例えば、ユーザーが新規登録する際に「名前が空のまま保存されることを阻止したい」場合には、この制約を追加すると良い。
3.文字列の長さを制御する。
➡︎カラムに対して、文字列の長さを指定することで指定した文字列以上の長さのデータが格納されることを阻止する。
→例えば、ユーザーが新規登録する際に「名前が20文字以上になることを阻止したい」場合には、文字列の長さを制御してあげると良い。
4.ユニークインデックスを付与する。
➡︎カラムに対して、ユニークインデックスを付与する事でそのデータの一意性が確保され、同じデータが格納されることを阻止する。
→例えば、ユーザーが新規登録する際に「メールアドレスが他のユーザーと被ることを阻止したい」場合には、メールアドレスカラムに対してユニークインデックスを付与してあげると良い。
コマンドを実行してモデルのクラスファイル(マイグレーションファイル)を作成 $ rails g model Userdb/migrate/[timestamps]_create_users.rbclass CreateUsers < ActiveRecord::Migration[5.2] def change create_table :users do |t| t.string :name, limit: 20, null: false t.string :email, null: false t.timestamps t.index :email, unique: true end end endマイグレーションファイルに変更を加えたらデータベースに変更を保存する $ rails db:migrate
t.string :name
➡︎データ型の付与
limit: 20
➡︎文字列の長さを制御
null: false
➡︎NOT NULL制約(SQLのnullとRubyのnilを混同させないこと)
t.index :email, unique: true
➡︎ユニークインデックス付与で一意性確保
2.モデルに対する検証方法は主に2つ
※モデルに対する検証はモデルファイルに記述していくこと。
※モデルに対する検証の仕組みは「検証結果が不正だった場合は、エラーメッセージを生成する」であることに注意。なので、例えばユーザーに新規登録をさせる場合は「検証で失敗した結果、何が原因で登録できなかったのかをユーザーに知らせる」事が目的。
1.Railsであらかじめ用意されている、検証用のヘルパーメソッドを使う。
➡︎モデルに対して、validatesオプションを使って検証したいヘルパーメソッドを適用させることで、メソッドの内容に準じて検証を行う事ができる。
→例えば、ユーザーが新規登録する際に「名前未入力による登録する事を阻止したい」場合には、validatesオプションに対してそれ用のヘルパーメソッドを適用させる。
→その他にもたくさんの検証ヘルパーが用意されている。
2.検証用のメソッドを自分で定義しちゃう。
➡︎モデルに対して、「どんな検証を行いたいか」「どんなエラーメッセージを表示させたいか」を考えてメソッドを定義していく。
→例えば、ユーザーが新規登録する際「名前にハイフンを入れる事を阻止したい」ときには「名前にハイフンを含ませた場合、"名前にハイフンを入れることはできません"というエラーメッセージを生成する」といったメソッドを定義すれば良い。
➡︎メソッドを定義したら、validate(単数形であることに注意)オプションに適用させる。
app/models/user.rbclass User < ApplicationRecors validates :name, presence: true validate :validate_name_not_include_hyphen def validate_name_not_include_hyphen errors.add(:name, 'にハイフンを入れる事はできません') if name&.include?('-') end end
validates :name, presence: true
➡︎Userモデルのname属性の値が入力されていることをチェックする。
validate_name_not_include_hyphen
➡︎メソッド名。
errors.add(:name, 'にハイフンを入れることはできません') if name&.include?('-')
➡︎名前にハイフンが含まれていた場合、「(名前)にハイフンを入れることはできません」というエラーメッセージを生成する。
➡︎nameに「&」を付けているのは、名前がnilだった場合に例外を発生させないため。nilだった場合はnilを代入させることができる。そうすることでvalidatesオプションのpresence: trueで検証させる。
※エラーメッセージを表示させるまでがゴール
エラーメッセージを生成・表示させるには(ユーザー新規登録を例にする)
1：新規登録ならユーザーコントローラのcreateアクション内で、送信されてきたデータからオブジェクトを@user.saveメソッドで保存・更新する作業を行ってあげる。
➡︎ビューで再利用するためにインスタンス変数でオブジェクトを定義してあげること。
2：不正なデータが送信された場合は、saveメソッドの効果により検証が実行され保存されずにfalseを返し、errorsという配列に保存に失敗したオブジェクトが格納される。
➡︎saveメソッドやupdate_attributesメソッドなど保存・更新時に検証を行ってくれるメソッドを適用させないと、検証を実行してくれないので注意。
➡︎例えば、ユーザーが名前を空のまま保存したとしたら@user.errorsの配列には「@messages ={:name=>["を入力してください"]}」という旨のエラーメッセージが格納される。
3：@user.errors.full_messagesと記述することで、errors配列に格納されているエラーメッセージを取得できる。
➡︎名前を入力してください
4：取得した上記のエラーメッセージをビューで表示することで、ユーザーにエラーメッセージを届ける事ができるようになる。
以上の手順を踏む必要がある。