【Rails】忘れがちなルーティングの書き方を総復習

はじめに

Railsのルーティングは、受け取ったURLを解析し、適切なコントローラーのメソッドに処理を移譲する役目を担います。ルーティングはMVCモデルの各機能と並んでRailsアプリの基幹機能のひとつだと言えます。

本記事では、Railsのルーティングの書き方についてまとめています。なお、ルーティングの書き方はたくさんありオプションも豊富に存在しますが、本記事ではよく使うであろう書き方のみ取り上げています。

ルーティング情報の確認

現在のルーティング情報を確認するには、以下のコマンドを実行します。

$ rails routes

上記のコマンドはすべてのルーティング情報を表示するので、ルーティングが増えてくると確認したい目的のルーティング情報を探すのが大変です。上記コマンドに-gオプションをつけるとルーティング情報を絞り込むことができます。

$ rails routes -g users

また、-cオプションをつけるとコントローラー名で絞り込むことができます。

$ rails routes -c articles

コマンドではなくブラウザで確認することもできます。テストサーバーを起動している状態でhttp://localhost:3000/rails/info/routesにアクセスするとルーティング情報が表示されます。この方法ではパスの部分検索ができます。

ルーティングの書き方

ルーティングはconfig/routes.rbに記述していきます。

基本の書き方

最も基本的な書き方は以下のようになります。

get '/', to: 'statics#index'

先頭にHTTPメソッドを記述し、次にURL、そして移譲するコントローラーとメソッドを記述します。使用できるHTTPメソッドは以下の通りです。

HTTPメソッド 説明
GET 既存データを取得する。
POST 新規データを作成する。
PUT 既存データを更新する。
PATCH 既存データを更新する(差分)。
DELETE 既存データを削除する。

なお、上記の例はルートのルーティングを設定しているので、以下のように書くこともできます。ルートは最も基本となるルーティングなので、先頭に記述するのが望ましいです。

root 'statics#index'

Resourcefulルーティング

Resourcefulとは、Railsのルーティングにおいて、RESTful APIの統一インターフェースとほとんど同じ意味として使われています。

統一インターフェース(Uniform Interface)とは、情報の操作(取得、作成、更新、削除)は全てHTTPメソッド(GET、POST、PUT、DELETE)を利用すること。

Resourcefulルーティングとは、ひとつのコンテンツに対してこれらすべてが行えるルーティングという意味になります。前のセクションで示したような基本の書き方で一つ一つ記述してもいいのですが、それだと大変なので、Resourcefulルーティングを一行で書くことができます。

resources :articles

これだけの記述で以下のルーティングが使えるようになります。HTTPメソッドとパスの組み合わせによって振り分けるアクションが決定されます。ヘルパーの接頭辞については後述します。

メソッド パス アクション ヘルパーの接頭辞
GET /articles ArticlesController#index articles
GET /articles/:id ArticlesController#show article
GET /articles/new ArticlesController#new new_article
POST /articles ArticlesController#create -
GET /articles/:id/edit ArticlesController#edit edit_article
PUT/PATCH /articles/:id ArticlesController#update -
DELETE /articles/:id ArticlesController#destroy -

複数のResourcefulルーティング

Resourcefulルーティングは一行で複数のコントローラーを書くこともできます。

resources :users, :sessions, :articles

入れ子のResourcefulルーティング

Resourcefulルーティングは入れ子にして書くこともできます。

resources :articles do
  resources :comments
end

上記の例では、:articlesのルーティングに加え、以下のルーティングが使えるようになります。

メソッド パス アクション ヘルパーの接頭辞
GET /articles/:article_id/comments CommentsController#index articles_comments
GET /articles/:article_id/comments/:id CommentsController#show article_comments
GET /articles/:article_id/comments/new CommentsController#new new_article_comments
POST /articles/:article_id/comments CommentsController#create -
GET /articles/:article_id/comments/:id/edit CommentsController#edit edit_article_comments
PUT/PATCH /articles/:article_id/comments/:id CommentsController#update -
DELETE /articles/:article_id/comments/:id CommentsController#destroy -

Resourcefulルーティングの制限

Resourcefulルーティングで作成されるルーティングのうち、特定のルーティングを作成するにはonlyオプションを指定します。また、特定のルーティングを除外するにはexceptオプションを指定します。以下の例では、作成されるルーティングはいずれもindexshowのみとなります。

resources :articles, only: [:index, :show]
resources :articles, except: [:new, :create, :edit, :update, :destroy]

Resourcefulルーティングへの追加

Resourcefulルーティングで作成される7つのルーティング以外に別のルーティングを追加したい場合、以下のように記述します。

resources :articles do
  collection do
    get 'list', to: 'articles#list'
  end
  # 以下のようにも記述できる
  # get 'list', to: 'articles#list', on: :collection
end

上記の例では、:articlesのルーティングに加え、以下のルーティングが使えるようになります。

