paramsで値を取得する際にrequireを必ずしも使わなくもいいものなのでしょうか？

Question

すみません。
簡潔にしたかったのですが、うまく短くできませんでした。

jsonで次をリクエストします。

{
	"hoge_id": "fuga"
}

puts params
paramsの中身はこちらです。
結果 #{"hoge_id => "fuga", "controller => users", "action" => "piyo", "user => {}"


puts prams.require(:user).permit(:hoge_id)
こんな感じで、requireメソッドを使いキーでしぼって、permitメソッドに渡したいのですが、エラーになります。
:userではなく、ほかの値を入れてもエラーになります。
結果 #<Action Controller:ParameterMissging: param is missing or the value is empty: user


puts params.permit(:hoge_id)
結局、requireを使わず、permitで許可するキーを指定して、その値だけを使っています。
結果 # "hoge_id => "fuga"


**paramsで値を取得する際にrequireを必ずしも使わなくもいいものなのでしょうか？**
僕の解釈では、キーを指定してそれ以外を受け取らないようにする目的だと思うのでいらないのではないかと思いました。
その代わり、permitでしっかりと受け取りたいものを指定しています。

試しに、users_controllerの中で{"name": "太郎"}をjsonでPOSTしてputs prams.require(:user).permit(:name)のようにするとuser => {"name": "太郎"}とちゃんとuserキーの中に値が格納されます。nameはusersテーブルにもともとあるカラムです。
hoge_idはusersテーブルにもともとないものなのでそこが異なっていると思うのですが、よくわかりませんでした。

このように、userをキーとしてjsonでリクエストすると、requireが使えるので、このように、jsonで送るのが正で、userキーをつけないのはよくないかもしれませんが、要望でuserキーを使わないことになっています。

{
	"user": {
        "hoge_id": "fuga"
     }
}

サンプルをネットで探しましたが、params.require(:user).permit(:name)のようなフォーマットしかなく、RailsGuideには

params.permit(:name)

のようにparamsから直接permitを呼んでいるものもあるのですが、これがよい使い方なのかがわかりませんでした。

ActionController::Parameters

Answer 1

Rails４でStrong Parameterに出くわした時に色々やったときの経験では、

DBに入れるには permitは必要。permitしない項目は無視される。
requireは不要、params[:users]でよい。

でした。
ですのでそれに照らすと

{
    "hoge_id": "fuga"
}

で user.update(hoge_id: 某) とするには
user.update(hoge_id: params.permit(:hoge_id))
で良いかと。

Comments

[yoshipu]

ありがとうございます。
自分の実装に自信を持ちました。

Answer 2

paramsで値を取得する際にrequireを必ずしも使わなくもいいものなのでしょうか？
僕の解釈では、キーを指定してそれ以外を受け取らないようにする目的だと思うのでいらないのではないかと思いました。

はい、そのとおりです。必要なキーだけ確実に取得するのであれば、Strong Parameterなしで動かすことすら可能ですし、単純にモデルに代入するのでない場面ではparams以下に値を直接書くことも可能です。

Comments

[yoshipu]

ご回答ありがとうございます。

Answer 3

まず簡単に両メソッドを簡単に説明させてください。

requireとpermitはStrong Parametersというもので、
Rails4系から追加されたDBへの操作が発生する際の受け取りパラメータを制御する仕組みです。

requireメソッドがデータのオブジェクト名(モデルの名前)を定め、
permitメソッドで変更を加えられる（保存の処理ができる）キー(カラム名)を指定します。

rails3まではMass Assignment脆弱性があったため、
このような仕組みが導入されています。

ーーーーー

これを踏まえてyoshipuさんの質問への回答です。

paramsで値を取得する際にrequireを必ずしも使わなくもいいものなのでしょうか？
僕の解釈では、キーを指定してそれ以外を受け取らないようにする目的だと思うのでいらないのではないかと思いました。

requireはオブジェクト名の指定をするメソッドなので、
仮にrequireの指定をせずにDBへの操作が許されるとすると、
別モデルで同じ名前のカラムのデータが混入する危険性などが考えられます。
＊例えばUser.nameとanimals.nameがあった場合など

そのため、DBの操作が発生する際にはrequireとpermitを使用しないと
rails4より上のバージョンではExceptionが返る仕様だったと思います。

Comments

[yoshipu]

詳細に説明していただきましてありがとうございます。