覚えておくと超便利!Ruby on Railsのscaffoldの使い方【初心者向け】

Ruby on Railsでアプリケーションの雛形を作れる【scaffold(スキャフォールド)】の使い方を初心者向けに解説した記事。サンプルコマンドですぐに実行でき、必要なデータベースのテーブル作成方法も紹介。

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

RubyのフレームワークのRuby on Railsには、コードを自動生成する便利なものが多く存在し、今回はその一つであるscaffold(スキャフォールド)を紹介します。

社内で開発をするときにscaffoldを使うことは無いかもしれませんが、個人でアプリケーションを作るときに練習で使ってみると理解が深まるでしょう。

 

大石ゆかり

田島メンター!!scaffoldは何をする機能なんですか~?

田島悠介

scaffoldは簡単に言うと、ひとつの雛形を作成してくれるものなんだ。使用するデータの型などを指定して、自分の作りたいものの土台を作ることができるんだよ。

大石ゆかり

便利ですね!

田島悠介

今回は例として、ユーザーの名前と年齢を入力してそれらを管理する機能を作成してみよう。

 

scaffoldとは

railsアプリケーションの開発をする際には、モデルやコントローラー、ビューを作っていき、さらに必要なルーティングを作成していく必要があります。

railsにはこれらの作業をまとめて行って、簡単にアプリケーションの雛形を作ってくれる機能があります。

それがscaffoldです。

scaffoldを使うことで素早くrailsアプリケーションを作ることができます。

 

実際にscaffoldを使ってみよう

今回は、scaffoldを使ってユーザーを管理する簡単な機能を作りたいと思います。
まずはscaffoldを試すためのサンプルアプリケーションを作成します。次のコマンドを実行してください。

$ rails new scaffold_sample

完了したらサンプルアプリケーションのディレクトリに移動します。

$ cd scaffold_sample

これでscaffoldを試す環境が整いました。scaffoldのコマンドの書式は次のようになります。

$ rails generate scaffold モデル名 カラム名1:データ型1 カラム名2:データ型 2 …

今回はユーザー管理機能なのでUserモデルを作成します。Userモデルは名前を表す「name」属性と年齢を表す「age」属性を持つとします。
次のコマンドを実行してみてください。

$ rails generate scaffold user name:string age:integer

generate_scaffold

たくさんのファイルが自動生成されました。生成されたファイル、変更されたファイルをみていってみましょう。

マイグレーションファイル、モデル

次の2ファイルがデータベースのテーブルやカラムを変更することの出来るマイグレーションファイルとUserモデルのファイルです。

  • db/migrate/20160310025746_create_users.rb
  • app/models/user.rb

 

コントローラーとルーティング

コントローラーファイルはこちらです。

  • app/controllers/users_controller.rb

作成されたusers_controller.rbを見てみると、「index」「show」「new」「edit」「create」「update」「destroy」の7つのアクションが自動的に定義されているのがわかります。

これらのアクションを呼び出してデータの参照、作成、変更、削除を行うことができます。

 

また、ルーティングの設定ファイルも自動変更されます。以下のファイルの中を見てみみてください。

  • config/routes.rb

ファイルの中に

resources :users

という記述が追加されています。

この記述をすることでユーザー管理機能にアクセスすることができるようになります。

 

ビュー

コントローラーで定義されたアクションに対応するビューファイルが全て作成されています。

次のファイルが作成されたビューファイルです。

  • app/views/users/index.html.erb
  • app/views/users/edit.html.erb
  • app/views/users/show.html.erb
  • app/views/users/new.html.erb
  • app/views/users/_form.html.erb

 

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

テーブルの作成

先ほど実行したscaffoldでアプリケーションの雛形は完成しましたが、最後にデータベースのテーブルを作成する必要があります。

テーブルを作成にはマイグレーションファイルを使用します。

scaffoldで自動生成された「db/migrate/20160310025746_create_users.rb」です。

次のコマンドを実行してテーブルを作成します。

$ rake db:migrate

migrate_result

以上でサンプルアプリケーションの作成は完了です。

 

田島悠介

データ型には文字列・整数・少数の他に日付や時間、boolean型なども設定することができるよ。

大石ゆかり

今回の場合はnameという文字列型のカラムと、ageという整数型のカラムを作ったということでしょうか?

田島悠介

そうだね。次は実行してみたときにどのように表示・動作するのか見てみよう。

 

ローカル環境で動かしてみよう

実際に動かして確認してみましょう。まず、アプリケーションを起動します。
次のコマンドを実行してください。

$ rails server

起動したら、ブラウザから「http://localhost:3000/users」にアクセスしてください。

index1

ユーザーの一覧ページです。まだ、データがないので何も表示されません。
では、「New User」リンクをクリックしてユーザーデータを作成してみましょう。

new_create

項目を埋めたら「Create User」ボタンを押してください。

create_done

データの作成が完了しました。それでは、「Back」リンクからもう一度データの一覧ページに戻ってみましょう。

index2

先ほど作成した山田太郎さん(20歳)のデータが一覧画面に表示されています。

他にも作成したデータに対して「Show」リンクから詳細ページをみれたり、「Edit」リンクからデータ更新、「Destroy」リンクからデータの削除をすることができます。

このようにscaffoldを使うことで簡単に素早くアプリケーションの雛形を作ることができました。

以上、scaffoldの解説でした。

Ruby/Rails開発のためのおすすめエディタ/IDEとはについて現役エンジニアが回答した記事もあります。合わせてご覧ください。

 

田島悠介

入力した名前と年齢が、一覧に反映されたかな?

大石ゆかり

名前と型を定義しただけでこんなことができるんですね!

田島悠介

データベースとマイグレーションに関してはまた別のところで解説するよ。まずは色々なデータ型を試して、どのような土台ができるか実際に見てみよう。

大石ゆかり

そうですね、やってみます。ありがとうございました!

 

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