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 來試試看效果.
