Pheanstalk 项目下载及安装教程

1. 项目介绍

Pheanstalk 是一个纯 PHP 8.1+ 客户端，用于与 beanstalkd 工作队列版本 1.12 及更高版本配合使用。该项目在 2021/2022/2023 年几乎完全重写，旨在实现以下目标：

• 完全类型化
• 通过 PHPStan 和 Psalm 进行严格的静态分析
• 将不同角色拆分为单独的部分

Pheanstalk 提供了生产者和消费者的使用示例，适用于需要高效处理任务队列的 PHP 项目。

2. 项目下载位置

Pheanstalk 项目的源代码托管在 GitHub 上。你可以通过以下命令克隆项目到本地：

git clone https://github.com/pheanstalk/pheanstalk.git

3. 项目安装环境配置

3.1 环境要求

• PHP 8.1 或更高版本
• Composer（用于依赖管理）
• beanstalkd 服务器（用于队列服务）

3.2 环境配置示例

3.2.1 安装 PHP

确保你的系统上已经安装了 PHP 8.1 或更高版本。你可以通过以下命令检查 PHP 版本：

php -v

3.2.2 安装 Composer

Composer 是 PHP 的依赖管理工具。你可以通过以下命令安装 Composer：

curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer

3.2.3 安装 beanstalkd

beanstalkd 是一个轻量级的、高性能的工作队列系统。你可以通过以下命令安装 beanstalkd：

sudo apt-get install beanstalkd

启动 beanstalkd 服务：

sudo service beanstalkd start

4. 项目安装方式

4.1 使用 Composer 安装

进入项目目录并使用 Composer 安装依赖：

cd pheanstalk
composer install

4.2 手动安装

如果你不想使用 Composer，可以手动下载 Pheanstalk 的源代码并将其包含在你的项目中。

5. 项目处理脚本

5.1 生产者示例

以下是一个简单的生产者示例，用于将任务放入队列：

use Pheanstalk\Pheanstalk;
use Pheanstalk\Values\TubeName;

$pheanstalk = Pheanstalk::create('127.0.0.1');
$tube = new TubeName('testtube');

// 将任务放入队列
$pheanstalk->useTube($tube);
$pheanstalk->put("job payload goes here\n");

5.2 消费者示例

以下是一个简单的消费者示例，用于从队列中取出任务并处理：

use Pheanstalk\Pheanstalk;
use Pheanstalk\Values\TubeName;

$pheanstalk = Pheanstalk::create('127.0.0.1');
$tube = new TubeName('testtube');

// 只从 'testtube' 队列中取出任务
$pheanstalk->watch($tube);

// 阻塞直到有任务可用
$job = $pheanstalk->reserve();

try {
    $jobPayload = $job->getData();
    // 处理任务
    echo "Starting job with payload: [$jobPayload]\n";
    sleep(2);
    // 如果任务需要很长时间，定期通知 beanstalk 我们还在处理
    $pheanstalk->touch($job);
    sleep(2);
    // 任务完成，删除任务
    $pheanstalk->delete($job);
} catch (\Exception $e) {
    // 处理异常，让其他消费者重试
    $pheanstalk->release($job);
}

通过以上步骤，你可以成功下载、安装并使用 Pheanstalk 项目来处理任务队列。