php-resque使用說明

專案中經常會有後台運行任務的需求，例如發送郵件時，因為要連接郵件伺服器，往往需要5-10秒甚至更長時間，如果能先給用戶一個成功的提示訊息，然後在後台慢慢處理發送郵件的操作，顯然會有更好的使用者體驗。

為了實現類似的需求，Web專案中一般的實作方法是使用訊息佇列(Message Queue)，例如MemcacheQ，RabbitMQ等等，都是很著名的產品。

訊息佇列說白了就是一個最簡單的先進先出佇列，佇列的一個成員就是一段文字。正是因為訊息佇列太簡單了，當拿著訊息佇列時，反而有點無從下手的感覺，因為這僅僅一個發送郵件的任務，就會引申出很多問題：

1. 訊息佇列只能儲存字串類型的數據，如何將一個發送郵件這樣的“任務”，轉換為訊息佇列中的一個“訊息”?

2. ##訊息佇列只負責資料的存放與進出，本身不能執行任何程序，那麼我們要如何從訊息佇列中一個一個取出數據，再將這些資料轉換回任務並執行。

3. 我們無法預知訊息佇列何時會有資料產生，所以我們的任務執行程序還需要具備監控訊息佇列的能力，也就是一個常駐後台的守護程式。

4. 一般的Web應用PHP都以cgi方式運行，無法常駐記憶體。我們知道php還有cli模式，那麼守護程式是否能以php cli來實現，效率如何？

5. 當守護程式運行時，Web應用程式能否與後台守護程序交互，實現開啟/殺死程序的功能以及獲得程序的運行狀態？

Resque是這樣解決這些問題的：

後台任務的角色分割

其實是從上面的問題已經可以看出，只靠一個訊息隊列是無法解決所有問題的，需要新的角色介入。在Resque中，一個背景任務被抽象化為由三個角色共同完成：

• #Job | 任務： 一個Job就是一個需要在背景完成的任務，例如本文舉例的發送郵件，就可以抽象化為一個Job。在Resque中一個Job就是一個Class。

• Queue | 佇列 ： 也就是上文的訊息佇列，在Resque中，佇列則是由Redis實作的。 Resque也提供了一個簡單的佇列管理器，可以實現將Job插入/取出佇列等功能。

• Worker | 執行者 ： 負責從佇列中取出Job並執行，可以以守護程式的方式運行在背景。

那麼基於這個劃分，一個後台任務在Resque下的基本流程是這樣的：

1. 將一個後台任務寫成一個獨立的Class，這個Class就是一個Job。

2. 在需要使用後台程式的地方，系統將Job Class的名稱以及所需參數放入佇列。

3. 以命令列方式開啟一個Worker，並透過參數指定Worker所需要處理的佇列。

4. Worker作為守護程式運行，並且定時檢查佇列。

5. 當佇列中有Job時，Worker會取出Job並執行，即實例化Job Class並執行Class中的方法。

至此就可以完整的運行完一個後台任務。

在Resque中，還有一個很重要的設計：一個Worker，可以處理一個佇列，也可以處理很多個佇列，並且可以透過增加Worker的進程/執行緒數來加快佇列的執行速度。

php-resque的安裝

需要事先說明的是，由於涉及到進程的開啟與管理，php-resque使用了php的PCNTL函數，所以只能在Linux下運行，並且需要php編譯PCNTL函數。如果希望用Windows做同樣的工作，那麼可以去找找Resque的其他語言版本，php在Windows下非常不適合做後台任務。

以Ubuntu12.04LTS為例，Ubuntu用apt安裝的php已經預設編譯了PCNTL函數，無需任何配置，以下指令均為root帳號電腦訓練班

#安裝Redis

apt-get install redis-server

安裝Composer

apt-get install curl
cd /usr/local/bin
curl -s http://getcomposer.org/installer | php
chmod a+x composer.phar
alias composer='/usr/local/bin/composer.phar'

使用Composer安裝php-resque

假設web目錄在/opt/htdocs

