美しいコードを!Ruby on Railsのhelperの使い方【初心者向け】
Railsで書くhelperの使い方について解説しています。実際のチーム開発でもより美しく見やすいコードを書くためにhelperはよく使われます。これからエンジニアを目指すという人であれば必要になってくる知識なので覚えておきましょう。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日 調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名 調査手法:インターネット調査
監修してくれたメンター
mentor-hakamata
C#, Ruby, Python, JavaScriptなど経験。
RubyのフレームワークのRailsに存在するModel,View,Controllerの他にHelperというクラスが存在しているのはご存知でしょうか。
HelperはRailsのコードを美しく書くために必須のクラスになっています。
今回はそんなHelperクラスについて、テックアカデミーのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。
目次
Rubyについてそもそもよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。
田島メンター!!ヘルパーというのは何ですか〜?
ヘルパーは、定義しておくことでビュー内でその処理を呼び出すことができるものだよ。
例えばどんなときに使うんですか〜?
よく使う処理や、全く別の用途のクラス内でも同じことをしたいときなどに利用するといいよ。基本の流れを見てみよう。
Helperとは
Helperとはわかりやすく言うとViewをよりシンプルに書くためのものです。Helperを使用することによって、より可読性の高いコードを書くことが可能になります。
可読性の高いコードというのは今後どのプログラミング言語を書く際にも、必要になってきますので、そういうコードを書く癖をつけましょう。
Helperの例
<%= link_to %> <%= form_tag %>
など、よく見るコードですがこれらはすべてHelperです。
link_toはhtmlのaタグを生成、form_tagはformタグを生成することができるHelperになります。
Helperを利用するメリット
例えば同じ内容を複数表示するような場合を考えてみましょう。
htmlに直接記載する場合は、
sample1.html.erb
<a>こんにちは、Techacademyさん</a>
sample2.html.erb
<a>こんにちは、Techacademyさん</a>
このように複数のファイルに内容を記載していきます。
これを「こんにちは」から「こんばんは」に変更してみましょう。
そうするとsample1.html.erbとsample2.html.erbの2つを修正しなければならないですよね。
今回は2ファイルのみの修正ということになりますが、もっと規模の大きいシステムの場合は修正するファイルが大量になってしまいます。
このような場合にHelperを利用することができます。
module ApplicationHelper def greeting 'こんにちは、Techacademyさん' end end
Helperを使用してhtmlを生成する場合は
sample1.html.erb
<%= link_to greeting %>
sample2.html.erb
<%= link_to greeting %>
このようになります。
ではこれを「こんにちは」から「こんばんは」に変更してみましょう。
ApplicationHelperのgreetingメソッドの戻り値である「こんにちは、Techacademyさん」を「こんばんは、Techacademyさん」に修正します。
複数のファイルを修正する必要がなく、一か所の修正で済むことが分かりますね。
それぞれのファイルも記載の仕方に統一感があるので可読性も高いです。
Helperの処理で様々な処理を書くこともできるので、例えば「Techacademyさん」の部分を変数にして、表示させる名前をログインしたユーザーごとに変更することも可能です。
独自Helperの作成方法
アプリ作成時にはhelpersフォルダにApplicationHelperが既に生成されていますが、コマンドを実行することで独自のヘルパーを作成することもできます。
rails g helper sample
上記コマンドを実行すると、
$ rails g helper sample create app/helpers/sample_helper.rb invoke rspec create spec/helpers/sample_helper_spec.rb
このように独自のヘルパーが作成されます。
rails gコマンドを使用して、コントローラーを生成した場合も自動でHelperも作成されています。
機能ごとに特別な処理を行う場合は独自のヘルパーを、共通で使用できるような処理の場合はApplicationHelperに処理を作成するようにしましょう。
Helper使用例
今回はTechacademyという文字列を表示するHelperを作ってみましょう。
ApplicationHelperを以下のように修正します。
module ApplicationHelper def tech 'Techacademy' end end
Helperを使用したいビューでは以下のように記載します。
<%= tech %>
これで表示できます。
このように表示されていればHelperを使用してビューにTechacademyを表示することができています。
ヘルパーを定義するファイルはどこにあるんですか?
app/helpers内に各モジュールが存在するんだ。今回使用しているのはapplication_helper.rb、アプリ全体で使えるものだね。
あ!ありました!ここに処理を追加するんですね。
最後の<%= tech%>はビューに記述しよう。これによってヘルパーを使うことができるよ。
例えば、表示する文字をテックアカデミーにしたければ
module ApplicationHelper def tech 'テックアカデミー' end end
こうすれば表示される文字列がテックアカデミーに変更されます。
このように、よく使う文字列などを登録しておけば、その文字列を変更したい場合や、間違っていた場合などに対応しやすいです。
今回は、単純な使用例のみ解説しましたが、まだまだ便利なHelperの使用例はたくさんあります。
コードを綺麗に書くために興味のある方は調べてみましょう。
まとめ
本記事では、Ruby on RailsにおけるHelperについて解説しました。
- Helperとは
- Helperを利用するメリット
- Helperの例
- 独自Helperの作り方
- Helperの具体的な使用例
Helperを理解することで、プログラムコードの削減や可読性を実現できます。
ぜひ使いこなせるように覚えておきましょう。
ヘルパーの基本的な流れは分かったかな?
まずapp/helpersのモジュールで処理を定義、それをビューから<%= 〜%>で呼び出すという形ですね。
またヘルパーには、定義していなくても最初から使えるform_tag(フォームを作成)などの便利なものがたくさんあるのでそれも活用しよう。これらは公式のガイドから名前とその機能を確認できるよ。
まずはそれらを使って、そこでできないことがあったら独自ヘルパーを定義するという形ですね。分かりました!
Ruby on Railsを学習中の方へ
これで解説は終了です、お疲れさまでした。
- つまずかず「効率的に」学びたい
- 副業や転職後の「現場で使える」知識やスキルを身につけたい
プログラミングを学習していて、このように思ったことはありませんか?
テックアカデミーのWebアプリケーションコースでは、第一線で活躍する「プロのエンジニア」が教えているので、効率的に実践的なスキルを完全オンラインでしっかり習得できます。
合格率10%の選考を通過した、選ばれたエンジニアの手厚いサポートを受けながら、Ruby on Railsを使ったWebアプリケーション開発を学べます。
まずは一度、無料体験で学習の悩みや今後のキャリアについて話してみて、「現役エンジニアから教わること」を実感してみてください。
時間がない方、深く知ってから体験してみたい方は、今スグ見られる説明動画から先に視聴することをおすすめします!