【Rails】ルーティングにおけるnamespace/scope/moduleの違いと使い方について

今回はルーティングにおけるnamespaceとscope、moduleの3つの違いと使い方について簡単にまとめたので紹介したいと思います。namespace/scope/moduleを組み合わせることで大抵のURLを設計できるため、ルーティングを書く際の参考にしてください。

この記事の内容

まず始めに
URL設計
まとめ
参考

まず始めに

rails routesを実行することで表示される項目として「Prefix」「Verb」「URI Pattern」「Controller#Action」があります。今回はこれらを操作していきます。

上記画像はクリックすることで拡大できます。

PrefixはURL用ヘルパー、VerbはHTTPメソッド、URI PatternはURL、Controller#Actionは対応するコントローラのアクションを指します。

URL設計

今回のURL設計ではschool（学校）とclassroom（クラス）とstudent（生徒）の3つを題材として扱います。最初のルーティングとしてはstudents（生徒）に関するアクションのみ（resources :studentsのみ）記述されているとします。

Rails.application.routes.draw do
  resources :students
end

上記画像はクリックすることで拡大できます。

namespace

namespaceは「URI Pattern」と「Controller#Action」の2つを同時にカスタマイズしたい場合に使用します。

例えば「URI Pattern」を/classroom/studentsに「Controller#Action」をclassroom/students#〇〇にしたい場合は以下のように記述します。

Rails.application.routes.draw do
  namespace :classroom do
    resources :students
  end
end

上記画像はクリックすることで拡大できます。

ファイル構成としてはclassroom配下のstudentsコントローラになります。

# app/controllers/classroom/students_controller.rb

module Classroom
  class StudentsController < ApplicationController
    def index
      @students = Student.all
    end
  end
end

また「URI Pattern」をschool/classrooms/studentsに「Controller#Action」をschool/classrooms/students#〇〇にしたい場合は、以下のようにnamespaceをネストすることで実現できます。ファイル構成としては、school/classrooms配下のstudentsコントローラになります。

Rails.application.routes.draw do
  namespace :school do
    namespace :classrooms do
      resources :students
    end
  end
end

# app/controllers/school/classrooms/students_controller.rb

module School
  module Classrooms
    class StudentsController < ApplicationController
      def index
        @students = Student.all
      end
    end
  end
end

上記画像はクリックすることで拡大できます。

scope

scopeは「URI Pattern」のみカスタマイズしたい場合に使用します。

例えば「URI Pattern」のみ/classroom/studentsに変更したい場合は以下のように記述します。

Rails.application.routes.draw do
  scope :classroom do
    resources :students
  end
end

上記画像はクリックすることで拡大できます。

「Controller#Action」の変更は行われていないため、ファイル構成としてはstudentsコントローラになります。

# app/controllers/students_controller.rb

class StudentsController < ApplicationController
  def index
    @students = Student.all
  end
end

また「URI Pattern」のみをschool/classrooms/studentsにしたい場合は、scopeをネストすることで実現できます。ファイル構成は変わらずstudentsコントローラになります。

Rails.application.routes.draw do
  scope :school do
    scope :classrooms do
      resources :students
    end
  end
end

# app/controllers/students_controller.rb

class StudentsController < ApplicationController
  def index
    @students = Student.all
  end
end

上記画像はクリックすることで拡大できます。

module（scope module）

module（scope module）は「Controller#Action」のみカスタマイズしたい場合に使用します。

例えば「Controller#Action」のみclassroom/students#〇〇に変更したい場合は以下のように記述します。

Rails.application.routes.draw do
  scope module: :classroom do
    resources :students
  end
end

上記画像はクリックすることで拡大できます。

ファイル構成としてはclassroom配下のstudentsコントローラになります。

# app/controllers/classroom/students_controller.rb

module Classroom
  class StudentsController < ApplicationController
    def index
      @students = Student.all
    end
  end
end

また「Controller#Action」のみschool/classrooms/students#〇〇に変更したい場合は以下のようにmodule（scope module）をネストさせます。

Rails.application.routes.draw do
  scope module: :school do
    scope module: :classrooms do
      resources :students
    end
  end
end

# app/controllers/school/classrooms/students_controller.rb

module School
  module Classrooms
    class StudentsController < ApplicationController
      def index
        @students = Student.all
      end
    end
  end
end