【Rails】RESTfulとは何か、なぜRailsはそれを強制するのか

【Rails】RESTfulとは何か、なぜRailsはそれを強制するのか

おつかれさまです。前回HTTPメソッドとルーティングの話を書いたので、今日はその背景にある考え方について。

resources と書くだけで7つのルートができるのは、Railsが「こう書け」と決めているからです。なぜ決められているのかを見ていきます。

RESTの考え方

RESTを一言でいうと、URLは「もの」を表して、操作はHTTPメソッドで表すという考え方です。

/articles/1 は「1番の記事」というものを指しています。それをどうしたいかはURLには書かず、動詞で示します。

  • GET /articles/1 → 見る
  • PATCH /articles/1 → 更新する
  • DELETE /articles/1 → 削除する

この「もの」のことをリソースと呼びます。

RESTfulでないURLと比べる

比べると分かりやすいです。こういう書き方もできます。

GET  /getArticles
POST /createArticle
POST /updateArticle?id=1
POST /deleteArticle?id=1

URLの中に動詞が入っています。 動くという意味では問題ありませんが、いくつか困ることがあります。

  • 名前の付け方が人によって違う(createArticle / article_create / newArticle)
  • 操作が増えるたびにURLが増える
  • URLを見ても、何のリソースを扱っているのか分かりにくい

RESTfulに書くとこうなります。

GET    /articles
POST   /articles
PATCH  /articles/1
DELETE /articles/1

URLは2種類だけです。/articles(記事全体)と /articles/1(1番の記事)。あとは動詞で分けています。

Railsはこれを強制する

resources :articles と書くと、この形の7つが自動で作られます。

GET       /articles            index      一覧
GET       /articles/new        new        作成フォーム
POST      /articles            create     作成
GET       /articles/:id        show       詳細
GET       /articles/:id/edit   edit       編集フォーム
PATCH     /articles/:id        update     更新
DELETE    /articles/:id        destroy    削除

7つ以外は用意されません。 自由にURLを設計する余地が、そもそも無いということです。

ここで「不便では?」と思うかもしれませんが、Railsはあえてそうしています。

なぜ揃えるのか

Railsには The Rails Doctrine という、設計思想をまとめた文書があります。9つの柱が挙げられていて、その2番目が「設定より規約(Convention over Configuration)」です。

そこで言われているのは、「何度も繰り返す決定を避ける」ということです。主キーの名前をどうするか、URLをどう設計するかといった判断を毎回やっていると、本当に考えるべきことに時間を使えません。

もうひとつ、「メニューはおまかせ(omakase)」という柱もあります。店主が決めたコースを出す寿司屋のようなもので、客が一品ずつ選ぶのではなく、良いと分かっている組み合わせを出す、という考え方です。

URL設計も同じ扱いです。「あなたの好きに決めてよい」ではなく「これで行きます」と決めてしまう。

結果として、どのRailsアプリを見ても /articles/1 が1番の記事を指しているという状態になります。初めて見るコードでも、ルーティングを読まずに構造が推測できる。これは他人のコードを読むとき、かなり効きます。

RESTに収まらないとき

とはいえ、CRUDだけで表せない操作は出てきます。「記事を公開する」などです。

Railsには追加する仕組みがあります。

resources :articles do
  member do
    post :publish     # POST /articles/:id/publish
  end

  collection do
    get :search       # GET /articles/search
  end
end

member は特定の1件に対する操作(:id が入る)、collection は全体に対する操作(:id が入らない)です。

ただし、公式ガイドにはこう書かれています。

多数の追加アクションを定義する場合は、別リソースとして検討すべき

つまりアクションを足し続けるのは推奨されていません。 増えてきたら、それは別のリソースなのでは? と考え直す、という方針です。

「記事を公開する」なら、publish というアクションを足すのではなく、「公開状態」というリソースを作るという見方をします。

resources :articles do
  resource :publication, only: %i[create destroy]
end

こうすると「公開する」は POST /articles/1/publication、「非公開に戻す」は DELETE /articles/1/publication になります。また7つの枠の中に戻ってきました。

慣れるまで回りくどく感じますが、「動詞を足したくなったら、それはリソースかもしれない」と考えるのがRails流です。

ps: 学び始めのRestfulは、まじで意味不明だった

3件のコメント

コメントを残す

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です