README

Yii2队列扩展

一个用于通过队列异步执行任务的扩展。

它支持基于 数据库、Redis、RabbitMQ、AMQP、Beanstalk 和 Gearman 的队列。

文档位于 docs/guide/README.md。

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一

php composer.phar require --prefer-dist yiisoft/yii2-queue

或

"yiisoft/yii2-queue": "~2.0.0"

将其添加到您的 composer.json 文件的require部分。

基本用法

发送到队列的每个任务都应该定义为单独的类。例如，如果您需要下载并保存文件，类可能看起来像以下这样

class DownloadJob extends BaseObject implements \yii\queue\JobInterface
{
    public $url;
    public $file;
    
    public function execute($queue)
    {
        file_put_contents($this->file, file_get_contents($this->url));
    }
}

以下是向队列发送任务的方法

Yii::$app->queue->push(new DownloadJob([
    'url' => 'http://example.com/image.jpg',
    'file' => '/tmp/image.jpg',
]));

将作业推送到队列，该作业将在5分钟后运行

Yii::$app->queue->delay(5 * 60)->push(new DownloadJob([
    'url' => 'http://example.com/image.jpg',
    'file' => '/tmp/image.jpg',
]));

任务的执行方式取决于所使用的驱动程序。大多数驱动程序都可以使用控制台命令运行，这些命令组件会自动在您的应用程序中注册。

此命令将循环获取并执行任务，直到队列为空

yii queue/run

此命令启动一个守护程序，无限期地查询队列

yii queue/listen

有关特定驱动程序的更多详细信息，请参阅文档中的控制台命令及其选项。

组件还具有跟踪已推送到队列的作业状态的特性。

// Push a job into the queue and get a message ID.
$id = Yii::$app->queue->push(new SomeJob());

// Check whether the job is waiting for execution.
Yii::$app->queue->isWaiting($id);

// Check whether a worker got the job from the queue and executes it.
Yii::$app->queue->isReserved($id);

// Check whether a worker has executed the job.
Yii::$app->queue->isDone($id);

有关更多详细信息，请参阅 指南。