Ruby on Rails命名約定概念詳解
Ruby on Rails是如何進(jìn)行自動(dòng)命名的呢?在這里,我們將會(huì)了解到一些關(guān)于Ruby on Rails命名約定的實(shí)現(xiàn)技巧,希望對(duì)大家有所幫助。#t#
1. 混合大小寫,下劃線,復(fù)數(shù)
我們經(jīng)常使用簡(jiǎn)寫命名變量,在Ruby中,約定為命名變量時(shí),全部字母都小寫,單詞的中間使用下劃線分割,類(Class)和Modules的命名有不同,不使用下劃線,單詞的簡(jiǎn)寫和首字母使用大寫。所以我們?cè)谇懊婢帉懙拇a里有order_status和LineItem這樣的類名。
Ruby on Rails命名約定并且作了擴(kuò)展。首先假定數(shù)據(jù)庫(kù)中表名和變量命名一樣,采用全小寫字母,并且單詞中間使用下劃線分割,并且表明都是復(fù)數(shù)形式的,例如:orders,third_parties。同時(shí),Rails假定文件的命名也使用小寫和下劃線。
Rails根據(jù)這些約定自動(dòng)進(jìn)行名字的轉(zhuǎn)換,例如,你的程序里或許包含一個(gè)Model類來操作line item,你可以使用Rails的命名約定,把這個(gè)類命名為L(zhǎng)ineItem,根據(jù)這個(gè)名字,Rails會(huì)作下面的推斷:
數(shù)據(jù)庫(kù)里的表名為line_items。
在app/models目錄下有一個(gè)line_item.rb文件。
Rails的控制器(Controller)的命名有另外的約定,如果你的程序里有一個(gè)store的Controller,Rails會(huì)作下面的推斷:
有一個(gè)類叫做StoreController,并且在app/controllers目錄下有一個(gè)store_controller.rb文件。
在app/helpers目錄中,有一個(gè)文件叫做store_helpers,里面的類名叫做StoreHelper。
在控制器對(duì)應(yīng)的目錄app/views/store來查找視圖模板。
獲得視圖的輸出,并且把他們轉(zhuǎn)換到app/views/layouts目錄下的store.rhtml或者store.rxml的布局模板中。
通常在ruby的代碼中,我們使用require關(guān)鍵字來將一些文件中的類引入到當(dāng)前的代碼中,因?yàn)镽ails知道文件名和類名之間的關(guān)系,所以require關(guān)鍵字在Rails程序中不是必須的,在你引用一個(gè)不知道名字的類或者module的時(shí)候,Ruby on Rails命名約定將類名轉(zhuǎn)換成文件名,并且加載這個(gè)文件,效果就象你通過名字引用一個(gè)model,然后這個(gè)model自動(dòng)被加載到程序中。
就象你所看到的,這個(gè)模式在類被存儲(chǔ)到session中時(shí)被打破了,在這種情況下我們要明確的聲明他們,例如,我們?cè)诳刂破鳎╟ontroller)里:
- class StoreController
< ApplicationController- model :line_item
在這里,命名規(guī)約還在使用,標(biāo)記:line_item全部小寫并且用下劃線分開,這會(huì)使line_item.rb文件被加載,而這個(gè)文件中包含有類LineItem。
2. 把控制器(controller)分組到模塊中
現(xiàn)在,我們的所有的controller都放在app/controller目錄下,有時(shí)候我們的controller可能比較多,為了不污染到頂層的命名空間(namespace),我們可以選擇將某幾個(gè)controller歸組到一個(gè)單獨(dú)的命名空間里。
對(duì)此,Rails有一個(gè)簡(jiǎn)單的約定,如果一個(gè)請(qǐng)求(request)包括了controller的名字,例如:admin/book,Rails會(huì)在app/controller/admin/目錄下尋找名為book_controller的控制器,控制器名字的最后部分將會(huì)變換成name_controller.rb,并且將會(huì)從app/controller目錄開始,根據(jù)請(qǐng)求的前半部分(這里是admin)來定位到子目錄里。
想像一下我們的程序有這樣的兩組controller,admin/xxx,content/xxx,并且兩組里面都有一個(gè)控制器book,這樣在app/controller目錄的兩個(gè)子目錄app/controller/admin和app/controller/content里都有一個(gè)book_controller.rb文件,里面又都有類BookController,如果Rails不作額外處理,將會(huì)造成沖突。
為了處理這種情況,Rails采取的辦法是,在這兩組controller的目錄里的book_controller.rb文件中類的聲明前添加控制器所在組的名字,例如,admin目錄里的book_controller.rb文件中的類聲明是這樣:
- class Admin::BookController
< ApplicationController- # ...
- end
而content目錄下的類聲明是這樣:
- class Content::BookController
< ApplicationController- # ...
- end
這樣,兩個(gè)book_controller就可以被區(qū)分開了。
在web瀏覽器里對(duì)controller發(fā)出請(qǐng)求時(shí),這樣:
http://my.app/admin/book
在使用Rails的命令行生成controller的時(shí)候,直接在類名前加上組的名字就可以了,例如:
myapp> ruby script/generate controller Admin::Book action1 action2 ...
OK,Ruby on Rails命名約定就為大家介紹到這里吧。