MongoDB 和 MongoMapper的示例用法简介
译者:夜鸣猪(http://hlee.javaeye.com/) 校对:哇牛(http://ywencn.javaeye.com/)
MongoDB是基于文档引擎的数据库,这和传统的
关系型数据库,例如MySQL很不一样,文档引擎的数据库没有schema的概念。本篇将主要通过创建一个Rails的应用来介绍使用MongoDB和MongoMapper gem(译者晓夜注:Rails的插件用来驱动Mongo让Rails更容易使用Mongo)。实际上,很多的Rails
程序员都是通过John Nunemaker的一篇博文RailsTips blog开始关注Mongo的。这是一篇相当精彩值得一读的文章,阐述了MongoMapper和MongoDB的七个主要功能并和传统的数据库做了对比,推荐阅读。
值得一提的是博文中的一个功能,也是前文提到的MongoDB没有schema的概念(译者晓夜注:Rails中使用rake db:migrate来控制数据库的结构一致和升级等。原文所说schema-less,是说没有一个schema_info的表来维护用来migrate的数据库
版本。)。这样的
数据库设计的有点在于,从数据库本身层面解决了schema的问题,不用在Rails中使用migrate操作了。因为在文档引擎的数据库中,每一行都是一个独立的文档类型,可以有自己的一组不同于其他记录的属性。这样的设计在
分布式数据库中也会有独到的好处。
安装MongoDB and MongoMapper
在创建MongoDB的应用之前,要先安装。MongoDB的不同操作系统版都可以从MongoDB的官网下载界面得到。如果你使用的是苹果的系统,Chris Kampmeier的这篇文章,对于安装和配置MongoDB会很有价值,并且附带一份方便的plist文件用来帮助创建LaunchDemon,这样MongoDB就可以
开机启动了。值得注意的是该文针对的MongoDB的版本,当前版本为1.2.0 。通过访问http://localhost:28017/可以验证是否成功安装和配置MongoDB。
使用MongoDB创建Rails应用
在MongoDB正确安装和运行后,我们将创建一个叫做todo的Rails应用来演示如何使用
rails todo
鉴于我们将要使用MongoMapper来驱动MongoDB到Rails。我们需要在/config/environment.rb的配置文件中添加如下:
#/config/environment.rb
config.gem "mongo_mapper"
在Rails的initializer文件中MongoDB需要一些额外的配置。在/config/initializers文件目录下创建mongo_config.rb文件,并在该文件中添加如下语句,用来配置MongoMapper将使用的数据库名。
#/config/initializers/mongo_config.rb
MongoMapper.database = "todo-#{Rails.env}"
由上可知,通过指定Rails运行环境参数,我们可以在不同的运行环境下创建互不干扰的数据库。然而,如果我们希望移植当前应用到生产环境,我们还需要进行包括验证在内的其他工作,当然,对于我们当前的演示现在的配置已经足够了。然后,运行如下语句,保证MongoMapper的gem已经安装:
sudo rake gems:install
开发相关应用
演示的应用是todo list,实现类似备忘或者待完成任务列表的功能。项目中有一个Project的model和一个Tasks的model,
他们有
has_
many的关系,为了简化开发,突出mongoDB的使用,我们将使用Ryan Bates的Nifty Generators插件来实现。当然,不使用这个插件,我们的项目应用完全可以正常演示。
首先,我们需要通过如下语句创建项目的layout。
script/generate nifty_layout
然后,我们将通过generate和nifty的scaffold创建
project的model,这个表只有一个字段叫name,而且,使用mongoDB(译者晓夜
注释:没有sechma的概念,也就是不需要一个migrate来控制版本),我们需要这个加上参数--skip-migration来创建如下:
当然,上面的脚手架会创建modelcontroller和view,然而,默认创建的是ActiveRecord的基于schema的model,如下:
#/app/models/project.rb
class Project < ActiveRecord::Base
attr_accessible :name
end
以上代码又脚手架生成。那么,我们需要把ActiveRecord的model,改成MongoMapper的类型,也就是把继承关系从ActiveRecord::Base变成MongoMapper::Document。我们使用key这个方法标明该MongoMapper的字段属性。我们的属性是name,再加上这个字段的类型String,那么定义如下:
#/app/models/project.rb
class Project
include MongoMapper::Document
key :name, String
end
通过以上的修改,我们就已经拥有了所有添加,更新,删除和列表的操作,这就和我们之前用脚手架创建,用ActiveRecord加上关系型数据库一样,只是我们使用的是MongoMapper和MongoDB。
也就是说对于添加,删除,列表和更新的操作,从Rails开发语句来看MongoMapper和ActiveRecord是完全相同的。甚至,MongoMapper还是支持ActiveRecord的验证方式如下:
#/app/models/project.rb
validates_presence_of :name
在我们的
例子中,不允许name字段为空的需要,在MongoMapper里也可以方便的如下语法表述:
#/app/models/project.rb
class Project
include MongoMapper::Document
key :name, String, :required => true
end
添加更多的属性
由于MongoDB没有schema-less(数据版本记录)我们可以非常容易的添加和更改model的属性,而不需要执行任何migrations的操作。比如,我们需要添加一个priority的属性,我们仅仅需要的是修改Project model如下:
#/app/models/project.rb
class Project
include MongoMapper::Document
key :name, String, :required => true
key :priority, Integer
end
如同ActiveRecord支持的一样,model的属性可以直接和form元素中关联。例如,新定义的priority可以显示在下拉菜单中如下:
#/app/views/projects/_form.html.erb
<% form_for @project do |f| %>
<%= f.error_messages %>
<p>
<%= f.label :name %><br />
<%= f.text_field :name %>
</p>
<p>
<%= f.label :priority %><br />
<%= f.select :priority, [1,2,3,4,5] %>
</p>
<p><%= f.submit "Submit" %></p>
<% end %>
在显示页面我们也需要做相应的修改以便显示该字段:
#/app/views/projects/show.html.erb
<% title "Project" %>
<p>
<strong>Name:</strong>
<%=h @project.name %>
</p>
<p>
<strong>Priority:</strong>
<%=h @project.priority %>
</p>
<p>
<%= link_to "Edit", edit_project_path(@project) %> |
<%= link_to "Destroy", @project, :confirm => 'Are you sure?', :method => :delete %> |
<%= link_to "View All", projects_path %>
</p>
这样,我们在创建新Project的时候,我们将会看到一个提示选择priority的下拉菜单,并且,提交创建以后,会得到一个包括priority显示的Project信息显示页面。
当然,如果我们在添加priority属性前创建了Project。那么,添加priority属性后,这个先前创建的project的priority是什么呢?我们可以通过访问看到是空白,也就是说,如果一条记录没有属性,那么对于MongoDB的文件类型存储引擎会默认是nil。
处理表之间的关联
在我们前文所述的
Todo项目需求描述中,我们还需要定义一个Task model,每个Project会对应多个Task。同样,我们将和创建Project一样,使用脚手架创建这个model。值得注意的是,project_id之前在ActiveRecord都是integer类型,在这里我们使用字符串类型的如下(晓夜:原因见下文):
script/generate nifty_scaffold task project_id:string name:string completed:boolean --skip-migration
如同,修改Project model一样,我们同样修改Task model指定继承MongoMapper如下:
#/app/models/Task.rb
class Task
include MongoMapper::Document
key :project_id, ObjectId
key :name, String
key :completed, Boolean
belongs_to :project
end
再一次如同Project model,我们将按照MongoMapper的语法修改字段定义。可能我们已经
习惯吧poject_id定义成整型,然而,对于MongoDB这里稍微有点区别,我们需要ObjectId类型来存储所有id。
至于,处理不同表之前的关联,我们可以像ActiveRecord一样定义belongs_to,当然,稍微有点不同,在Project中我们需要定义has_many :tasks,在MongoMapper中需要用many代替如下:
#/app/models/project.rb
class Project
include MongoMapper::Document
key :name, String, :required => true
key :priority, Integer
many :tasks
end
现在,我们就可以使用我们用脚手架创建的model controller和view来创建Task了,比较有技巧的一点是,我们开始的时候定义了project_id的属性是String所以,在这里的view界面中就会创建一个对应的文本输入框。然后,我们需要修改这个form表单的,以便我们可以使用下拉菜单选择对应的所属Project。对于,下拉菜单显示project列表,我们完全可以参照ActiveRecord的方式,使用collection_select来实现,如下:
#/app/views/tasks/_form.html.erb
<% form_for @task do |f| %>
<%= f.error_messages %>
<p>
<%= f.label :project_id %><br />
<%= f.collection_select :project_id, Project.all, :id, :name %>
</p>
<!-- Rest of form... -->
也就是,我们可以通过如下方式创建Task并选择所属Project。
当我们完成创建task后会默认跳到显示task的界面,我们会看到刚刚创建的所属project的id,当然我们更愿意看到Project的name。所以,需要用@task.project.name来代替@task.project_id如下:
#/app/views/tasks/show.html.erb
<% title "Task" %>
<p>
<strong>Project:</strong>
<%=h @task.project.name %>
</p>
<!-- Rest of form -->
这样,我们就可以使用ActiveRecord的模式来显示相关的model的信息了。(晓夜:也就是belong_to has_many的功能)
MongoDB的查询
我们将通过对于一些在控制台查询Mongo model技巧的介绍来结束本文。实际上,MongoMapper的查询和ActiveRecord很像。例如,当我们要查询所有projects的时候用如下:
>> Project.all
=> [#<Project name: "Yardwork", _id: 4b39d8c9a175750357000001, priority: nil>, #<Project name: "Housework", _id: 4b39fbd1a175750357000002, priority: 3>]
We can also find a project by its id…
我们也可以通过id来查询:
>> Project.find('4b39d8c9a175750357000001')
=> #<Project name: "Yardwork", _id: 4b39d8c9a175750357000001, priority: nil>
…or supply options to all to find records in a given order.
查询并按照name降序输出:
>> Project.all(:order => "name DESC")
=> [#<Project name: "Yardwork", _id: 4b39d8c9a175750357000001, priority: nil>, #<Project name: "Housework", _id: 4b39fbd1a175750357000002, priority: 3>]
如同,在ActiveRecord中的通过conditions的查询一样,MongoMapper也支持条件的查询,更容易的是,可以直接输入条件,例如选择所有,priority为3的project:
>> Project.all(:priority => 3)
=> [#<Project name: "Housework", _id: 4b39fbd1a175750357000002, priority: 3>]
那么,对于条件更为复杂的查询,由于,Mongo不是基于SQL的关系型数据库,所以也不能够通过类似传入SQL语句的方式进行查询。不过,MongoDB也有一套自己的
查询方式,MongoMapper良好而简洁的支持这种查询。例如,要查询projects中所有,priority大于或等于2的记录:
>> Project.all(:priority.gte => 2)
=> [#<Project name: "Housework", _id: 4b39fbd1a175750357000002, priority: 3>]
我们也可以通过以数组为参数的查询,例如,查询所有priority是2或者3的projects:
>> Project.all(:priority.in => [2,3])
=> [#<Project name: "Housework", _id: 4b39fbd1a175750357000002, priority: 3>]
当前而言,关于MongoMapper的复杂查询相关的文档还比较少,如果,
你需要更多更为详尽的资料,那么你应该去阅读github上MongoMapper的测试文档。
本文的介绍将到此为止,我们仅仅演示了MongoDB和MongoMapper的最基本的使用情况。如果,需要真正的使用,你应该进一步的深入了解相关的知识。你可以加入这个邮件列表,或者follow MongoDB的Twitter
现在已经是时候,问问自己到底选择MongoDB还是传统的关系型数据库了。当然,是不是采用MongoDB和MongoMapper的决定权在于你自己,然而,MongoDB却真的值得一试,这样你才能更知道他的好处。从更长远的角度来说,文件型引擎的数据库在Rails的应用上将会扮演越来越显著的角色。