ruby執行周期性任務

 

1.前言

     無論是用ruby做系統管理，還是用rails做web開發，都可能遇到周期性任務，它們按照一定時間周期（1小時，2天......）持續地觸發。在ruby中，我認為一次性任務使用 sidekiq來完成是非常方便的，而周期性的任務就需要用到 whenever， sidetiq， clockwork等等gem了。

2.whenever

    首先，whenever是基於linux的cron服務的，所以，在windows平台上沒有直接的方法使用該gem。whenever嚴格來說應該算一個cron的翻譯器，將ruby代碼翻譯為cron腳本，從而將周期性任務轉交給cron實際去完成。對於精通cron的shell程序員來說可能不值一提，但對rubyist卻不是。首先，我們可以使用ruby語言來書寫任務代碼，在ruby層面上控制代碼，避免了和一些shell腳本的切換；另外，cron命令很強大，但我總是記不住它的命令參數，為了避免一遍一遍去man它的手冊，還是ruby語法比較親民。

    首先，安裝whenever：

$ gem install whenever  

   然后切換到任務編寫文件夾project下，保證該文件夾下有一個config文件夾。如果是在rails項目中建立whenever任務，則config文件夾已經存在了。

$ cd /project  
$ wheneverize .  

    whenverize命令會在config文件夾下創建schedule.rb文件，我們的任務代碼需要在該文件中定義。下面的是schedule.rb文件示例：

every 30.minutes do
  runner "Blog.parseAll"
end

every 30.minutes, :at => 17 do
  runner "PostWeibo.post"
end

every 15.minutes do 
  runner "WeiBo.update"
end

every 30.minutes, :at => 20 do
  runner "RSSGenerator.generate"
end

every 1.day, :at => '2:00 am' do
  command "cd /var/www/mzread/current/public && gunzip -c sitemap1.xml.gz > sitemap1.xml && touch sitemap1.xml "
end

    如示例代碼，whenever默認定義了三種任務類型：runner, rake, command，我們也可以定義自己的任務，比如，下面的代碼定義了脫離rails環境，獨立執行ruby代碼的類型：

job_type :ruby, "cd :path && /usr/bin/ruby ':task'.rb"  
  
every :hour do  
  ruby 'have_a_rest'  
end  

   該示例描述了：每個小時會執行一次當前文件夾下的have_a_rest.rb腳本。

   下面看看怎么將任務寫入cron服務。  

$ whenever   #不帶參數的whenever會顯示轉換程cron任務的代碼，不寫入cron任務表  
$ whenever -w #寫入cron任務表，開始執行  
$ whenever -c #取消任務 

   如果要查看cron任務表，也可以使用linux的命令列出所有cron任務：

$ crontab -l  

3.sidetiq

       sidetiq是sidekiq的親兄弟，如果在rails項目中使用sidekiq來處理后台任務，那么就用sidetiq來交付周期性任務也顯得比較自然。

       安裝sidetiq：

$ [sudo] gem install sidetiq  

      定義周期性任務：

class MyWorker  
  include Sidekiq::Worker  
  include Sidetiq::Schedulable  
  
  recurrence { daily }  
  
  def perform  
    # do stuff ...  
  end  
end  

     sidetiq和sidekiq一樣，依賴於redis消息來處理消息。當rails項目啟動后，這些周期性任務會自動加載執行。

4.clockwork

    clockwork和sidetiq一樣，也不必依賴於cron，可以適應”跨平台“要求。下面是代碼示例(clock.rb)：

require 'clockwork'  
include Clockwork  
  
handler do |job|  
  puts "Running #{job}"  
end  
  
every(10.seconds, 'frequent.job')  
every(3.minutes, 'less.frequent.job')  
every(1.hour, 'hourly.job')  
  
every(1.day, 'midnight.job', :at => '00:00')  

    啟動任務：

$ clockwork clock.rb  
Starting clock for 4 events: [ frequent.job less.frequent.job hourly.job midnight.job ]  
Triggering frequent.job  

   如果要帶上rails環境，就在任務文件加入：

require './config/boot'  
require './config/environment'