メソッド パス アクション ヘルパーの接頭辞
GET /articles/list ArticlesController#list list_articles

引数付きのルーティングを追加したい場合、以下のように記述します。

resources :articles do
  member do
    get 'draft', to: 'article#draft'
  end
  # 以下のようにも記述できる
  # get 'draft', to: 'article#draft', on: :member
end

上記の例では、:articlesのルーティングに加え、以下のルーティングが使えるようになります。

メソッド パス アクション ヘルパーの接頭辞
GET /articles/:id/draft ArticlesController#draft draft_article

ルーティングの名前空間

コントローラーを名前空間付きで作成している場合、ルーティングも名前空間付きで作成する必要があります。以下の例では、user/settings_controller.rbのルーティングを作成しています。

namespace :user do
  resources :settings
end

作成されるルーティングは以下の通りです。

メソッド パス アクション ヘルパーの接頭辞
GET /user/settings User::SettingsController#index user_settings
GET /user/settings/:id User::SettingsController#show user_setting
GET /user/settings/new User::SettingsController#new new_user_setting
POST /user/settings User::SettingsController#create -
GET /user/settings/:id/edit User::SettingsController#edit edit_user_setting
PUT/PATCH /user/settings/:id User::SettingsController#update -
DELETE /user/settings/:id User::SettingsController#destroy -

ルーティングのオプション

ルーティングの別名

ルーティングに別名をつけることができます。また、ルーティングに別名をつけるとヘルパーメソッドの接頭辞もそれにあわせて変更されます。以下の例では、ヘルパーメソッドはsignin_pathsignin_urlとなります。

get '/login', to: 'sessions#new', as: 'signin'

引数の制限

ルーティングに:idなどの引数が含まれる場合、有効とする引数の制限を行うことができます。以下の例では、:idに1文字以上の数字のみを許可しています。

get 'articles/:id', to: 'articles#show', constraints: { id: /\d+/ }

レンダリング方法の指定

ブラウザのレンダリング方法を明示的に指定することができます。以下の例では、/feedにアクセスするとRSS形式でレンダリングされます。

get '/feed', to: 'rss#index', defaults: { format: :rss }

ヘルパーメソッドの使用

ルーティングを作成すると、コントローラーやビューで使用できるヘルパーメソッドも自動作成されます。ヘルパーメソッドの名前は、ルーティングの接頭辞+_pathまたは_urlを繋げたものになります。

root 'statics#index'
# => root_path / root_url

get '/privacy', to: 'statics#privacy'
# => privacy_path / privacy_url

resources :articles
# => articles_path / articles_url
# => article_path(:id) / article_url(:id)
# => new_article_path(:id) / new_article_url(:id)
# => edit_article_path(:id) / edit_article_url(:id)

例えばarticles_path/articlesを返し、article_path(:id)/articles/:idを返します。また、articles_url/articlesにホスト名を加えた値(完全なURL)を返します。

まとめ

ルーティングはビューを表示するURLだけを設定するわけではありません。createupdatedestroyといったアクションに専用のビューは存在しません。あるいはset_valueのようなAjax処理を実装している場合も同様です。コントローラーに存在するメソッド(アクション)には必ず対応するルーティングが存在している必要があります。

本記事を参考にして、ルーティングの書き方を覚えていただければと思います。

関連記事

【Rails】Webサーバー「Unicorn」の基本情報と実装方法
# はじめに Railsアプリを本番環境で稼働させるには、クライアントからのリクエストを捌くWebサーバーを導入する必要があります。WebサーバーはクライアントからのリクエストをRailsアプリに伝達し、Railsアプリで処理されたレスポンスをク [...]
2021年4月15日 12:17
【Rails】デプロイツール「Capistrano」の基本情報と実装方法
# はじめに アプリを本番環境にアップロードして誰でもアクセスできる状態にすることをデプロイと言います。デプロイで行うべきことは多岐にわたります。Railsアプリの場合で言えば、本番環境にアップロードすることはもちろんですが、Gemのインストール [...]
2021年4月14日 9:56
【Rails】Webpackerの基本情報と実装方法
# はじめに Rails 6からWebpackerが正式採用されました。Rails 5ではオプションで追加することができたWebpackerですが、Rails 6からは普通にアプリを作成するだけでWebpackerがインストールされ、必要な設定も [...]
2021年4月12日 14:36
【Rails】アセットパイプライン(Sprockets)の基本情報と実装方法
# はじめに Ruby on Railsにはアセットパイプラインという機能があります。アセットパイプラインは画像、CSS、JavaScriptといったアセットファイルを連結/圧縮することでRailsアプリを高速化します。また、より高級な言語で書か [...]
2021年4月11日 14:08
【Rails】Turbolinksの基本情報と実装方法
# はじめに Ruby on Railsにはページの遷移を高速化するTurbolinksという機能があります。Turbolinksは優れたJavaScriptライブラリですが、Rails 5からは標準で有効化されているため、Turbolinksを [...]
2021年4月10日 17:59