yii2 queue 的使用

柔情只为你懂 2022-05-16 15:48 295阅读 0赞

# yii2 queue 的使用 #

### 1. 安装 ###

composer require --prefer-dist yiisoft/yii2-queue
    复制代码

### 2. 配置，在 `common/config/main.php` 中配置 ###

*  redis作为驱动

return [
        'bootstrap' => [
            'queue', // 把这个组件注册到控制台
        ],
        'components' => [
            'redis' => [
                'class' => \yii\redis\Connection::class,
                // ...
            ],
            'queue' => [
                'class' => \yii\queue\redis\Queue::class,
                'as log' => \yii\queue\LogBehavior::class,//错误日志 默认为 console/runtime/logs/app.log
                'redis' => 'redis', // 连接组件或它的配置
                'channel' => 'queue', // Queue channel key
            ],
        ],
    ];
    复制代码

*  File 作为驱动

return [
        'bootstrap' => [
            'queue', // 把这个组件注册到控制台
        ],
        'components' => [
            'queue' => [
                'class' => \yii\queue\file\Queue::class,
                'as log' => \yii\queue\LogBehavior::class,//错误日志 默认为 console/runtime/logs/app.log
                'path' => '@runtime/queue',
            ],
        ],
    ];
    复制代码

### 3. 新建 `frontend/components/DownloadJob` ###

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));
        }
    }
    复制代码

### 4. 控制台 ###

控制台用于监听和处理队列任务。 cmd 下 监听队列

yii queue/listen
    复制代码

### 5. 添加到队列 ###

*  将任务添加到队列:

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

*  将任务推送到队列中延时5分钟运行:

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

### 6. 测试 ###

执行 5 中的程序，控制台监听到，便会后台自动 下载`http://example.com/image.jpg`到本地为`/tmp/image.jpg`

参考文献：

[https://juejin.im/post/5aa770546fb9a028bd4bfbdf][https_juejin.im_post_5aa770546fb9a028bd4bfbdf]

[https_juejin.im_post_5aa770546fb9a028bd4bfbdf]: https://juejin.im/post/5aa770546fb9a028bd4bfbdf