Pheanstalk 技术文档

1. 安装指南

Pheanstalk 是一个用于 beanstalkd workqueue 的纯 PHP8.1+ 客户端。以下是安装步骤：

使用 Composer 安装

首先，确保已经安装了 Composer。然后在项目根目录下运行以下命令：

composer require pda/pheanstalk

这将自动下载并安装 Pheanstalk 以及其依赖。

2. 项目的使用说明

Pheanstalk 提供了简单的方式来与 beanstalkd 交互，包括任务的发布（produce）和获取（consume）。

生产者（Producer）示例

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");

$pheanstalk->useTube($tube);
$pheanstalk->put(
    data: json_encode(['test' => 'data'], JSON_THROW_ON_ERROR),
    priority: Pheanstalk::DEFAULT_PRIORITY,
    delay: 30,
    timeToRelease: 60
);

消费者（Consumer）示例

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);
}

3. 项目API使用文档

Pheanstalk 提供了丰富的 API 用于与 beanstalkd 交互。以下是一些常用方法：

• Pheanstalk::create($host, $port = null, $timeout = null): 创建一个新的 Pheanstalk 实例。
• $pheanstalk->useTube($tube): 设置当前操作的 tube。
• $pheanstalk->put($data, $priority = null, $delay = null, $timeToRelease = null): 将任务放入 tube。
• $pheanstalk->reserve($timeout = null): 预留一个任务，可选超时时间。
• $pheanstalk->delete($job): 删除一个任务。
• $pheanstalk->release($job, $priority = null, $delay = null): 释放一个任务，可选新的优先级和延迟。

更多 API 方法请参考官方文档。

4. 项目安装方式

Pheanstalk 的安装方式如下：

通过 Composer

使用 Composer 是最简单的方式，只需在项目根目录下执行：

composer require pda/pheanstalk

手动安装

如果你希望手动安装，可以从 Packagist 下载最新版本的 Pheanstalk，然后将其包含到你的项目中。

确保你的 PHP 环境满足以下要求：

• PHP 版本 8.1 或更高。
• mbstring 扩展（可选，但推荐）。

以上就是 Pheanstalk 的技术文档，希望对您的使用有所帮助。