実践の場で役立つ!Ruby on Railsのbefore_actionの使い方【初心者向け】

Ruby on Railsで使うbefore_actionの使い方に関する記事です。railsではcontrollerでbefore_actionを定義することで、アクションの前に処理を差し込むことができます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が1,000以上あります。

初心者向けにRubyのフレームワークRailsで使えるbefore_actionの書き方を解説していきます。

railsではcontrollerでbefore_actionを定義することで、アクションの前に処理を差し込むことができます。

 

なお本記事は、TechAcademyのWebアプリケーションオンラインブートキャンプの内容をもとに紹介しています。

 

20163020-2

 

今回はRuby on Railsのbefore_actionについて説明するよ。

 

20160620

 

田島メンター!!before_actionというのは何をするんですか~?

 

20163020-2

 

before_actionはアクションの前に指定の処理を入れることができるものだよ。例えばユーザーがまだログインしていない場合に、ログイン画面に行ってもらうというようなことを設定するのにも使えるね。

 

20160620

 

なるほど、実際によく見るやつですね。お願いします!

 

before_actionとは

railsではcontrollerでbefore_actionを定義することで、アクションの前に処理を差し込むことができます。一般的に、複数のアクションで共通して必要になる処理などをbefore_actionで定義することが多いです。

例えば、ログイン機能があるアプリケーションでは、各アクションでユーザーがログインしているかのチェックを行う必要があります。

このようなときに、ログイン認証の処理をbefore_actionとして定義しておけば、各アクションにアクセスが来た時に、最初にログイン認証を行って、その後に各アクション独自の処理をするといったことが可能になります。

before_actionの使い方

before_actionの使い方は次のようになります。controllerにbefore_actionとして処理したいメソッドを定義して、controllerのclass定義の下に次の書式でbefore_actionを定義します。

class SampleController < ApplicationController
  before_action :メソッド名
  ・・・
  def メソッド名
  ・・・
  end
end

たったこれだけで、アクションの前に指定したメソッドの処理を差し込むことができます。

 

20163020-2

 

app/controllersからbefore_actionを追加したいコントローラーを開き、そこに入力していくよ。

 

20160620

 

ここで何の処理をはさみたいかを設定するんですね。

 

20163020-2

 

では実際に、簡単な例でbefore_actionを実行してみよう。

 

実際にbefore_actionを書いてみよう

まず、サンプルアプリケーションをscaffoldで作成します。
以下のコマンドを実行してください。

$ rails new sample_app
$ cd sample_app
$ rails generate scaffold User name:string
$ rake db:migrate

では、サンプルとしてusers_controller.rbにset_textという変数に文字列を代入する処理をbefore_actionとして定義してみましょう。

まず、 app/controllers/users_controller.rbをテキストエディターで開いて、「private」と書かれているコードの下に次のコードを書きます。

def set_text
  @text = 'hello, world.'
end

次に、このメソッドをbefore_actionとして定義します。

before_action :set_text

これでusers_controllerのどのアクションにアクセスが来ても変数@textに値が代入されるようになったので、変数@textをビューに表示して確認してみましょう。

まず、「app/views/users/index.html.erb」に次の変更を加えます。

<h1>Listing Users</h1>
<p>before_actionで定義した@text: <%= @text %></p>  <!— ←この行を追加 —>
<table>
・・・
</table>
<br>
<%= link_to 'New User', new_user_path %>

変更したら次のコマンドを実行してrailsアプリケーションを起動します。

$ rails server

アプリケーションが起動したら、ブラウザで「http://localhost:3000/users」にアクセスしてみます。

before_action_sample-620x198
「before_actionで定義した@text: hello, world.」と表示されているのが確認できると思います。

このようにbefore_actionを定義することでcontrollerのアクションの前にさまざまな処理を追加することができます。
以上、before_actionの説明でした。

 

20163020-2

 

今回は短い文字列を変数に代入し、それをビューに表示してみたよ。

 

20160620

 

実行した画面を見ると、一番上に代入した文字列が表示されているのが分かりますね。

 

20163020-2

 

before_actionとは別にafter_actionというのも存在するんだ。これはアクションの実行後に処理を入れるというものなので、一緒に覚えておこう。

 

20160620

 

分かりました!

 

 

[お知らせ]TechAcademyでは初心者でも8週間でエンジニアになれるRuby on Railsオンラインブートキャンプを開催しています。RubyでWebアプリを開発したい方はご参加ください。