Sidekiq Scheduler 开源项目教程

1. 项目的目录结构及介绍

Sidekiq Scheduler 是一个用于 Sidekiq 的扩展，它允许你通过配置文件来调度 Sidekiq 作业。以下是项目的目录结构及其介绍：

sidekiq-scheduler/
├── bin/
│   └── sidekiq-scheduler       # 可执行文件
├── lib/
│   ├── sidekiq-scheduler/
│   │   ├── schedule.rb         # 调度配置
│   │   ├── job_presenter.rb    # 作业展示
│   │   ├── options_parser.rb   # 选项解析
│   │   ├── periodic_enqueuer.rb # 周期性任务
│   │   ├── redis_manager.rb    # Redis 管理
│   │   ├── schedule_manager.rb # 调度管理
│   │   ├── version.rb          # 版本信息
│   │   └── web/                # Web 界面
│   └── sidekiq-scheduler.rb    # 主文件
├── spec/                       # 测试目录
├── sidekiq-scheduler.gemspec   # Gem 规范
├── Gemfile                     # 依赖管理
├── Gemfile.lock                # 依赖锁定
├── README.md                   # 项目说明
└── LICENSE                     # 许可协议

目录结构说明

• bin/: 包含可执行文件。
• lib/: 包含项目的核心代码。
  • sidekiq-scheduler/: 主要逻辑文件。
  • web/: 提供 Web 界面。
• spec/: 包含测试文件。
• sidekiq-scheduler.gemspec: Gem 的规范文件。
• Gemfile 和 Gemfile.lock: 依赖管理文件。
• README.md: 项目说明文档。
• LICENSE: 许可协议文件。

2. 项目的启动文件介绍

Sidekiq Scheduler 的启动文件位于 bin/ 目录下，名为 sidekiq-scheduler。这个文件是一个可执行脚本，用于启动 Sidekiq Scheduler。

启动文件内容

#!/usr/bin/env ruby

require 'sidekiq-scheduler'
require 'sidekiq/cli'

Sidekiq.configure_server do |config|
  config.on(:startup) do
    Sidekiq.schedule = YAML.load_file(File.expand_path('../../config/sidekiq_scheduler.yml', __FILE__))
    SidekiqScheduler::Scheduler.instance.reload_schedule!
  end
end

Sidekiq::CLI.instance.run

启动文件说明

• 引入了 sidekiq-scheduler 和 sidekiq/cli 库。
• 配置 Sidekiq 服务器，加载调度配置文件 config/sidekiq_scheduler.yml。
• 启动 Sidekiq Scheduler。

3. 项目的配置文件介绍

Sidekiq Scheduler 的配置文件通常位于项目的 config/ 目录下，名为 sidekiq_scheduler.yml。这个文件定义了需要调度的作业及其调度规则。

配置文件示例

:schedule:
  update_stats:
    cron: '0 * * * *'
    class: 'UpdateStatsJob'
    queue: 'default'
  send_email:
    every: '1h'
    class: 'SendEmailJob'
    queue: 'low'

配置文件说明

• :schedule: 定义调度任务的根节点。
• update_stats: 定义一个名为 update_stats 的任务。
  • cron: 使用 cron 表达式定义调度规则。
  • class: 指定要执行的作业类。
  • queue: 指定作业队列。
• send_email: 定义一个名为 send_email 的任务。
  • every: 使用时间间隔定义调度规则。
  • class: 指定要执行的作业类。
  • queue: 指定作业队列。

通过以上配置，Sidekiq Scheduler 将按照定义的规则自动调度相应的作业。