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

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

テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日  調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名  調査手法:インターネット調査

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

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

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

大石ゆかり

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

 

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

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

 

田島悠介

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

大石ゆかり

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

田島悠介

では実際に、簡単な例で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の説明でした。

 

田島悠介

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

大石ゆかり

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

田島悠介

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

大石ゆかり

分かりました!

 

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

初心者・未経験でもできる。まずはテックアカデミーに相談しよう

プログラミングを独学していて、このように感じた経験はないでしょうか?

  • ・調べてもほしい情報が見つからない
  • ・独学のスキルが実際の業務で通用するのか不安
  • ・目標への学習プランがわからず、迷子になりそう

テックアカデミーでは、このような 学習に不安を抱えている方へ、現役エンジニア講師とマンツーマンで相談できる機会を無料で提供 しています。
30分間、オンラインでどんなことでも質問し放題です。

「受けてよかった」と感じていただけるよう 厳しい試験を通過した講師 があなたの相談に真摯に向き合います。

「ただ気になることを相談したい」
「漠然としているがプロの話を聞いてみたい」

こんな気持ちでも大丈夫です。

無理な勧誘は一切ありません ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。(1週間限定)

今なら参加者限定の割引特典付き! 無料相談を予約する