Hyperf-消息队列

Hyperf-消息队列

     官方文档里面有详细说明，安装和配置不再赘述，这里只是记录下实际中Redis异步队列的具体使用。

     注意：异步队列区别于 RabbitMQ Kafka 等消息队列，它只提供一种 异步处理 和 异步延时处理 的能力，并不能严格地保证消息的持久化和不支持完备的ACK 应答机制。

     工作原理

     ConsumerProcess 是异步消费进程，会根据用户创建的 Job 或者使用 @AsyncQueueMessage 的代码块，执行消费逻辑。 Job 和 @AsyncQueueMessage 都是需要投递和执行的任务，即数据、消费逻辑都会在任务中定义。

     1）Job 类中成员变量即为待消费的数据，handle() 方法则为消费逻辑。
     2）@AsyncQueueMessage 注解的方法，构造函数传入的数据即为待消费的数据，方法体则为消费逻辑。

 

    1、配置异步消费进程

    config/autoload/processes.php

<?php

  return [

       HyperfAsyncQueueProcessConsumerProcess::class,
  ];

    2、定义Job

    Job 类中成员变量即为待消费的数据，handle() 方法则为消费逻辑

    app/Job/AnalyseJob.php

<?php

declare(strict_types=1);

namespace AppJob;

use AppLog;
use AppServiceV1OrderOrderService;
use HyperfAsyncQueueJob;

class AnalyseJob extends Job
{
    public $params;

    /**
     * 任务执行失败后的重试次数，即最大执行次数为 $maxAttempts+1 次
     * @var int
     */
    protected $maxAttempts = 2;

    public function __construct($params)
    {
        $this->params = $params;
    }

    public function handle()
    {
        // 这里的逻辑会在 ConsumerProcess 进程中执行
        try {
            var_dump(">>> 监听到队列消息（晒单数据）：");
            var_dump($this->params);
            // 分析晒单数据
            $orderService = new OrderService();
            $res = $orderService->analyseOne($this->params);
            Log::get('AnalyseJob')->debug('监听到队列消息（晒单数据）,进行分析：', $res);
        } catch (Exception $e) {
            Log::get('AnalyseJob')->debug('监听到队列消息（晒单数据）,进行分析：' . $e->getMessage());
        }
    }
}

    3、写一个专门投递消息的service

     QueueService.php

<?php

declare(strict_types=1);

namespace AppServiceProducer;

use AppJobAnalyseJob;
use HyperfAsyncQueueDriverDriverFactory;
use HyperfAsyncQueueDriverDriverInterface;

class QueueService
{
    /**
     * @var DriverInterface
     */
    protected $driver;

    public function __construct(DriverFactory $driverFactory)
    {
        $this->driver = $driverFactory->get('default');
    }

    /**
     * 生产消息
     * @param $params
     * @param int $delay
     * @return bool
     */
    public function push($params, int $delay = 0): bool
    {
        return $this->driver->push(new AnalyseJob($params), $delay);
    }
}

    4、投递消息

    业务中调用service，来投递消息

<?php

declare(strict_types=1);

namespace AppController;

use AppServiceQueueService;
use HyperfDiAnnotationInject;
use HyperfHttpServerAnnotationAutoController;

/**
 * @AutoController
 */
class UserOrderController extends AbstractController
{
    /**
     * @Inject
     * @var QueueService
     */
    protected $service;

    /**
     * 注解模式投递消息
     */
    public function example()
    {
        // 创建/编辑成功后，推送队列消息，消费晒单消息用于比对原始订单
        if ($ret['code'] == 0) {
            $userOrderRes = $this->orderService->getUserOrderNativeInfo($ret['data']);
            $this->queueService->push($userOrderRes['data']);
        }

        // ...

    }
}

参考链接：

https://hyperf.wiki/2.1/#/zh-cn/async-queue