Ruby中任務(wù)構(gòu)建工具rake的入門學(xué)習(xí)教程

Rake簡介

Rake的意思是Ruby Make,一個用ruby開發(fā)的代碼構(gòu)建工具.

但是,為什么Ruby需要Rake?

    按理說Ruby代碼無需編譯,應(yīng)該不需要Rake才對呀?原來,Rake另有妙用,即把Rake當(dāng)做一個任務(wù)管理工具來使用...這樣做有兩個好處:

1.以任務(wù)的方式創(chuàng)建和運行腳本

   當(dāng)然,你可以用腳本來創(chuàng)建每一個你希望自動運行的任務(wù).但是,對于大型的應(yīng)用來說,你幾乎總是需要為數(shù)據(jù)庫遷移(比如Rails中db:migrate任務(wù))、清空緩存、或者代碼維護(hù)等等編寫腳本.對于每一項任務(wù),你可能都需要寫若干腳本,這會讓你的管理變得復(fù)雜.那么,把它們用任務(wù)的方式整理到一起,會讓管理變得輕松很多.

2.追蹤和管理任務(wù)之間的依賴

Rake還提供了輕松管理任務(wù)之間依賴的方式.比如,"migrate"任務(wù)和"schema:dump"任務(wù)都依賴于 "connect_to_database"任務(wù),那么在"migrate"任務(wù)調(diào)用之前,"connect_to_database"任務(wù)都會被執(zhí)行.

下面入正題吧,即如何用Rake編寫一個任務(wù)腳本..

順序執(zhí)行

在Rake中定義任務(wù)后，可以指定任務(wù)的執(zhí)行順序，例如，每天早晨起床后的例行公事:
1. 關(guān)閉鬧鐘
2. 梳洗打扮
3. 泡杯咖啡
4. 遛狗
上面的幾項事物，在Rakefile中這樣描述

 task :turn_off_alarm do
  puts "Turned off alarm. Would have liked 5 more minutes, though."
 end

 task :groom_myself do
  puts "Brushed teeth."
  puts "Showered."
  puts "Shaved."
 end

 task :make_coffee do
  cups = ENV["COFFEE_CUPS"] || 2
  puts "Made #{cups} cups of coffee. Shakes are gone."
 end

 task :walk_dog do
  puts "Dog walked."
 end

 task :ready_for_the_day => [:turn_off_alarm, :groom_myself, :make_coffee, :walk_dog] do
  puts "Ready for the day!"
 end

通過rake ready_for_the_day來執(zhí)行任務(wù)，然后你就可以看到，所有的task都在按照你預(yù)定的順序在執(zhí)行。

 Turned off alarm. Would have liked 5 more minutes, though.
 Brushed teeth.
 Showered.
 Shaved.
 Made 5 cups of coffee. Shakes are gone.
 Dog walked.
 Ready for the day!

此外還可以用過rake make_coffee COFFEE_CUPS=5這樣在命令中給變量賦值。

命名空間

上面那樣定義任務(wù)沒有問題，但如果你需要另外定義些事物，比如工作相關(guān)的，交通相關(guān)的，這時候所有的任務(wù)混雜到一起顯然就不合適了，畢竟上面那些任務(wù)只是我們起床的例行事物，與其它無關(guān)。

通過namespace可以幫助我們定義出Rails中類似rake db:migrate的任務(wù)，描畫出事物間清晰的邊界，將上面的任務(wù)包括在namespace的一個代碼塊中，如下

 namespace :morning do
  task :turn_of_alarm
  ....
 end

這一次我們的調(diào)用命令就需要稍微做出些許變化，rake COFFEE_CUPS=3 morning:ready_for_the_day。 是不是跟rails中的rake任務(wù)調(diào)用方式很像呢？

默認(rèn)Task

有了上面那些設(shè)置，如果我們忘記或者不想寫詳細(xì)的任務(wù)名稱，直接執(zhí)行rake會有什么效果呢，結(jié)果是rake aborted!,任務(wù)被中斷的報錯。既然有這樣的可能性，我們就需要消除這些隱患，通過設(shè)置default默認(rèn)任務(wù)就可以做到，如下:

 task :default => 'morning:turn_off_alarm'

當(dāng)你直接執(zhí)行rake命令時，會執(zhí)行默認(rèn)操作，幫我們關(guān)閉鬧鐘。

