Railsのrequire/permitメソッドの使い方を現役エンジニアが解説【初心者向け】

Railsのrequire/permitメソッドの使い方について解説します。

 
そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。

なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。

 

 

require/permitメソッドとは

require/permitメソッドとは、RailsでDBを更新する際に、不要なパラメータを取り除く(必要なパラメータだけに絞り込む)ためのメソッドです。

 

require/permitメソッドが必要な理由

なぜこのメソッドが必要なのか、name, age, passwordを持つUserモデルを例にして考えてみましょう。

(一般的には考えにくいですが)何らかの事情でpasswordフィールドは、利用者に更新させたくなかったとします。その場合の更新用フォームは以下の画像のようになるでしょう。

この時にRailsで受け取るパラメータは以下の通りです。

 

params = {
  "utf8" => "?",
  "authenticity_token" => "token",
  "user" => {
    "name" => "taro",
    "age" => "18"
  },
  "commit" => "Update User",
  "id" => "1"
}

 

もし悪意のある利用者が、次のように入力フォームを追加して投稿した場合、受け取るパラメータも変わってしまいます。

 

params = {
  "utf8" => "?",
  "authenticity_token" => "token",
  "user" => {
    "name" => "hanako",
    "age" => "30",
    "password" => "YourPassword" # このフィールドが追加される
  },
  "commit" => "Update User",
  "id" => "1"
}

 

このように本来送られてくることのないpasswordパラメータが存在していたとしても、それを取り除くことができるのがrequire/permitメソッドになります。

require/permitメソッドの使い方

requireメソッドで受け取るパラメータ群を、permitメソッドで利用可能なパラメータ名を指定します。

Userモデルのname, ageカラムのみを受け取る場合は、以下のように書きます。createメソッド、updateメソッドで共通的に使用するため、user_paramsのように別のメソッドに切り出すのが一般的です。

 

def user_params
  params.require(:user).permit(:name, :age)
end

 

[PR] Rubyのプログラミングで挫折しない学習方法を動画で公開中

筆者プロフィール

メンター稲員さん フリーランスエンジニア。 大手SEからフリーランスのWeb系エンジニアにジョブチェンジ。 経験言語：Ruby、Rails、Python、C/C++、Java、Perl、HTML/CSS3、JavaScript、CoffeeScript,Node.js。 おうち大好きマンです。

 

 

TechAcademyでは、初心者でもRuby on Railsを使ったプログラミングを習得できるオンラインブートキャンプRuby講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。