PHP的轻量消息队列php-resque
消息队列处理后台任务带来的问题
项目中经常会有后台运行任务的需求，比如发送邮件时，因为要连接邮件服务器，往往需要5-10秒甚至更长时间，如果能先给用户一个成功的提示信息，然后在后台慢慢处理发送邮件的操作，显然会有更好的用户体验。
为了实现类似的需求，Web项目中一般的实现方法是使用消息队列(Message Queue)，比如MemcacheQ，RabbitMQ等等，都是很著名的产品。
消息队列说白了就是一个最简单的先进先出队列，队列的一个成员就是一段文本。正是因为消息队列实在太简单了，当拿着消息队列时，反而有点无从下手的感觉，因为这仅仅一个发送邮件的任务，就会引申出很多问题：
消息队列只能存储字符串类型的数据，如何将一个发送邮件这样的“任务”，转换为消息队列中的一个“消息”?
消息队列只负责数据的存放与进出，本身不能执行任何程序，那么我们要如何从消息队列中一个一个取出数据，再将这些数据转化回任务并执行。
我们无法预知消息队列何时会有数据产生，所以我们的任务执行程序还需要具备监控消息队列的能力，也就是一个常驻后台的守护进程。
一般的Web应用PHP都以cgi方式运行，无法常驻内存。我们知道php还有cli模式，那么守护进程是否能以php cli来实现，效率如何？
当守护进程运行时，Web应用能否与后台守护进程交互，实现开启/杀死进程的功能以及获得进程的运行状态？
Resque对后台任务的设计与角色划分
对以上这些问题，目前为止我能找到的最好答案，并不是来自php，而是来自Ruby的项目Resque，正是由于Resque清晰简单的解决了后台任务带来的一系列问题，Resque的设计也被Clone到Python、php、NodeJs等语言：比如Python下的pyres以及PHP下的php-resque等等，这里有各种语言版本的Resque实现，而在本篇日志里，我们当然要以PHP版本为例来说明如何用php-resque运行一个后台任务，可能一些细节方面会与Ruby版有出入，但是本文中以php版为准。
Resque是这样解决这些问题的：
后台任务的角色划分
其实从上面的问题已经可以看出，只靠一个消息队列是无法解决所有问题的，需要新的角色介入。在Resque中，一个后台任务被抽象为由三种角色共同完成：
Job | 任务 ：
一个Job就是一个需要在后台完成的任务，比如本文举例的发送邮件，就可以抽象为一个Job。在Resque中一个Job就是一个Class。Queue | 队列 ：
也就是上文的消息队列，在Resque中，队列则是由Redis实现的。Resque还提供了一个简单的队列管理器，可以实现将Job插入/取出队列等功能。Worker | 执行者 ： 负责从队列中取出Job并执行，可以以守护进程的方式运行在后台。
那么基于这个划分，一个后台任务在Resque下的基本流程是这样的：
将一个后台任务编写为一个独立的Class，这个Class就是一个Job。
在需要使用后台程序的地方，系统将Job Class的名称以及所需参数放入队列。
以命令行方式开启一个Worker，并通过参数指定Worker所需要处理的队列。
Worker作为守护进程运行，并且定时检查队列。
当队列中有Job时，Worker取出Job并运行，即实例化Job Class并执行Class中的方法。
至此就可以完整的运行完一个后台任务。
在Resque中，还有一个很重要的设计：一个Worker，可以处理一个队列，也可以处理很多个队列，并且可以通过增加Worker的进程/线程数来加快队列的执行速度。
php-resque的安装
需要提前说明的是，由于涉及到进程的开辟与管理，php-resque使用了php的PCNTL函数，所以只能在Linux下运行，并且需要php编译PCNTL函数。如果希望用Windows做同样的工作，那么可以去找找Resque的其他语言版本，php在Windows下非常不适合做后台任务。
以Ubuntu14.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');//如果有密码，则设置为Resque::setBackend('redis://user:yourPasswd@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';
//如果不是默认的，则需要加入右边这段代码,否则会提示连接错误Resque::setBackend('redis://user:yourPassword@127.0.0.1:8421');
require '../bin/resque';
可以看到一个Worker至少需要两部分：
可以直接包含Job类文件，也可以使用php的自动加载机制，指定好Job Class所在路径并能实现自动加载
包含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实例的全部演示。
下面分享下我是如何将resque成功应用到项目邮件发送订单提醒中的。
1.准备。
PHPMailer是一个强大的发送邮件的库，下载PHPMailer,到php-resque根目录。下载地址为
https://github.com/PHPMailer/PHPMailer
下载好后，直接进入examples文件夹，然后打开mail.phps，里面是一个简单的使用例子，后面我会贴出我的代码。
2.添加job。
将resque导入thinkphp（我用的是5.0）的vendor文件中。
然后创建一个event事件，以便以后需要的时候，直接引入即可，提高代码重用性。
在生成订单的方法中，实例调用job事件，并添加job。
3.编写job。
<?php
class Order_Info
{
public function perform()
{
require 'PHPMailer/PHPMailerAutoload.php';
$mail = new PHPMailer; // Enable verbose debug output
$mail->isSMTP(); // Set mailer to use SMTP
$mail->Host = 'smtp.163.com'; // Specify main and backup SMTP servers
$mail->SMTPAuth = TRUE; // Enable SMTP authentication
$mail->Username = 'xxx@163.com'; // SMTP username
$mail->Password = 'xxx'; // SMTP password
$mail->SMTPSecure = 'tls';// Enable TLS encryption, `ssl` also accepted
$mail->FromName = '跳蚤街';
$mail->CharSet = "utf-8";
$mail->IsHTML(TRUE);
//$mail->Port = 465; // TCP port to connect to
$mail->setFrom('xxx@163.com', '跳蚤街');
$mail->AddAddress('139xxx@qq.com'); // Add a recipient
//$mail->addAttachment('/var/tmp/file.tar.gz'); // Add attachments
//$mail->addAttachment('/tmp/image.jpg', 'new.jpg'); // Optional name
$mail->isHTML(true); // Set email format to HTML
$mail->Subject = $this->args['subject'];
$body = $this->args['body'];
date_default_timezone_set('Asia/Shanghai');
$date = date("Y年m月d日，H:i:s",$body['time']);
$content = <<<EOT
<style>
table{ background-color:#aaa; line-height:25px;}
th{ background-color:#fff;text-align:center}
td{ background-color:#fff; text-align:center}
</style>
<table width="500" cellpadding="0" cellspacing="1">
<tr>
<th>条目</th>
<th>详情</th>
</tr>
<tr>
<td>订单编号</td>
<td>$body[orderNo]</td>
</tr>
<tr>
<td>商品名称</td>
<td>$body[commodityName]</td>
</tr>
<tr>
<td>合计</td>
<td>$body[price]</td>
</tr>
<tr>
<td>收货人</td>
<td>$body[buyerName]</td>
</tr>
<tr>
<td>联系方式</td>
<td>$body[contact]</td>
</tr>
<tr>
<td>收货地址</td>
<td>$body[receiveAddress]</td>
</tr>
<tr>
<td>留言</td>
<td>$body[leaveMsg]</td>
</tr>
<tr>
<td>下单时间</td>
<td>$date</td>
</tr>
</table>
EOT;
$mail->Body = $content;
//$mail->AltBody = 'send test';
if(!$mail->send()) {
echo 'Mailer Error: ' . $mail->ErrorInfo;
} else {
echo "send success";
}
}
}
4.执行Worker
进入php-resque文件夹中，在命令行里执行
QUEUE=default php demo/resque.php &注意，最后面还有一个 & ,表示在后台静默执行，如果要离开终端，则务必输入exit，保证后台进程不意外退出。
5.来一发。
点击下单，然后立即收到了如下邮件。
作者：费德
