Resque-Scheduler 技术文档

1. 安装指南

1.1 使用 Gem 安装

要安装 resque-scheduler，可以通过以下命令直接安装：

gem install resque-scheduler

1.2 使用 Gemfile 安装

如果你使用 Gemfile，可以在文件中添加以下内容：

gem 'resque-scheduler'

然后运行 bundle install 来安装依赖。

1.3 添加 Rake 任务

为了使用 resque-scheduler，你需要在项目中添加相应的 Rake 任务。可以在 Rakefile 或 lib/tasks/resque.rake 中添加以下内容：

require 'resque/scheduler/tasks'

2. 项目的使用说明

2.1 配置 Rake 任务

resque-scheduler 依赖于 resque:setup Rake 任务。你可以在 resque:setup 任务中配置 resque-scheduler 的相关设置：

require 'resque/tasks'
require 'resque/scheduler/tasks'

namespace :resque do
  task :setup do
    require 'resque'
    Resque.redis = 'localhost:6379'
  end

  task :setup_schedule => :setup do
    require 'resque-scheduler'
    Resque.schedule = YAML.load_file('your_resque_schedule.yml')
    require 'jobs'
  end

  task :scheduler => :setup_schedule
end

2.2 运行调度器

你可以通过以下命令运行调度器：

rake resque:scheduler

或者在加载环境后运行：

rake environment resque:scheduler

2.3 独立执行器

resque-scheduler 还提供了一个独立的执行器，可以通过以下命令运行：

resque-scheduler --help

3. 项目API使用文档

3.1 延迟任务

resque-scheduler 支持两种类型的任务调度：定时任务和延迟任务。

3.1.1 延迟任务示例

你可以使用 Resque.enqueue_in 或 Resque.enqueue_at 来创建延迟任务：

Resque.enqueue_in(5.days, SendFollowupEmail, argument)
# 或者
Resque.enqueue_at(5.days.from_now, SomeJob, argument)

3.1.2 取消延迟任务

如果你需要取消一个延迟任务，可以使用 Resque.remove_delayed：

Resque.remove_delayed(SendFollowUpEmail, :user_id => current_user.id)

3.1.3 更新延迟任务

你可以将已经延迟的任务进一步延迟：

Resque.delay_or_enqueue_at(2.minutes.from_now, SendNotifications, :user_id => current_user.id)

3.2 动态调度

resque-scheduler 支持动态调度，允许你在运行时更新调度计划。你可以通过设置 Resque::Scheduler.dynamic = true 来启用动态调度。

4. 项目安装方式

4.1 通过 Gem 安装

gem install resque-scheduler

4.2 通过 Gemfile 安装

在 Gemfile 中添加：

gem 'resque-scheduler'

然后运行 bundle install。

4.3 配置 Rake 任务

在 Rakefile 或 lib/tasks/resque.rake 中添加：

require 'resque/scheduler/tasks'

4.4 运行调度器

通过以下命令运行调度器：

rake resque:scheduler

或者：

rake environment resque:scheduler

通过以上步骤，你可以成功安装并使用 resque-scheduler 来管理定时和延迟任务。