apt-get install git git-core
cd /opt/htdocs
git clone git://github.com/chrisboulton/php-resque.git
cd php-resque
composer install

php-resque的使用

#寫一個Worker

其實php-resque已經給了簡單的例子， demo/job.php檔就是一個最簡單的Job：

class PHP_Job
{
    public function perform()
    {
        sleep(120);
        fwrite(STDOUT, 'Hello!');
    }
}

這個Job就是在120秒後向STDOUT輸出字元Hello!

在Resque的設計中，一個Job必須存在一個perform方法，Worker則會自動執行這個方法。

将Job插入队列

php-resque也给出了最简单的插入队列实现 demo/queue.php：

if(empty($argv[1])) {
    die('Specify the name of a job to add. e.g, php queue.php PHP_Job');
}

require __DIR__ . '/init.php';
date_default_timezone_set('GMT');
Resque::setBackend('127.0.0.1:6379');

$args = array(
    'time' => time(),
    'array' => array(
        'test' => 'test',
    ),
);

$jobId = Resque::enqueue('default', $argv[1], $args, true);
echo "Queued job ".$jobId."\n\n";

在这个例子中，queue.php需要以cli方式运行，将cli接收到的第一个参数作为Job名称，插入名为'default'的队列，同时向屏幕输出刚才插入队列的Job Id。在终端输入：

php demo/queue.php PHP_Job

结果可以看到屏幕上输出：

Queued job b1f01038e5e833d24b46271a0e31f6d6

即Job已经添加成功。注意这里的Job名称与我们编写的Job Class名称保持一致：PHP_Job

查看Job运行情况

php-resque同样提供了查看Job运行状态的例子，直接运行：

php demo/check_status.php b1f01038e5e833d24b46271a0e31f6d6

可以看到输出为：

Tracking status of b1f01038e5e833d24b46271a0e31f6d6. Press [break] to stop. 
Status of b1f01038e5e833d24b46271a0e31f6d6 is: 1

我们刚才创建的Job状态为1。在Resque中，一个Job有以下4种状态：

• Resque_Job_Status::STATUS_WAITING = 1; (等待)

• Resque_Job_Status::STATUS_RUNNING = 2; (正在执行)

• Resque_Job_Status::STATUS_FAILED = 3; (失败)

• Resque_Job_Status::STATUS_COMPLETE = 4; (结束)

因为没有Worker运行，所以刚才创建的Job还是等待状态。

运行Worker

这次我们直接编写demo/resque.php：

<?php
date_default_timezone_set('GMT');
require 'job.php';
require '../bin/resque';

可以看到一个Worker至少需要两部分：

1. 可以直接包含Job类文件，也可以使用php的自动加载机制，指定好Job Class所在路径并能实现自动加载

2. 包含Resque的默认Worker： bin/resque

在终端中运行：

QUEUE=default php demo/resque.php

前面的QUEUE部分是设置环境变量，我们指定当前的Worker只负责处理default队列。也可以使用

QUEUE=* php demo/resque.php

来处理所有队列。

运行后输出为

#!/usr/bin/env php
*** Starting worker

用ps指令检查一下：

ps aux | grep resque

可以看到有一个php的守护进程已经在运行了

1000      4607  0.0  0.1  74816 11612 pts/3    S+   14:52   0:00 php demo/resque.php

再使用之前的检查Job指令

php demo/check_status.php b1f01038e5e833d24b46271a0e31f6d6

2分钟后可以看到

Status of b1f01038e5e833d24b46271a0e31f6d6 is: 4

任务已经运行完毕，同时屏幕上应该可以看到输出的Hello!

至此我们已经成功的完成了一个最简单的Resque实例的全部演示，更复杂的情况以及遗留的问题会在下一次的日志中说明。

相关推荐：

利用redis和php-resque实现后台任务 redis 下载 redis 集群 redis可视化工具

php网站设计 php-resque的设计和使用

php-resque消息队列的执行情况

以上是php-resque使用說明的詳細內容。更多資訊請關注PHP中文網其他相關文章！