描述你的Task

當(dāng)任務(wù)漸漸變多以后，管理問題就暴露出來了，除了命名空間以外，我們還需要文檔類的支持，幫助我們梳理任務(wù)并顯示的告訴我們每個任務(wù)的目的和功能，這時你可以試一試用desc描述任務(wù)。

 ...
 desc "Make coffee"
 task :make_coffee do
  cups = ENV["COFFEE_CUPS"] || 2
  puts "Made #{cups} cups of coffee. Shakes are gone."
 end
 ...

上面的描述不僅可以在文檔中查看，同時使用rake -T也能清洗的了解到每個任務(wù)是做什么的。rake -T的輸出結(jié)果是按照字母順序排的序。

 rake morning:make_coffee    # Make coffee

調(diào)取Task

Rake還允許在不同任務(wù)之間互相調(diào)用，例如下面的代碼,你想在下午也來杯咖啡，不用重復(fù)定義，直接使用上午的泡法，來一杯即可。

namespace :afternoon do
  task :make_coffee do
   Rake::Task['morning:make_coffee'].invoke
   puts "Ready for the rest of the day!"
  end
 end

Rake腳本編寫

先來個簡單的例子,如下:

假設(shè)你是一個火星成員,老版本那些,即如燕兒虎跑之類的,在周末你打算去車車那邊打火鍋,然后集體PC去.對應(yīng)這個情況,你需要為自己制定三個任務(wù):搭車找車車、烤魚和網(wǎng)吧PC.用vim創(chuàng)建創(chuàng)建一個名叫rakefile的文件(備注:Rake會在當(dāng)前路徑下尋找名叫Rakefile、rakefile、RakeFile.rb和rakefile.rb的rake文件),并鍵入如下代碼:

desc "任務(wù)1 -- 搭車去車車那里"#這據(jù)說是個苦差,因為太遠(yuǎn)了 
task :busboy do 
puts "發(fā)現(xiàn)挫男" 
end 
 
desc "任務(wù)2 -- 烤魚" 
task :bitchfish do 
puts "老板,先烤九斤魚" 
end 
 
desc "任務(wù)3 -- 網(wǎng)吧PC" 
task :pc do 
puts "我選中路" 
end 

打開命令行工具,進(jìn)入這個文件所在目錄,然后運行下面的命令,大致應(yīng)該類似如下結(jié)果:

D:\work>rake busboy 
(in D:/work) 
發(fā)現(xiàn)挫男 
 
D:\work>rake bitchfish 
(in D:/work) 
老板,先烤九斤魚 
 
D:\work\ruby_works\ruby_book>rake laundry 
(in D:/work) 
我選中路 

(備注:文字部分是沒啥邏輯的,純粹娛樂下...)

分析：

相信看完上面那段東東,你已經(jīng)知道怎么搞了...現(xiàn)在介紹些基礎(chǔ)知識,方便加深理解.從上面的代碼可以知道,此文件一共定義了3個任務(wù),desc是Rake定義的方法,表示對下面定義任務(wù)的描述.這個描述會在使用Rake --tasks(或者Rake -T)命令時輸出在屏幕上.

D:\work>rake --tasks 
(in D:/work) 
rake bitchfish #任務(wù)2 -- 烤魚 
rake busboy #任務(wù)1 -- 搭車去車車那里(這據(jù)說是個苦差,因為太遠(yuǎn)了) 
rake pc 任務(wù)3 -- 網(wǎng)吧PC 

task是Rake最重要的方法.它的方法定義是:task(args, block).任務(wù)體是一個block,本例中只是簡單輸出你所要做的工作.需要注意的是代碼

puts "發(fā)現(xiàn)挫男" 

完全是一個普通的Ruby語句,puts是Ruby中進(jìn)行輸出的一般性方法,可以看出,Rake任務(wù)可以完全使用Ruby的能力,這使得它非常強(qiáng)大.

go..go..go..go..

接下來加入依賴關(guān)系：

很顯然,在我們定義的任務(wù)中,"烤魚"是依賴于"搭車去車車那里"的(其它地方有沒烤魚吃不知道,反正地點就定在那了).那么,我們需要在我們的任務(wù)定義中加入這個依賴關(guān)系,修改后的文件如下:

