Beanstalk 项目技术文档

1. 安装指南

1.1 使用 Composer 安装

Beanstalk 项目推荐使用 Composer 进行安装。Composer 是 PHP 的依赖管理工具，能够方便地管理项目的依赖关系。

1.1.1 安装 Composer

如果你还没有安装 Composer，可以通过以下命令进行安装：

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

1.1.2 添加 Beanstalk 依赖

在你的项目根目录下，运行以下命令将 Beanstalk 添加为项目的依赖：

composer require davidpersson/beanstalk

1.2 手动安装

如果你不使用 Composer，也可以手动下载 Beanstalk 项目并将其放置在你的项目目录中。

1. 下载 Beanstalk 项目的源代码。
2. 将下载的文件解压到你的项目目录中。
3. 确保你的项目能够正确引用 src/Client.php 文件。

2. 项目的使用说明

2.1 生产者示例

以下是一个简单的生产者示例，展示了如何将任务放入 Beanstalkd 队列中：

<?php

use Beanstalk\Client;

$beanstalk = new Client(); // 初始化客户端
$beanstalk->connect(); // 连接到 Beanstalkd 服务器
$beanstalk->useTube('flux'); // 使用名为 'flux' 的管道

$beanstalk->put(
    23, // 任务优先级
    0,  // 立即放入就绪队列
    60, // 任务的超时时间（1分钟）
    '/path/to/cat-image.png' // 任务内容
);

$beanstalk->disconnect(); // 断开连接

2.2 消费者示例

以下是一个简单的消费者示例，展示了如何从 Beanstalkd 队列中取出任务并处理：

<?php

use Beanstalk\Client;

$beanstalk = new Client();
$beanstalk->connect();
$beanstalk->watch('flux'); // 监听名为 'flux' 的管道

while (true) {
    $job = $beanstalk->reserve(); // 阻塞直到有任务可用
    // $job 是一个包含任务 ID 和内容的数组
    // ['id' => 123, 'body' => '/path/to/cat-image.png']

    // 处理任务
    $result = touch($job['body']);

    if ($result) {
        $beanstalk->delete($job['id']); // 删除已完成的任务
    } else {
        $beanstalk->bury($job['id']); // 将任务埋藏
    }
}

// 在退出时断开连接
// $beanstalk->disconnect();

3. 项目 API 使用文档

3.1 Client 类

3.1.1 connect()

连接到 Beanstalkd 服务器。

$beanstalk->connect();

3.1.2 disconnect()

断开与 Beanstalkd 服务器的连接。

$beanstalk->disconnect();

3.1.3 useTube($tube)

选择要使用的管道。

$beanstalk->useTube('flux');

3.1.4 watch($tube)

监听指定的管道。

$beanstalk->watch('flux');

3.1.5 put($priority, $delay, $ttr, $body)

将任务放入队列。

• $priority：任务优先级。
• $delay：延迟时间（秒）。
• $ttr：任务的超时时间（秒）。
• $body：任务内容。

$beanstalk->put(23, 0, 60, '/path/to/cat-image.png');

3.1.6 reserve()

阻塞直到有任务可用，并返回任务的 ID 和内容。

$job = $beanstalk->reserve();

3.1.7 delete($id)

删除指定 ID 的任务。

$beanstalk->delete($job['id']);

3.1.8 bury($id)

将指定 ID 的任务埋藏。

$beanstalk->bury($job['id']);

4. 项目安装方式

Beanstalk 项目支持通过 Composer 安装和手动安装两种方式。推荐使用 Composer 进行安装，因为它能够自动管理依赖关系，并且方便升级。

4.1 Composer 安装

通过 Composer 安装 Beanstalk 项目非常简单，只需在项目根目录下运行以下命令：

composer require davidpersson/beanstalk

4.2 手动安装

如果你不使用 Composer，可以手动下载 Beanstalk 项目的源代码，并将其放置在你的项目目录中。确保你的项目能够正确引用 src/Client.php 文件。

---

通过以上文档，你应该能够顺利安装和使用 Beanstalk 项目。如果有任何问题，请参考项目的 README 文件或联系项目维护者。