前面 MVC 中德概念有提到 Restful Routes 設計很重要,今天就來簡單講一下基本的路徑 Routes 設定吧!

路徑設定位置

通常我們會在 config/routes.rb 的檔案裡面進行路徑的設定:

1
2
3
4
5
Rails.application.routes.draw do
get "/", to: "pages#index" #去首頁
get "/about", to: "pages#about" #去關於我們的頁面
# 動作 “路徑”, to: "controller#action"
end

一般設定就如上面這樣,會先指定動作,再來是要去的路徑,接著是對應的 controller,”#”後面是 controller 上面的 action。

用 resources 產生的 Routes

這邊可以感受到慣例優於設定的一個小地方,使用 Rails 提供的 resources 方法非常方便,可以自動產生出對應的 8 條路徑、7 種 action,可以應付一般 restful routes 設計

1
2
3
Rails.application.routes.draw do
resources :articles
end

可以開啟終端機輸入 rails routes -c articles
就會看到對應出來下面的這些路徑

1
2
3
4
5
6
7
8
9
10
$ rails routes -c articles
Prefix Verb URI Pattern Controller#Action
articles GET /articles(.:format) articles#index
POST /articles(.:format) articles#create
new_article GET /articles/new(.:format) articles#new
edit_article GET /articles/:id/edit(.:format) articles#edit
article GET /articles/:id(.:format) articles#show
PATCH /articles/:id(.:format) articles#update
PUT /articles/:id(.:format) articles#update
DELETE /articles/:id(.:format) articles#destroy

可以注意到我們這些路徑預設的 action 都是有意義的,一般來說會如下面的設計:

  • index => get,首頁或列表頁,通常會是呈現所有資料的頁面,以文章來說可能就像是部落格的文章列表,或是一些論壇的文章列表頁
  • create => post,為新增文章的位置,不會看到畫面,但是用 post 動作更新資料
  • new => get,為新增的表單頁面,填入跟文章相關的資料,按下送出就會觸發 create
  • edit => get,為編輯的表單頁面
  • show => get,為顯示文章內容的頁面
  • update => patch and put,為更新的位置,不會看到畫面,用 patch 或 put (對瀏覽器來說同樣為 post)
  • destroy => delete,為刪除文章的位置,同樣不看到畫面,用 delete 方法 (同樣為 post 的一種)

prefix 是?

後面可以接上 _path_url 後變成「相對應的路徑或網址」的 View Helper(幫忙 view 呈現資料的方法)。如果是站內連結,通常會使用 _path 寫法來產生站內的路徑,例如:

articles + path = articles_path => /articles
new_article + path = new_article_path => /articles/new
edit_article + path = edit_article_path(5) => /articles/5/edit

如果是使用 _url 則會產生完整的路徑,包括主機網域名稱:

articles + url = articles_url => http://sean_blog.com/articles
new_article + url = new_article_url => http://sean_blog.com/articles/new
edit_article + url = edit_article_url(5) => http://sean_blog.com/articles/5/edit

如果用不到那麼多種方法

假設我們只需要用到 index 跟 show 呢?
可以使用 onlyexcept ,only 是正向表示,表示內有的方法都要; except 反向表示除了提到的方法之外都要

1
2
3
4
Rails.application.routes.draw do
resources :articles, only:[:index, :show]
resources :articles, except:[:new, :create, :edit, :update, :destroy]
end

resource 用單數會?

如果用單數resource方法會產生沒有 id 的路徑,如果沒有要表示特定文章路徑就可以用這樣去產生,然後可以搭配 only 或 except 去選出那些路徑要用。

1
2
3
Rails.application.routes.draw do
resource :articles
end
1
2
3
4
5
6
7
8
9
$ rails routes -c articles
Prefix Verb URI Pattern Controller#Action
new_articles GET /articles/new(.:format) articles#new
edit_articles GET /articles/edit(.:format) articles#edit
articles GET /articles(.:format) articles#show
PATCH /articles(.:format) articles#update
PUT /articles(.:format) articles#update
DELETE /articles(.:format) articles#destroy
POST /articles(.:format) articles#create

下一篇再提供多一些關於路徑的設定部分給大家。


參考資料:

  1. 為你自己學 Ruby on Rails
  2. Rails Guide