desc "任務(wù)1 -- 搭車去車車那里" 
task :busboy do 
puts "發(fā)現(xiàn)挫男" 
end 
 
desc "任務(wù)2 -- 烤魚" 
task :bitchfish => :busboy do 
puts "老板,先烤九斤魚" 
end 
 
desc "任務(wù)3 -- 網(wǎng)吧PC" 
task :pc do 
puts "我選中路" 
end 

再次運行烤魚任務(wù),你會得到如下結(jié)果:

D:\work>rake bitchfish 
(in D:/work) 
發(fā)現(xiàn)挫男 
老板,先烤九斤魚 

加入命名空間：

跟任何編程語言類似,當(dāng)你的rake文件很多時,當(dāng)你有很多任務(wù)的時候,你需要關(guān)注它們的命名沖突問題,命名空間(namespace)就是一個自然的解決方案.你可以為上面的三個任務(wù)定義一個叫做dan的命名空間.

namespace :dan do 
desc "任務(wù)1 -- 搭車去車車那里" 
task :busboy do 
puts "發(fā)現(xiàn)挫男" 
end 
…… 
end 

再次運行rake --tasks,你會得到如下的結(jié)果:

D:\work >rake --tasks 
(in D:/work) 
rake dan:bitchfish # 任務(wù)2 -- 烤魚 
rake dan:pc # 任務(wù)3 -- 網(wǎng)吧PC 
rake dan:busboy # 任務(wù)1 -- 搭車去車車那里 

你現(xiàn)在需要使用rake dan:bitchfish才能啟動烤魚這個任務(wù)了.
(BTW,你可以在你的rakefile中使用多個命名空間,對任務(wù)進(jìn)行分類.)

了解了上面兩個知識點后,我們來了解下兩個具體實例:

1.在一個任務(wù)中調(diào)用另外一個任務(wù)

當(dāng)任務(wù)眾多的時候,你很可能需要在一個任務(wù)中調(diào)用另外一個任務(wù),假設(shè)我們把今天所有要做的工作定義為一個任務(wù):today.在這個任務(wù)中,有兩個任務(wù)需要被調(diào)用,一個是烤魚,一個是網(wǎng)吧PC.當(dāng)然,由于烤魚依賴于搭車去車車那里,我們還是需要搭車去車車那里的.在文件的頂部定義一個today的任務(wù):

desc "今天的任務(wù)" 
task :today do 
Rake::Task["dan:bitchfish"].invoke 
Rake::Task["dan:pc"].invoke 
end 
 
namespace :dan do 
…… 
end 

可以看出,調(diào)用其它任務(wù)的方式很簡單,只需要調(diào)用

Rake::Task["task_name"].invoke 

方法就可以了.在命令行中啟動rake today,可以得到:

D:\work >rake today 
(in D:/work) 
發(fā)現(xiàn)挫男 
老板,先烤九斤魚 
我選中路 

2.默認(rèn)任務(wù)：

可以為Rake增加一個默認(rèn)任務(wù),這樣可以簡單地用Rake命令來觸發(fā)這個默認(rèn)任務(wù),在上面的rakefile中,我們可以用如下方式把"today"任務(wù)作為默認(rèn)任務(wù).

task :default => [:today] 

然后調(diào)用直接在命令行中調(diào)用rake,可以得到跟調(diào)用rake today同樣的輸出結(jié)果.

這就是我們簡單的一個Rake任務(wù)定義,下面是完整的修改后的rakefile:

task :default => [:today] 
 
desc "今天的任務(wù)" 
task :today do 
 Rake::Task["dan:bitchfish"].invoke 
 Rake::Task["dan:pc"].invoke 
end 
 
namesoace :dan do 
 desc "任務(wù)1 -- 搭車去車車那里(這據(jù)說是個苦差,因為太遠(yuǎn)了)" 
 task :busboy do 
  puts "發(fā)現(xiàn)挫男" 
 end 
 
 desc "任務(wù)2 -- 烤魚" 
 task :bitchfish do 
  puts "老板,先烤九斤魚" 
 end 
 
 desc "任務(wù)3 -- 網(wǎng)吧PC" 
 task :pc do 
  puts "我選中路" 
 end 
end 

看完上面兩個例子,估計rake任務(wù)就算全部了解了...其它都是些代碼槍花罷了..多耍便是..