PHP Resque 项目技术文档

1. 安装指南

环境要求

• PHP 5.3 及以上版本
• Redis 2.2 及以上版本
• 推荐使用 Composer 进行依赖管理

安装步骤

1. 通过 Composer 安装：

   • 在项目的 composer.json 文件中添加 php-resque 依赖：

     {
         "require": {
             "chrisboulton/php-resque": "1.2.x"
         }
     }
     

   • 运行 composer install 命令安装依赖。

2. 添加 Composer 自动加载：

   • 在项目的初始化文件中添加 Composer 自动加载：

     require 'vendor/autoload.php';
     

2. 项目的使用说明

队列任务

添加任务到队列

// 如果 Redis 不在本地，需要设置 Redis 地址
Resque::setBackend('localhost:6379');

$args = array(
    'name' => 'Chris'
);
Resque::enqueue('default', 'My_Job', $args);

定义任务

每个任务应该在一个单独的类中，并包含一个 perform 方法：

class My_Job
{
    public function perform()
    {
        // 执行任务
        echo $this->args['name'];
    }
}

删除任务

// 删除队列 'default' 中的 'My_Job' 任务
Resque::dequeue('default', ['My_Job']);

任务状态跟踪

$token = Resque::enqueue('default', 'My_Job', $args, true);
$status = new Resque_Job_Status($token);
echo $status->get(); // 输出任务状态

3. 项目API使用文档

任务队列 API

• Resque::enqueue(queue, job, args, trackStatus)：将任务添加到队列。
• Resque::dequeue(queue, jobs)：从队列中删除任务。
• Resque_Job_Status::get(token)：获取任务状态。

工作进程 API

• bin/resque：启动工作进程。
• QUEUE=file_serve php bin/resque：指定队列启动工作进程。
• COUNT=5 bin/resque：启动多个工作进程。

4. 项目安装方式

通过 Composer 安装

1. 在 composer.json 中添加依赖：

   {
       "require": {
           "chrisboulton/php-resque": "1.2.x"
       }
   }
   

2. 运行 composer install。
3. 在项目中引入 Composer 自动加载：

   require 'vendor/autoload.php';
   

手动安装

1. 下载 php-resque 源码。
2. 将源码放置在项目目录中。
3. 手动引入必要的文件。

通过以上步骤，您可以成功安装并使用 php-resque 项目。