Ruby教程(三十三)- 命名约定

来源:岁月联盟 编辑:zhu 时间:2009-01-10

  在刚开始学习Rails的时候可能会困惑于Rails时怎样自动处理命名的,比如如何根据一个名为Person的Model来到数据库中找到名为people的表,这次我们就来看看Rails里的命名约定。

  1.    混合大小写,下划线,复数

  我们经常使用简写命名变量,在Ruby中,约定为命名变量时,全部字母都小写,单词的中间使用下划线分割,类(Class)和Modules的命名有不同,不使用下划线,单词的简写和首字母使用大写。所以我们在前面编写的代码里有order_status和LineItem这样的类名。

  Rails使用这样的命名约定并且作了扩展。首先假定数据库中表名和变量命名一样,采用全小写字母,并且单词中间使用下划线分割,并且表明都是复数形式的,例如:orders,third_parties。同时,Rails假定文件的命名也使用小写和下划线。

  Rails根据这些约定自动进行名字的转换,例如,你的程序里或许包含一个Model类来操作line item,你可以使用Rails的命名约定,把这个类命名为LineItem,根据这个名字,Rails会作下面的推断:

  l     数据库里的表名为line_items。

  l     在app/models目录下有一个line_item.rb文件。

  Rails的控制器(Controller)的命名有另外的约定,如果你的程序里有一个store的Controller,Rails会作下面的推断:

  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/book,Rails会在app/controller/admin/目录下寻找名为book_controller的控制器,控制器名字的最后部分将会变换成name_controller.rb,并且将会从app/controller目录开始,根据请求的前半部分(这里是admin)来定位到子目录里。

  想像一下我们的程序有这样的两组controller,admin/xxx,content/xxx,并且两组里面都有一个控制器book,这样在app/controller目录的两个子目录app/controller/admin和app/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 ...

  OK,这次就到这里吧。