Ruby on rails開發從頭來(windows)(三十三)- 命名約定

meteorlwj發表於2010-04-29

1.       混合大小寫,下劃線,複數

我們經常使用簡寫命名變數,在Ruby中,約定為命名變數時,全部字母都小寫,單詞的中間使用下劃線分割,類(Class)Modules的命名有不同,不使用下劃線,單詞的簡寫和首字母使用大寫。所以我們在前面編寫的程式碼裡有order_statusLineItem這樣的類名。

Rails使用這樣的命名約定並且作了擴充套件。首先假定資料庫中表名和變數命名一樣,採用全小寫字母,並且單詞中間使用下劃線分割,並且表明都是複數形式的,例如:ordersthird_parties。同時,Rails假定檔案的命名也使用小寫和下劃線。

Rails根據這些約定自動進行名字的轉換,例如,你的程式裡或許包含一個Model類來操作line item,你可以使用Rails的命名約定,把這個類命名為LineItem,根據這個名字,Rails會作下面的推斷:

l         資料庫裡的表名為line_items

l         app/models目錄下有一個line_item.rb檔案。

Rails的控制器(Controller)的命名有另外的約定,如果你的程式裡有一個storeControllerRails會作下面的推斷:

l         有一個類叫做StoreController,並且在app/controllers目錄下有一個store_controller.rb檔案。

l         app/helpers目錄中,有一個檔案叫做store_helpers,裡面的類名叫做StoreHelper

l         在控制器對應的目錄app/views/store來查詢檢視模板。

l         獲得檢視的輸出,並且把他們轉換到app/views/layouts目錄下的store.rhtml或者store.rxml的佈局模板中。

 

通常在ruby的程式碼中,我們使用require關鍵字來將一些檔案中的類引入到當前的程式碼中,因為Rails知道檔名和類名之間的關係,所以require關鍵字在Rails程式中不是必須的,在你引用一個不知道名字的類或者module的時候,Rails將根據命名約定將類名轉換成檔名,並且載入這個檔案,效果就象你通過名字引用一個model,然後這個model自動被載入到程式中。   

就象你所看到的,這個模式在類被儲存到session中時被打破了,在這種情況下我們要明確的宣告他們,例如,我們在控制器(controller)裡:

class StoreController < ApplicationController

model :line_item

在這裡,命名規約還在使用,標記:line_item全部小寫並且用下劃線分開,這會使line_item.rb檔案被載入,而這個檔案中包含有類LineItem

2.       把控制器(controller)分組到模組中

現在,我們的所有的controller都放在app/controller目錄下,有時候我們的controller可能比較多,為了不汙染到頂層的名稱空間(namespace,我們可以選擇將某幾個controller歸組到一個單獨的名稱空間裡。

對此,Rails有一個簡單的約定,如果一個請求(request)包括了controller的名字,例如:admin/bookRails會在app/controller/admin/目錄下尋找名為book_controller的控制器,控制器名字的最後部分將會變換成name_controller.rb,並且將會從app/controller目錄開始,根據請求的前半部分(這裡是admin)來定位到子目錄裡。

想像一下我們的程式有這樣的兩組controlleradmin/xxxcontent/xxx,並且兩組裡面都有一個控制器book,這樣在app/controller目錄的兩個子目錄app/controller/adminapp/controller/content裡都有一個book_controller.rb檔案,裡面又都有類BookController,如果Rails不作額外處理,將會造成衝突。

為了處理這種情況,Rails採取的辦法是,在這兩組controller的目錄裡的book_controller.rb檔案中類的宣告前新增控制器所在組的名字,例如,admin目錄裡的book_controller.rb檔案中的類宣告是這樣:

class Admin::BookController < ApplicationController

# ...

end

content目錄下的類宣告是這樣:

class Content::BookController < ApplicationController

# ...

end

這樣,兩個book_controller就可以被區分開了。

web瀏覽器裡對controller發出請求時,這樣:
http://my.app/admin/book

在使用Rails的命令列生成controller的時候,直接在類名前加上組的名字就可以了,例如:

myapp> ruby script/generate controller Admin::Book action1 action2 ...

本文轉自:http://www.cnblogs.com/dahuzizyd/archive/2008/01/10/ruby_rails_instantrails_study_33.html

相關文章