Hello Rails
为确保一切都正常的安装和让我们更熟悉Rails,我们将创建一个简单的"Hello Rails" API. 这就像一个标准的"Hello Rails"应用程序,除了我们不会创建视图,但是API会返回表示"Hello Rails"字符的JSON数据.
从验证Ruby已经正确的安装开始:
$ ruby -v
ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]
$ rails --version
同样的,确保你的系统已经安装了SQL.大多数 *nix(类unix)系统已经预装了 SQLite;如果你使用的是 Windows,你可以查看 SQL 官网 的安装指导.这个命令:
$ sqlite3 --version
应该会返回已经安装的 SQLite 版本.
如果你是用 RVM 设置的环境,正好你已经安装了 Rails.如果不是,你可以用 RubyGems 提供给的 "gem install"来安装它:
$ gem install rails
为了验证一切都已经正确的安装,运行:
$ rails --version
Rails有一套叫做"generators"的脚本,被设计用来更好,更快的开发.这个新的应用生成器会创建一个新的应用开始正常工作的所有的必要的东西.使用这个生成器,在终端窗口中进入你的工作目录然后键入:
$ rails new hello_rails
Rails将会为你创建应用程序的框架,最后会用默认的Gemfile运行budle install.你可以看到一大串的create动作,Bundle会获取这些gem然后解决所有的依赖:
create
create README.rdoc
create Rakefile
create config.ru
create .gitignore
create Gemfile
create app
...
run bundle install
Fetching gem metadata from https://rubygems.org/..........
Fetching additional metadata from https://rubygems.org/..
Resolving dependencies...
Using rake (10.3.2)
...
Your bundle is complete!
Use `bundle show [gemname]` to see where a bundled gem is installed.
这一系列自动生成的文件和文件夹构成了这个Rails应用程序的结构:
-
app/
这个文件夹包含了应用的控制器,模型,视图,帮助类,邮件类,和资产. -
bin/
这个文件夹包含了启动脚本和其它用来部署和运行应用的脚本. -
config/
这个文件夹的文件是用来配置的,比如路由和数据库.在我们开始开发应用的各个方面的时候会满满的发掘其中的文件. -
config.ru
这个文件包含了Rack-based服务器用来启动应用的 Rack 的配置. -
db/
这个文件夹是用来存储当前数据库架构,当然还有数据库迁移. -
Gemfile
这个文件是用来指定Rails应用程序的gem依赖. -
Gemfile.lock
这是Bundler记录所有gem已安装的精确版本.当这同一个类/项目在其它机器上加载的时候,运行bundle install会查看"Gemfile.lock",然后安装同样准确的版本,而不仅仅是使用"Gemfile"然后安装最近的版本. -
lib/
这个文件夹包含了扩展类. -
log/
这个文件夹包含了应用程序的日志. -
public/
这个文件夹包含了静态文件和已经编译的资产. -
Rakefile
这个文件用来定位和载入能从命令行运行的任务.与改变"Rakefile"不同的是,你可以通过增加文件到应用的"lib/tasks"目录,来添加自定义的任务. -
README.rdoc
这是你的应用程序的简明指导手册.你应该编辑好这个文件,让别人了解你的应用是做什么,怎样设置它等. -
test/
这个文件夹包含了单元测试,夹具和其它的测试配置. 这部分在后面"测试RESTful服务". -
tmp/
这个文件夹包含了临时文件(比如缓存,PID,和session文件). vendor/-
vendor/
第三方代码会保留在这个文件夹内.典型的Rails应用中,它会包含gem.
现在我们想要检查这个新生成的应用是否能工作.那么,我们只需要启动Rails服务:
$ rails server
=> Booting WEBrick
=> Rails 4.0.4 application starting in development on
http://0.0.0.0:3000
=> Run `rails server -h` for more startup options
=> Ctrl-C to shutdown server
[2014-07-21 13:29:27] INFO WEBrick 1.3.1
[2014-07-21 13:29:27] INFO ruby 1.9.3 (2013-11-22)
[x86_64-darwin13.0.2]
[2014-07-21 13:29:27] INFO WEBrick::HTTPServer#start: pid=25171 port=3000
WEBrick 是Ruby发布的默认web服务器.想要看到你的应用,打开浏览器窗口然后跳转到 http://localhost:3000 ,你就可以看到应用生成最初的样子了.
现在就让Rails以JSON的格式来问好吧.这个想法是用一个终端写一个极其简单的API.当它被调用的时候它只会说"hello".
第一步是写一个简单的模型.它不需要被存储在数据库中;它只需要产生一个JSON格式的"hello"字符.在"app/models/"中创建一个叫"hello.rb"的文件.
我们将会定义一个"Hello"类和一个简单的 to_json 方法.这个方法会简单的返回一个JSON格式的字符串,"{"hello": "<text>!"}":
require 'json'
class Hello
def to_json(text)
return JSON.parse("{\"hello\": \"#{text}!\"}")
end
end
我们也会同时为我们的应用生成一个控制器,终端窗口键入:
$ rails generate controller say hello
这个命令会创建"say"的控制器和"hello"的方法:
create app/controllers/say_controller.rb
route get "say/hello"
invoke erb
create app/views/say
create app/views/say/hello.html.erb
invoke test_unit
create test/controllers/say_controller_test.rb
invoke helper
create app/helpers/say_helper.rb
invoke test_unit
create test/helpers/say_helper_test.rb
invoke assets
invoke coffee
create app/assets/javascripts/say.js.coffee
invoke scss
create app/assets/stylesheets/say.css.scss
注意,这里不只是创建控制器的文件-Rails也会创建相关的HTML,test,helper,JavaScript和CSS文件,来确保你的app框架是一个标准的配备.
当然,你不需要和使用它们也可以删掉这些文件.或者,如果你不想要Rails创建控制器的时候一并生产这些相关的文件,你可以在 "app/controllers/" 下新建一个 "say_controller.rb"文件.
使用你喜欢的编辑器,打开 "app/controllers/say_controller.rb"文件,然后修改成下面这样:
class SayController < ApplicationController
def hello
@hello = Hello.new
if params[:user]
render :json => @hello.to_json(params[:user])
else
render :json => @hello.to_json("Rails")
end
end
end
这里产生了一个只会响应"hello"信息的JSON格式.如果你给URL带上参数的话,它会回复"Hello <user>".
开启Rails 服务,可以在浏览器中通过访问 http://localhost:3000/say/hello.json?user=John 来试试看效果.
