Rails Gem开发(二)——whenever实现周期性任务

根据项目的进展,我们需要实现后台进行定时读取信息的功能,而最关键的实现部分是周期性功能,根据调研,决定使用whenever来实现这一功能。
github:https://github.com/javan/whenever

开发前需要明确的问题

  • whenever是怎样一种周期性机制?
  • whenever能为我们提供什么功能?
  • whenever为周期性任务提供了哪些控制方式?

问题解决

whenever周期性机制

我们来看一下github上面是怎么说的:

Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.

意思就是说,whenever是一个ruby gem,但同时它是基于cron jobs的。
那么什么是cron jobs呢?我们来看一下维基百科的定义:

Cron
crontab命令常见于Unix类Unix操作系统之中,用于设置周期性被执行的指令。该命令从标准输入设备读取指令,并将其存放于“crontab”文件中,以供之后读取和执行。该词来源于希腊语chronos(χρόνος),原意是时间。
通常,crontab储存的指令被守护进程激活,crond常常在后台运行,每一分钟检查是否有预定的作业需要执行。这类作业一般称为cron jobs

也就是说,crontab是在unix和类unix系统中用来实现周期性功能的指令。在网上搜一下,我们就会看到很多crontab指令相关的语法。
根据上述的分析,我们可以得出这样的结论:
whenever事实上是一个cron翻译器,它将rails中的ruby代码翻译成cron脚本,从而将周期性的任务交给cron来执行。 这样,通过whenever我们可以使用ruby语言来写周期性任务代码,在ruby层控制代码,而不需要与shell脚本进行切换;另一方面,我们会发现,由于cron命令的强大,它的语法也因此变得很复杂,通过whenever,我们可以很方便的实现周期性任务。

whenever功能

从github中我们可以看到,我们用来实现定时功能的代码都已经集成在config/schedule.rb文件中了,以下为github中的whenever实例:

every 3.hours do 
# 1.minute 1.day 1.week 1.month 1.year is also supported 
runner "MyModel.some_process" 
rake "my:rake:task" 
command "/usr/bin/my_great_command"
end

every 1.day, :at => '4:30 am' do 
runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
end

every :hour do 
# Many shortcuts available: :hour, :day, :month, :year, :reboot 
runner "SomeModel.ladeeda"
end

every :sunday, :at => '12pm' do 
# Use any day of the week or :weekend, :weekday 
runner "Task.do_something_great"
end

every '0 0 27-31 * *' do 
command "echo 'you can use raw cron syntax too'"
end

# run this task only on servers with the :app role in Capistrano
# see Capistrano roles section below
every :day, :at => '12:20am', :roles => [:app] do 
rake "app_server:task"
end

从上述实例中,我们可以看到whenever为我们提供的三种方法,runnerrakecommand,事实上,还有script方法也是whenever默认支持的。除了这四种方法外,wheneverr也提供自定义方法的功能,具体做法参照github上的方法来做即可。

whenever控制方法

whenever是十分亲民的,它的指令没有cron命令那么复杂。下面提供几种whenever比较常用的方法:

whenever (不带参数)将schedule.rb 文件中的周期性任务转化成cron命令显示出来,但不读取或者写入到crontab文件中
whenever -i [identifier] 更新新定时任务,默认更新 schedule.rb 文件中的全部
whenever -w, --write-crontab, --update-crontab, [identifier] 写定时任务,默认更新 schedule.rb 文件中的全部
whenever -c, --clear-crontab [identifier] 清除 crontab 

除此之外,cron命令也是可以是用的,比较常用的是:

crontab -l [UserName]: 列出目前的时程表
crontab -e [UserName]: 执行文字编辑器(第一次由自己选择编辑器)来配置crontab的具体执行方法

一个十分简单的whenever demo

1.添加whenever(Gemfile)

gem 'whenever', :require => false

2.生成config/schedule.rb文件
执行命令:

wheneverize

3.添加自己的周期性任务
config/schedule.rb文件中添加:

set :environment, :development
every 2.minutes do  
runner "Timetest.mytime"  
end

其中,set :environment, :development是设置执行任务时的环境,默认情况下环境为production
上述代码实现的是每两分钟读取当前时间并存入到数据库的功能。其中,runner方法执行的方法如下:

class Timetest < ApplicationRecord  
    def self.mytime    
      a = Timetest.new    
      a.time_now = Time.now    
      a.save  
    end
end

这样,在rails中实现whenever的代码就算是写完了,真的是简单到不行啊!(实在忍不住感慨一句)
下面就要执行周期性任务了。

4.执行周期性任务
在rails工程文件夹下进行一下操作

  • 更新schedule.rb中的任务到cronjob中
whenever -i

可以看到这样的打印结果:

[write] crontab file updated
  • 执行周期性任务
whenever -w

可以看到:

[write] crontab file written

此时我们的周期性任务便在后台运行了,此时查看我们的任务:

crontab -l

可以看到以下打印:

# Begin Whenever generated tasks for: /home/vito/rails/test_of_rails/test_rails/config/schedule.rb
0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58 * * * * /bin/bash -l -c 'cd /home/vito/rails/test_of_rails/test_rails && bundle exec bin/rails runner -e development '\''Timetest.mytime'\'''
# End Whenever generated tasks for: /home/vito/rails/test_of_rails/test_rails/config/schedule.rb

这样,我们的周期性任务就算是在顺利执行了。

需要注意的一点是运行时crontab的环境(rails和crontab环境不匹配时whenever无法执行),一般调试时多使用的是development环境,而不设置时默认的是production环境,如果你使用crontab -l发现是production环境,可以使用

crontab -e

直接修改为development,或者直接将-e production删掉即可。

经过上述流程,我们便可以成功地实现周期性任务了。如果此时你发现自己的周期性任务还是没有执行,那你就得好好看看你自己的任务代码了,很可能是执行的任务代码本身有问题,而与whenever的实现没有太大的关系了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,179评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,229评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,032评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,533评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,531评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,539评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,916评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,813评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,568评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,654评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,354评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,937评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,918评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,152评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,852评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,378评论 2 342

推荐阅读更多精彩内容

  • Whenever利用的是crontab,所以系统要支持crontab才可以使用它,它有清析的语法,可以和部署工具进...
    limx阅读 2,308评论 0 0
  • Linux定时任务Crontab命令详解 linux 系统则是由 cron (crond) 这个系统服务来控制的。...
    孙燕超阅读 1,815评论 0 4
  • 一、什么是crontab crontab 命令常见于Unix 和 类Unix的操作系统中,用于设置周期性被执行的指...
    AQ王浩阅读 1,204评论 0 4
  • linux 系统则是由 cron (crond) 这个系统服务来控制的。Linux 系统上面原本就有非常多的计划性...
    苏大发阅读 657评论 0 0
  • 简介:Crontab命令常见于Unix和类Unix的操作系统之中,用于设置周期性被执行的指令。本课程通过对Cron...
    Amisuer阅读 4,605评论 0 1