Resque-Status 技术文档

1. 安装指南

环境要求

• Redis >= 1.1（推荐使用最新稳定版）
• 安装 Redis：可以从 Redis 官网 下载，或使用 homebrew 安装（执行 brew install redis 命令）。

安装 resque-status

• 使用 gem 命令安装 resque-status：

  gem install resque-status
  

• 对于较新版本的 Rails 项目，在 Gemfile 中添加以下代码：

  # Gemfile
  gem 'resque-status'
  

• 在项目初始化文件中配置 Redis 连接：

  # config/initializers/resque.rb
  Resque.redis = "your/redis/socket" # 默认为 localhost:6379
  Resque::Plugins::Status::Hash.expire_in = (24 * 60 * 60) # 24小时
  

2. 项目使用说明

resque-status 是 resque 队列系统的扩展，提供了一种跟踪特定作业实例及其状态的方法。

创建作业

使用 resque-status 时，需要通过 Resque::Plugins::Status 模块创建作业。以下是一个示例作业：

class SleepJob
  include Resque::Plugins::Status

  def perform
    total = (options['length'] || 1000).to_i
    total.times do |i|
      num = i + 1
      at(num, total, "At #{num} of #{total}")
      sleep(1)
    end
  end
end

队列作业

• 使用 create 类方法队列作业，此方法会为作业创建一个唯一标识符（UUID）：

  job_id = SleepJob.create(length: 100)
  

获取作业状态

• 通过作业的 UUID 获取作业状态：

  status = Resque::Plugins::Status::Hash.get(job_id)
  

• status 对象提供了多种方法来获取作业的详细信息，如：

  status.pct_complete #=> 完成百分比
  status.status #=> 作业状态
  status.queued? #=> 作业是否在队列中
  status.working? #=> 作业是否正在执行
  status.time #=> 作业时间
  status.message #=> 作业消息
  

更新作业状态

• 在作业的 perform 方法中使用 at 或 tick 方法更新作业进度：

  at(steps_completed, total_steps, "#{steps_completed} of #{total_steps} steps completed!")
  

杀死作业

• 通过 UUID 杀死特定作业：

  Resque::Plugins::Status::Hash.kill(job_id)
  

设置作业消息

• 使用 at 或 tick 方法设置作业进度和消息：

  at(steps_completed, total_steps, "#{steps_completed} of #{total_steps} steps completed!")
  

设置作业过期时间

• 可以设置作业状态在最后一次更新后多少秒过期：

  Resque::Plugins::Status::Hash.expire_in = (60 * 60) # 1小时
  

3. 项目 API 使用文档

resque-status 的 API 文档可以在 这里 查阅。

4. 项目安装方式

请参考“安装指南”部分的内容进行项目安装。