【2021年から Ruby on Rails をはじめる人向け】 Ruby on Rails 6 入門 Part 8 ～ Rails で Model 連携（アソシエーション）を行う方法～

2021.12.01

link

【2021年から Ruby on Rails をはじめる人向け】 Ruby on Rails 6 入門 Part 8 ～ Rails で Model 連携（アソシエーション）を行う方法～

link です。

今回は Rails 上で Model 連携（アソシエーション）を行う方法について勉強していきます。

この記事は Ruby on Rails 6 入門 Part 7 の続きです。

前提条件

Windows 10
Ruby 3
Ruby on Rails 6

Model アソシエーション

Railsでは、アソシエーションとは 2 つの Active Record の Model どうしのつながりを指します。

実際にプログラムを記述しながらアソシエーションの勉強をしていきたいと思います。

Model とデータベースの用意

まずは、今回利用する Model と Controller を生成します。

コンソールを開いて、以下のコードを入力します。

$ rails generate model Schools name:string
$ rails generate model Students school_id:integer

これで Schools Model と Students Model が生成されました。

続いて、 People Model にカラムを追加します。 rails generate migration AddDetailsToPeople student_id:integer を入力します。

これで、 db/migration/yyyymmddhhmmss_add_details_to_people.rb が自動生成されます。これはマイグレーション時にカラムを追加するファイルです。

カラムが追加されるのに合わせて、いったん DB の中身をリセットします。 rails db:reset:migrate を入力します。

エラーを吐く場合は db/development.sqlite3 を削除して、 rails db:migrate を入力しましょう。

追加 Model と変更後の Model に合わせた初期値を用意するため、 db/seed.rb を以下のように変更します。

Person.create(name:'Ichiro', age:15, student_id:1)
Person.create(name:'Taro', age:15, student_id:2)
Person.create(name:'Jiro', age:14, student_id:3)
School.create(name:'A')
School.create(name:'B')
Student.create(school_id:1)
Student.create(school_id:2)
Student.create(school_id:2)

rails db:seed を入力して、初期値を追加しましょう。

これで必要な Model とデータベースの用意は完了です。

アソシエーションの設定

アソシエーションの設定を記述していきます。

Person Model を以下のコードに変更します。

class Person < ApplicationRecord
    # 前回のバリデーションチェックで追加した内容
    belongs_to :student
end

School Model を以下のコードに変更します。

class School < ApplicationRecord
    has_many :students
end

Student は変更しません。

これでアソシエーションの設定は完了です。

has_many は Model が従属させているモデルの配列を表します。 Model 名の複数形を設定することで Rails 内で自動的にどの Model かを認識してくれます。

has_one は Model が従属させているモデルのインスタンスを表します。 Model 名を設定することで Rails 内で自動的にどの Model かを認識してくれます。

belong_to はどの Model に従属しているかを表します。 has_many, has_one 共通です。

Controller と View の記述

Controller と View をそれぞれ追加していきます。

コンソールに以下のコードを入力して、 schools_controller.rb と students_controller.rb を自動生成します。

$ rails generate controller Schools index show
$ rails generate controller Students index show

app/controllers/schools_controller.rb を以下のように変更します。

class SchoolsController < ApplicationController
  def index
    @header = 'studyRails'
    @footer = 'link'
    @msg = 'School Data'
    @data = School.all
  end

  def show
    @msg = "Indexed data."
    @data = School.find(params[:id])
  end
end

app/controllers/students_controller.rb を以下のように変更します。

class StudentsController < ApplicationController
  def index
    @header = 'studyRails'
    @footer = 'link'
    @msg = 'Student Data'
    @data = Student.all
  end

  def show
    @msg = "Indexed data."
    @data = Student.find(params[:id])
  end
end

続いて、 View を書き換えます。

app/views/schools/index.html.erb を以下のように変更します。

<h1 class="display-4 text-primary">Schools#index</h1>
<p><%= @msg %></p>
<table class="table">
  <tr>
    <th>Id</th><th>Name</th>
  </th>
  <% @data.each do |obj| %>
  <tr>
    <td><%= obj.id %></td>
    <td><a href="/schools/<%= obj.id %>"><%= obj.name %></a></td>
  </tr>
  <% end %>
