README

此提供 Yii2 的队列组件。

安装

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

运行以下命令之一：

php composer.phar require --prefer-dist vm/yii2-queue "^1.4.0"

或者

"vm/yii2-queue": "^1.4.0"

将以下内容添加到您的 composer.json 文件的 require 部分。

要使用 Redis 队列或 RabbitMQ，您必须分别添加 yiisoft/yii2-redis:* 或 videlalvaro/php-amqplib: 2.5.*。

设置

安装后，第一步是设置控制台控制器。

return [
    // ...
    'controllerMap' => [
        'queue' => [
            'class' => 'vm\queue\Console\Controller',
            //'sleepTimeout' => 1
        ],
        
    ],
];

对于任务工作进程，设置一个新的模块，例如 task 并在配置中声明它。

'modules' => [
    'task' => [
        'class' => 'app\modules\task\Module',
    ]
]

然后设置队列组件。别忘了在组件中设置运行任务的模块名称。例如，使用 AWS SQS 的队列

'components' => [
    'queue' => [
        'class' => 'vm\queue\Queues\SqsQueue',
        'module' => 'task',
        'url' => 'https://sqs.ap-southeast-1.amazonaws.com/123456789012/queue',
		'config' => [
			'key' => 'AKIA1234567890123456',
			'secret' => '1234567890123456789012345678901234567890',
			'region' => 'ap-southeast-1',
			'version' => 'latest'
        ],
    ]
]

或使用数据库队列

'components' => [
    'db' => [
        //the db component
    ],
    'queue' => [
        'class' => 'vm\queue\Queues\DbQueue',
        'db' => 'db',
        'tableName' => 'queue',
        'module' => 'task',
    ]
]

使用

创建工作进程

创建工作进程与创建控制台或 Web 控制器相同。在任务模块中创建一个继承自 vm\queue\Worker\Controller 的控制器

例如。

class FooController extends vm\queue\Worker\Controller {

    public function actionBar($param1, $param2){
        echo $param1;
    }
}

为了防止作业从队列中删除，例如当作业未完成时，在操作中返回 false。作业将在下一次机会再次运行。

例如。

class FooController extends vm\queue\Worker\Controller {

    public function actionBar($param1, $param2){
        try {
        } catch (\Exception $ex){
            \Yii::error('Ouch something just happened');
            return false;
        }
    }
}

运行监听器

要运行监听器，运行上面配置中设置的控制台。如果控制器映射为 queue 则运行。

./yii queue/listen

发布作业

要从源代码发布作业，请放置以下内容。

use vm\queue\Job;

$route = 'foo/bar';
$data = ['param1' => 'foo', 'param2' => 'bar'];
Yii::$app->queue->post(new Job(['route' => $route, 'data' => $data]));

作业也可以从控制台发布。第二个参数中的数据是 JSON 字符串。

yii queue/post 'foo/bar' '{"param1": "foo", "param2": "bar"}'

作业也可以作为匿名函数发布。请注意使用此方法。

Yii::$app->queue->post(new Job(function(){
    echo 'Hello World!';
}));

延迟事件

在此队列中，有一个名为 延迟事件 的功能。基本来说，使用此功能，我们可以通过队列延迟执行在某个事件之后执行的过程。

要使用它，在组件中添加行为并实现定义的事件处理器。

    public function behaviors() {
        return array_merge([
            [
                'class' => \vm\queue\Behaviors\DeferredEventBehavior::class,
                'events' => [
                    self::EVENT_AFTER_VALIDATE => 'deferAfterValidate',
                ]
            ]
        ]);
    }

    public function deferAfterValidate(){
        //Do something here.
    }

注意由于减少消息大小，通常在触发事件时传递的 $event 对象将不会传递给延迟事件。此外，方法调用的对象仅是克隆对象，因此它不会在原始对象中具有行为和事件。

对于 ActiveRecord 类，由于序列化 PDO 的 SuperClosure 限制，无法传递对象，因此应该使用 \vm\queue\Behaviors\ActiveRecordDeferredEventBehavior。区别在于调用延迟事件处理器的对象。

由于我们无法传递原始对象，调用对象将重新从表中使用主键获取。对于 afterDelete 事件，由于相应的行不再在表中，调用对象是一个新的对象，其属性是从原始对象的属性分配的。

Web端点

我们可以通过将\vm\queue\Web\Controller添加到控制器映射中来使用队列。

例如

    'controllerMap' => [
        'queue' => [
            /* @var $queue vm\queue\Web\Controller */
            'class' => 'vm\queue\Web\Controller'
        ]
    ],

要发布此内容，请使用以下命令：

curl -XPOST http://example.com/queue/post --data route='test/test' --data data='{"data":"data"}'

要限制对控制器的访问，我们可以使用\yii\filters\AccessControl过滤器。

例如，为了按IP地址过滤，我们可以使用如下方法。

    'controllerMap' => [
        'queue' => [
            /* @var $queue vm\queue\Web\Controller */
            'class' => 'vm\queue\Web\Controller',
            'as access' => [
                'class' => '\yii\filters\AccessControl',
                'rules' => [
                    [
                        'allow' => true,
                        'ips' => [
                            '127.0.0.1'
                        ]
                    ]
                ]
            ]
        ]
    ],

测试

要运行测试，在根目录下执行以下命令。

./vendor/bin/phpunit

路线图

添加更多队列提供者，例如MemCache、IronMQ。

神秘的移动端 / yii2-queue

维护者

详细信息