RailsのModelの書き方まとめ

どうもはじめまして。Tyo_Doと申します。

以前、【完全保存版】5万円でエンジニア転職してみた。未経験から自社開発エンジニアに転職するまでのロードマップ。という記事を書かせていただき、非常に好評だったので調子に乗ってもう1本書いてみました。

本記事は、私がプログラミング学習において一番躓いたといっても過言ではないMVCのModelについて解説した記事です。

少しでも数か月前の私のように躓いている方の助けになればと思います。

また、私自身春からエンジニアとして働かせていただく身です。執筆時点ではエンジニアではないため間違えている箇所があるかもしれません。もし間違えている箇所がありましたらコメントで教えていただけると助かります。

対象読者

本記事の対象者は以下のような方です。

• 教科書などを見ながらRailsでアプリケーションを開発したことがある方。
• 一度MVCについて学習した方
• MVCがなんとなくわかった気がするという方
• MVCがなんとなくしかわかっていないという方

参考

※一部引用させていただいております。著作権等には十分注意しておりますが、問題がありましたら速やかに対応いたしますのでコメントにてお知らせください。

Rails をはじめよう -Railsガイド
【Ruby on Rails 6】Instagram風簡易SNSアプリを作ってみよう！

【Model】情報の型を定義するための仕組み

Modelを一言で表すと、情報を定義することです。
教科書などではオブジェクトといったような用語が使われているかと思います。

ここではTwitterの投稿を例にして考えてみましょう。

早速ですが、Twitterの投稿に含まれている情報を考えてみてください。

「..........」

あくまで一例ですが、以下のような情報がTwitterの投稿には含まれているかと思います。

• 投稿者
• 本文
• 画像

リツイートやいいね、リプライなどもありますが、ややこしくなるのでここは一旦上記の3点で進めましょう。

Modelはこの情報を定義するための場所です。

ER図

上記のツイートを例にすると、1ツイートに複数枚の写真が存在することがわかります。これを1対多の関係と呼びます。

ER図に表すと以下のようになります。

実際のコード

では実際にRuby on Railsではどのように定義しているのかを確認していきます。

モデルを作成するためのコマンドは以下のようなコマンドです。
Model名にする1文字目は大文字＆単数形であることに注意してください。

ちなみに、gはgenerateの略です。

$ rails g model <Model名>

Tweetモデルの作成

ここではTweetというモデルを作成していきます。

$ rails g model Tweet

上記のコマンドを実行すると、モデルファイルとマイグレーションファイルが生成されます。

• app/models/tweet.rb
• db/migrate/××××××××××××_create_tweets.rb

実際にマイグレーションファイルの中身を見ていきましょう。

class CreateTweets < ActiveRecord::Migration[6.0]
  def change
    create_table :tweets do |t|

      t.timestamps
    end
  end
end

それではマイグレーションファイルの中身をいじってみます。

class CreateTweets < ActiveRecord::Migration[6.0]
  def change
    create_table :tweets do |t|
      t.string :name
      t.string :body, null: false, length: { maximum: 140 }
      t.timestamps
    end
  end
end

編集した部分がわかるでしょうか？
エンジニアの方が見たら外部キーは！！一意性は！！などと言われそうですが、そこは目をつぶってください。

ここではTweetを構成する情報を定義しています。
先程の

• 投稿者
• 本文

を記載しています。

Railsでは、以下のようにデータを表現します。

t.<型> :<カラム名>　

また、カラム名のあとにはその特性をつけることもできます。
ここでは、bodyがnullではない、文字数が140字以内であることを定義しています。

それでは以下のコマンドを実行します。意味は覚えなくでも結構です。

$ rails db:migrate

以上でTweetモデルは完成です。

Photoモデルの作成

それではPhotoモデルを作成していきましょう。

モデルを作成します。

$ rails g model Photo image:string tweet_id:references

上記のように、コマンドからカラムの設定を行うこともできます。

$ rails g model <モデル名> <カラム名>:<型>

db/migrate/××××××××××××_create_photos.rbとapp/models/photos.rbを確認してみましょう。

class CreatePhotos < ActiveRecord::Migration[6.0]
  def change
    create_table :photos do |t|
      t.string :image
      t.references :tweet_id, null: false, foreign_key: true

      t.timestamps
    end
  end
end

class Photo < ApplicationRecord
  belongs_to :tweet_id
end

予めカラムが設定されていることがわかると思います。

【補足】
外部キーのカラムの型はreferencesにします。こうすることで自動でリレーションを定義してくれます。

それでは、migrateしましょう。

$ rails db:migrate

最後にapp/models/tweets.rbを修正して1対多の関係を完成させます。

class Tweet < ApplicationRecord
    has_many :photos, dependent: :destroy
end

dependent: :destroyは、親モデルを削除したとき、子モデルも削除するかどうかを表しています。
要するに、ツイートを削除したときにはそのツイートに紐づく写真も削除されるようになります。

まとめ

• モデルは情報の型を定義するための仕組み
• マイグレーションファイルにモデルの基本情報を記載する
• モデルファイルには他のモデルとの関係を書く
  • 多の関係：has_many
  • 1の関係 : belongs_to
  • dependent: :destroyで親モデルの削除に連動して子モデルも削除