</table>

app/views/schools/show.html.erb を以下のように変更します。

<h1 class="display-4 text-primary">Schools#show</h1>
<p><%= @msg %></p>
<table class="table">
  <tr>
    <th>Id</th>
    <td><%= @data.id %></td>
  </tr>
  <tr>
    <th>Name</th>
    <td><%= @data.name %></td>
  </tr>
  <% @data.students.each do |obj| %>
  <tr>
    <th>Student</th>
      <td><a href="/students/<%= obj.id %>"><%= obj.id %></a></td>
  </tr>
  <% end %>
</table>

app/views/student/index.html.erb を以下のように変更します。

<h1 class="display-4 text-primary">Students#index</h1>
<p><%= @msg %></p>
<table class="table">
  <tr>
    <th>Id</th><th>School Id</th><th>Person Id</th>
  </th>
  <% @data.each do |obj| %>
  <tr>
    <td><a href="/students/<%= obj.id %>"><%= obj.id %></a></td>
    <td><a href="/schools/<%= obj.school_id %>"><%= obj.school_id %></a></td>
    <td><a href="/people/<%= obj.person.id %>"><%= obj.person.id %></a></td>
  </tr>
  <% end %>
</table>

アソシエーションを設定することで、従属するモデルのインスタンスを実際に持っているかのように扱うことができます。

app/views/schools/show.html.erb の例では students を利用しています。

また、 app/views/students/index.html.erb の例では、 person.id を利用しています。

app/views/students/show.html.erb を以下のように変更します。

<h1 class="display-4 text-primary">Students#show</h1>
<p><%= @msg %></p>
<table class="table">
  <tr>
    <th>Id</th>
    <td><%= @data.id %></td>
  </tr>
  <tr>
    <th>School Id</th>
    <td><a href="/schools/<%= @data.school_id %>"><%= @data.school_id %></a></td>
  </tr>
  <tr>
    <th>Person Id</th>
    <td><a href="/people/<%= @data.person.id %>"><%= @data.person.id %></a></td>
  </tr>
</table>

最後に、 config/route.rb に以下のコードが追加されているかを確認しましょう。

コードが追加されていなかったり、この通りになっていなければ追記、修正してください。

get 'students/index'
get 'students/:id', to: 'students#show'
get 'schools/index'
get 'schools/:id', to: 'schools#show'

これでソースコードの修正は完了です。

localhost:3000/students/index と localhost:3000/schools/index にアクセスして、以下のような画面になっているか確認しましょう。

また、各画面の Id のリンク先が show 画面につながっているかも確認しましょう。

アソシエーションの種類

以下はアソシエーションの解説です。

今回利用したアソシエーション以外にも多対多の関係を表すアソシエーションがあります。

has_one

1 対 1 関係の Model に記述されます。

上記の例では使っていませんが、 Person の belongs_to の代わりに、 Student に has_one を記述することで同じ関係にできます。

これについては後程解説します。

has_many

1 対多関係で従属させる側の Model に記述されます。

上述の例では、 Schools が該当しています。

belongs_to

1 対 1 関係の Model に記述されます。

has_one との違いは外部キーをどちらの Model に置くかです。

has_one は外部キーを記述した Model の外側に置きますが、 belongs_to は記述した Model に置きます。

上述の例では、 Person が該当しています。

has_many :through

多対多の関連付けをする場合に使われます。この関連付けは 2 つのモデルの間に第 3 のモデルが介在しています。

has_one :through

1 対 1 の関連付けをする際に使われます。通常の has_many と異なるのは第 3 のモデルが介在する点です。

has_and_belongs_to_many

多対多の関連付けをする場合に使われます。 has_many :through と異なり、第 3 のモデルが介在しません。

参考サイト

Active Record の関連付け - Railsガイド

まとめ

今回は Rails 上で複数のモデルを連携させる方法を勉強しました。

次回は CRUD を自動生成する機能である Scaffold について勉強します。

それではまた、別の記事でお会いしましょう。