简介

sidekiq-cron 是sidekiq的时间表附件，在指定的时间调用job
每30s检查需要调度的新作业，当存在多个sidekiq work时不会重复调用相同的作业
https://github.com/ondrejbartas/sidekiq-cron

gem install

gem "sidekiq-cron", "~> 1.1"

依赖于sidekiq 和redis

在rails中项目使用

工作特性

# cron可以用“,”来表示多个同一级时间，如： 1 2,3 * * * 表示每天的凌晨2点1分 3点1分来进行作业
# cron 可以在 最后添加坐标来指定时区，如： 1 2,3 * * * China/Shanghai
# https://crontab.guru/
{
 'name'  => 'name_of_job',  #job名称， 必须不相同
 'cron'  => '1 * * * *',    # cron时间格式 分 时 天(月) 月 天(周)
 'class' => 'MyClass',      # Job的类
 #已下为可选
 'queue' => '',             #队列名称
 'args'  => '',             #Job的参数，hash或者数组，一般作为定时任务都是全量的，不需要参数
 'date_as_argument' => true,#添加执行时间作为执行方法的最后一个参数
 'active_job' => true,      # 
 'queue_name_prefix' => 'prefix',
 'queue_name_delimiter' => '.',
 'description' => ''        # 描述，为了后续维护尽量添加 
}

有两种对象可以被sidekiq-cron 调用

1. sidekiq worker

class HardWorker
  include Sidekiq::Worker
  def perform(*args)
    # do something
  end
end

2. ActiveJob

class RHardWorker < ActiveJob
    queue_as :default   #需要指定队列
    
    def perform(*args)
        #do something
    end
end

rails中一般使用ActiveJob

调用：

1. 直接create一个cron job, 指定具体的参数信息

每5分钟执行一次\

Sidekiq::Cron::Job.create(name: 'Every Five Mins', cron: '*/5 * * * *', class: 'HardWorker')

2. 从一个hash中加载配置

hash = {
  'this is a job' => {
    'class' => 'MyClass',
    'cron'  => '1 * * * *',   # 每小时的第一分钟执行
    'args'  => ''             # 还记得不 hash 或者array
  },
  'this is a job too' => {
    'class' => 'SecondClass',
    'cron'  => '*/5 * * * *'  # */5 表示每5分钟一次
   }
}

Sidekiq::Cron::Job.load_from_hash hash

3. 从数组中加载配置

array = [
  {
    'name'  => 'this is a job',      #名称不可以重复
    'class' => 'MyClass',
    'cron'  => '1 * * * *',
    'args'  => ''
  },
  {
    'name'  => 'this is a job emmm',
    'class' => 'SecondClass',
    'cron'  => '*/5 * * * *'
  }
]

Sidekiq::Cron::Job.load_from_array array

4. 从YML文件中加载配置（推荐）

其实也是从hash加载，但是yml易于配置和维护
建议使用load_from_hash！，避免加载失败不抛出异常

# config/sidekiq_cron_test.yml
this_is_a_job: 
  cron:  "*/5 * * * *"
  class: "MyClass"
  queue:  default
  desc:  '每5分钟执行一次'

#initializers/sidekiq.rb
schedule_file = "config/sidekiq_cron_test.yml"

if File.exist?(schedule_file) && Sidekiq.server?
  Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
end

# YAML.load_file(schedule_file) 会将上面的内容转为hash，如： 
#    {
#        this_is_a_job: { 
#            cron: "*/5 * * * *", 
#            class: "Myclass",
#            queeu: default,
#            desc: "每5分钟执行一次"
#        }
#    }

查找

Sidekiq::Cron::Job.all
Sidekiq::Cron::Job.find 'name'
Sidekiq::Cron::Job.find name: 'name'

删除

Sidekiq::Cron::Job.destroy_all!
Sidekiq::Cron::Job.find('name').destroy
Sidekiq::Cron::Job.destroy 'name'

处理定时job

job = Sidekiq::Cron::Job.find 'name'
job.disable!   # 禁止job被调度
job.enable!    # 允许job被调度
job.status     # disable/enable
job.enque!     # 立即调用（执行）

总结

sidekiq-cron 是rails项目中常用的定时任务调度，稳定可靠，依赖于redis和sidekiq，有UI页面去监控job，配置文件中name不可以重复，时间依赖于cron， 项目中配置常存在于yml文件中，根据不同的环境去调用不同的yml文件， 为了便于维护添加desc去描述定时任务的作用和时间信息