rails 入门详细笔记(官网翻译).doc

-再拾Rails的时候发现已经到3.0.3了, 巨大的改变发现找篇中文教程都找不到，于是索性根据官方教程一边学一边翻译，就当学习笔记。水平有限，不足此处敬请谅解。1. 环境搭建 Ruby1.8.7+ （那么由于187p248，249的bug可能会导致Rails3崩溃，官方建议使用1.9.2的Ruby版本） RubyGems SQLITE3数据库 （那么这个数据库是Rails内置支持的，我们也可以使用其他数据库，比如MySql5.5）安装：1, 安装ruby192, 地址：/2, 安装rails3, $ gem install rails3, 安装IDE, 个人比较喜欢Aptana3,2. Rails的指导原则和理念 DRY(Dont Repeat Yourself) - 保持代码清晰高效，这个一直是我喜欢rails的原因之一 约定大于配置 - rails假定你想要做什么以及准备如何做，而不是把任何事情都放到配置文件中去。比如我们说好数据库表的名称应该是模型类名称的小写的复数形式。那么rails会自动把该数据表与其模型类进行关联。 REST是WEB应用的最佳模式 - 用resources以及标准的HTTP动作来组织你的应用。3.创建你的第一个应用大多数的第一个应用要么是购物车要么就是博客, 我们也不能免俗. 我们将要在下面的内容中打造一个博客，也就是rails经常吹嘘的10分钟打造的博客系统(事实上用不了十分钟)$ rails new blog这将使rails为你创建一个blog工程 (rails -h可以查看rails命令的帮助)$ cd blog我们转到blog目录内。那么在任何情况下，Rails会在你的工作路径内为你创建一个blog的文件夹。本教程的大多数工作都会在app文件夹内操作，这里有一个Rails默认创建应用时创建的文件夹以及文件说明：文件/文件夹说明Gemfile该文件允许你指定你程序所需要的gem (比如你用到了mysql数据库, 你需要在这里指定 gem mysql).README你的应用程序大体说明. 用这个来告诉他人该程序是干什么的, 等等.Rakefile该文件包含了一系列可以在终端运行的命令.app/包含了应用程序的控制器，模型，以及视图. 在本教程中你将专注于该文件夹.config/配置你应用程序的运行时规格，路由，数据库等等.config.ru基于服务器的Rack配置，用于启动程序.db/显示你当前数据库的模式，以及数据库迁移.doc/你应用的详细文档.lib/你应用的扩展模块.log/日志.public/唯一可以被访问的文件夹. 你可以保存你的图像，javascript, 样式表(CSS), 以及其他静态文本.script/包含启动你程序的rails脚本，并可以放置其他你用来部署或者运行你程序的脚本.test/单元测试，夹具以及其他测试tmp/临时文件vendor/放置第三方代码的地方. 在一个典型的rails应用中, 这将包括ruby gems, rails源代码 (如果你拷贝到你的应用中的话), 以及包含额外功能的插件.接下来我们安装需要的gems$ bundle install（事实上绑定的gems都定义在gemfile中）配置数据库连接：config/database.yml, 默认情况下是连接到SQLite3的, 如果你在使用SQLite3，保持默认就可以了, 如果是MySql，需要改为：development: adapter: mysql encoding: utf8 database: blog_development pool: 5 username: root password: root接下来创建数据库。$ rake db:create该rake命令会根据你的数据库配置自动为你创建数据库万事俱备，只欠服务器了$ rails s（新的script命令变化很大, 现在只需要输入 rails option args 就可以了）默认情况下 rails 将启动 Webrick 服务器, 赶快打开你的浏览器在地址栏输入 http:/localhost:3000/ 查看你的第一个rails程序 吧 ：）-1. Hello Rails接下来我们要输出一个所有语言的都要学习的 hello world。要在rails应用中输出一个hello rails，你需要创建一个控制器以及一个视图。在rails的世界里，你几乎不用手动的一个个去创建各个控制器与视图，rails命令就可以帮忙我们搞定一切。$ rails g controller home indexrails将根据命令为你创建多个文件，其他包括 app/views/home/index.html.erb, 这是一个用于显示index动作结果的模板，打开该文件，写入以下代码:Hello, Rails现在你已经完成了了控制器与视图。在这里，我们需要在访问 localhost:3000 的时候就显示hello rails，首先我们需要删除 public/index.html$ rm public/index.html然后你需要告诉rails你实际的首页在什么位置。打开 config/routes.rb, 该文件是你应用程序的路由设置，它用指定的DSL（domain-specific language）来保存条目，来告诉rails如何把进来的请求转发到相应的控制器以及动作。该文件包含了许多路由器样例，其他一个就是如何指定控制器和动作来访问根地址。找到以 root 开头的行，改为如下：现在你可以在 http:/localhost:3000 中看到Hello Rails了2. 使用脚手架快速搭建网页rails的脚手架可以快速生成应用程序的一些片段，如果你需要为一个资源创建一系列的控制器视图模型，那么脚手架就是你需要的工具3. 创建资源对于一个博客程序，你可以以生成一个Post资源脚手架开始：$ rails g scaffold post name:string title:string content:text该命令将为你构建15个文件：文件说明db/migrate/20101122214725_create_posts.rb创建posts表的迁移任务 (你的文件名称将包括一个不同的时间戳)app/models/post.rbPost 模型test/fixtures/posts.yml用于测试的posts夹具app/controllers/posts_controller.rbPosts控制器app/views/posts/index.html.erbposts的首页视图app/views/posts/edit.html.erbposts的编辑视图app/views/posts/show.html.erb显示单个post的视图app/views/posts/new.html.erb创建post的视图app/views/posts/_form.html.erb用于编辑与新建post的局部表单模板app/helpers/posts_helper.rbpost视图的帮助器test/unit/post_test.rbpost模型的单元测试工具test/functional/posts_controller_test.rbposts控制器的功能测试工具test/unit/helpers/posts_helper_test.rbposts帮助器的单元测试工具config/routes.rb为posts添加路由信息public/stylesheets/scaffold.css脚手架的默认CSSrails generate scaffold 命令产生的其中一个文件就是数据库迁移文件，Migration 是设计用来方便创建和修改数据库的Ruby类。rails使用rake任务来运行迁移。而且 Migration 可以撤销先前应用到数据库内的迁移操作。我们现在来看一下所生成的迁移文件（记住：迁移任务的文件名永远是唯一的）：上面的迁移创建了2个方法，up 是在你迁移进数据库时调用的，而down是你撤销迁移时用到的。up 命令创建了一个posts表以及2个string列，1个text列，同时它也为表自动创建了2个时间戳列，created_at, update_at 用于记录的创建与更新。下面我们运行数据库迁移任务：$ rake db:migraterails 将执行迁移并告诉你它已经为你创建了posts表4. 添加超链接下面我们将在首页添加一个到posts的超链接：link_to 方法是rails的内置视图帮助器的功能之一，它根据参数创建一段超链接代码现在你可以在浏览器内完成你博客的文章输入了。打开 http:/localhost:3000 点击超链接：rails将转到posts控制器的index动作，现在数据库里还没人任何记录，点击 New post 你可以转到新建post视图然后创建一条记录。之后你会发现你可以编辑，查看，以及删除该记录，而这么多功能只是用了一个 rails generate scaffold 命令来完成的。注意：在development模式下（默认）rails会在每次请求时重新加载你的代码，所以你不必要在每次修改后重启你的服务器。5. 模型打开模型文件 app/models/post.rb，你会发现里面只是一个空的类：实际上远远不是如此，Post类继承了ActiveRecord:Base类，Active Record为你的rails提供了大量的功能，包括基本的数据库CRUD操作，验证操作，复杂的搜索支持以及模型之间的各种关联。下面我们为post模型添加一些验证：这些改动确保了了所有的posts都必须具有name与title属性，并且title必须包含至少5个字符。要查看动作的验证，你可以使用控制台。控制台可以根据你的上下文环境执行ruby代码：$ rails c (rails console)控制台加载完成后， 你可以操作你的模型irb(main):001:0 p = Post.new(:content = a new post)= #irb(main):002:0 p.save= falseirb(main):003:0 p.errors= :name=cant be blank, :title=cant be blank, is too short (minimum is 5 characters)irb(main):004:0该代码显示了创建一个post实例，然后试图保存但是返回了false(也就是保存失败), 然后查看下发生的错误当你结束控制台，输入exit然后回车就可以了。注意：与 development 服务器不同，控制台不会自动重载你的代码。所以当你的模型类发生改变时，输入 reload! 来重载代码。1. 列出所有Posts要开始查看功能的最简单的地方应该是列举所有记录的代码了。现在我们打开 app/controllers/post_controller.rb, 看到 index 方法def index posts = Post.all respond_to do |format| format.html # index.html.erb format.xml render :xml = posts endend实际上在这里有2个地方与rails2不同了，第一是查询的方式，以前我们可能会这样写posts = Post.find(:all)，那么现在这种方式完全改变了，现在多出了一个重要的类 ActivaRecord:Relation 在里面分装了大量的数据库相关的操作。第二呢，我们不用写成上面的这种代码了： respond_to :html,:js,:xmldef index posts = Post.all respond_with postsend这样很容易解释，相应的格式请求使用相应的模板，比如我们访问 http:/localhost:3000/posts.xml 那么我们会得到一个xml格式的posts, 是不是很REST? 这里我们加了一个:js, 这为后面教程中使用ujs做下铺垫，那么具体的用法我们会在后面教程中给大家一一说明。Rails把所有该动作中的实例变量传递给相应的视图，这里是 app/views/posts/index.html.erb ：Listing posts Name Title Content Are you sure?, :method = :delete % 该视图遍历posts数组来显示内容以及链接，一些要注意的地方： link_to 绑定了特定的记录操作 edit_post_path 与 new_post_path 实际上在你设定 routes.rb 中相关resources的时候就已经给你生成的帮助器（好像一共有7个），你可以在控制器中看到不同的这种帮助器。这里还有一点值得注意：在先前版本的rails中你可能需要使用 来实现HTML转义，那么在3.0中，默认就已经是转义的了，如果你需要获得未转义的HTML，你需要这样写 (raw我想大家很容易理解, java中也经常有这种警告) 2. 自定义布局当rails渲染视图给浏览器时，它会把视图放置到布局内然后在输出。在先前的rails版本中，rails g scaffold 命令会自动创建控制器指定的布局，比如 app/views/layouts/posts.html.erb, 那么在3.0中 app/views/layouts/application.html.erb 作用与所有控制器。打开你的编辑器，把该布局修改如下： Blog 现在你刷新你的页面你会发现背景变成了灰色。3. 创建新的Post创建一个新的Post将调用两个动作，第一个是new，它将初始化一个Post对象。def new post = Post.new respond_with postend（同样我们在这里改为更简单的方式, 是不是很DRY？）在 new.html.erb 视图中显示一个空的Post给用户：New post是我们第一次介绍Rails的局部模板。局部模板实际上也是一个视图文件，只是该文件可以被多个视图重复引用。在这种情况下，form可用于创建，更新post，然后我们可以看到 app/views/posts/_form.html.erb: prohibited this post from being saved: 局部模板可以同样接受视图的实例变量，当然也可以接受视图传递过来的变量。这里有一个另一种写法。首先我们先稍微了解一下局部视图。 局部视图都以 下划线(_)开头 局部视图本事存在一个变量可以传递到局部视图里面，该变量是 去掉下划线，比如我的局部视图是 _form.erb, 那么在局部里面有存在一个 form 的变量, 当然还可以设定其他变量或者集合，这些我们将在后面的教程中详细学习。现在，我们有一个 post 变量, 那么我们可以把 render 改为 , rails很聪明，那么我们在局部视图中就会存在一个 post 变量，所以在局部视图中 把所有post改为post，最后我们还要把 _form.html.erb 改为 _post.html.erb. 大家可以试一下，当然其实在本教程中完全没有必要，我这样说只是在为后面的教程做铺垫，这样大家就会更容易明白。那么关于局部视图的用法我们会在后面的内容中详细的介绍。我们现在再来看下 form_for， form_for 用于根据模型对象生成表单。比如 f.text_field :name 会告诉rails生成一个文本输入框，并且保存模型的name属性。（实际上生成的是 ）实际上 form_for 方法知道你是new还是edit，然后对提交按钮设置相应的value，（比如在这里new里面是create post, edit里面是update post） 如果你需要创建与模型无关的表单，可以使用 form_tag 方法当用户点击 Create Post 按钮时，浏览器将会把表单信息提交给create方法（RAILS知道调用create方法，因为这是POST提交的）：def create post = Post.new(params:post) if post.save respond_with post, :notice = Post was successfully created. else render :action = new endendcreate方法根据传递的post参数初始化了一个post对象，保存成功以后放回用户请求的相应格式。然后把用户重定向到show页面并且设置一条成功创建的信息反馈给用户。 如果post由于验证失败等原因未能成功保存，那么控制器将把用户返回到new页面，并显示相应的错误信息1. 显示一条Post当你在index页面点击一条文章的链接时，它将指向一条类似 http:/localhost:3000/posts/1 的地址。Rails是把它作为show动作资源来解释的，然后传递 1 作为 :id 的参数。下面是 show 动作：def show post = Post.find(params:id) respond_with postendshow方法通过传入id值使用 Post.find 来搜索数据库中的单条记录，记录找到之后，Rails使用 show.html.erb 视图进行渲染： Name: Title: Content: |2. 编辑Posts和创建Post一样，编辑post也是一个两部分处理。第一步请求 edit_post_path(post) , 该方法将调用控制器中的 edit 动作：def edit post = Post.find(params:id)end找到请求的记录之后，Rails使用 edit.html.erb 视图显示出来：Editing post |和 new 动作一样，Rails使用相同的 _form.erb 局部模板，不过这次，该表单将使用 PUT 方式到 PostsController, 而且提交按钮将显示为 “Update Post”。注意这里的 实际上是 。提交由该视图创建的表单将调用 update 动作：def update post = Post.find(params:id) if post.update_attributes(params:post) respond_with post, :notice = Post was successfully updated. else render :action = edit endend在update方法中，首先rails使用:id参数获取数据库中相应的post记录，然后使用 update_attributes 来更新表单中的内容到数据库中。如果更新成功，转到 show 页面，如果更新失败，那么重新回到 edit 页面。 3. 删除一条Post最后，点击一条post的删除链接将请求destroy动作。def destroy post = Post.find(params:id) post.destroy respond_with postenddestroy方法将从数据库中移除相应的记录，然后浏览器将跳转到 index 页面。1. 添加第二个模型在前面的教程中，我们已经学会的使用脚手架快速搭建一个简单的应用，毕竟脚手架不能做任何事情，现在我们需要在应用中添加第二个模型了。模型在rails中使用单数形式，而其相关的数据库将使用复数名称。那么对于一个博客来说，评论总是少不了的，我们现在就要创建一个 Comment 模型。对于大多数的 rails 程序员来说，一般都是通过rails的生成器来生成模型，在这里我们也一样：$ rails g model comment commenter:string body:text post:references该命令将创建4个文件： app/models/comment.rb 模型 db/migrate/20101128142329_create_comments.rb 迁移文件 test/unit/comment_test.rb and test/fixtures/comments.yml 测试文件.首先，我们看一下 comment.rbclass Comment ActiveRecord:Base belongs_to :postend 初看之下，你可能会觉得它与post模型很相识，不同之处在于它多了一行 belongs_to 声明，而这将会建立它与post模型之间的关联, 那么在后面的教程中我们将详细学习。同时，Rails还生成了迁移文件来创建相应的表：class CreateComments ActiveRecord:Migration def self.up create_table :comments do |t| t.string :commenter t.text :body t.references :post t.timestamps end end def self.down drop_table :comments endend 与之前的rails版本不同，这里多了一个 t.references 定义。t.references :post 将建立一个posts表的外键 post_id, 值得注意的是这里的 :post 指的模型而不是表，这点一定要搞清楚。现在运行迁移操作把：$ rake db:migrate2. 关联模型Active Record的关联让你很容易的声明模型之间的关系。对于Posts和Comments, 很明显是一对多的关系。前面rails已经为我们声明了 belongs_to 关系，现在我们需要再声明一个 has_many 关系, 打开 post.rb 然后添加下面一行：class Post true validates :title, :presence = true, :length = :minimum = 5 has_many :commentsend现在双方都已经建立起一系列的关系，打个比方，假如你有一个实例变量 post 包含一条 post，那么你可以使用 ments 来检索所有该 post 中的 comment。3. 为comments添加路由和home控制器一样，我们需要添加一条路由，这样rails可以知道哪里可以看到评论。再次打开 routes.rb 你可以看到上