登录/注册

AMQP

hyperf/amqp 是实现 AMQP 标准的组件,主要适用于对 RabbitMQ 的使用。

安装

composer require hyperf/amqp

默认配置

配置 类型 默认值 备注
host string localhost Host
port int 5672 端口号
user string guest 用户名
password string guest 密码
vhost string / vhost
concurrent.limit int 0 同时消费的数量
pool object 连接池配置
params object 基本配置
<?php

return [
    'default' => [
        'host' => 'localhost',
        'port' => 5672,
        'user' => 'guest',
        'password' => 'guest',
        'vhost' => '/',
        'concurrent' => [
            'limit' => 1,
        ],
        'pool' => [
            'min_connections' => 1,
            'max_connections' => 10,
            'connect_timeout' => 10.0,
            'wait_timeout' => 3.0,
            'heartbeat' => -1,
        ],
        'params' => [
            'insist' => false,
            'login_method' => 'AMQPLAIN',
            'login_response' => null,
            'locale' => 'en_US',
            'connection_timeout' => 3.0,
            'read_write_timeout' => 3.0,
            'context' => null,
            'keepalive' => false,
            'heartbeat' => 3,
        ],
    ],
    'pool2' => [
        ...
    ]
];

可在 producer 或者 consumer__construct 函数中, 设置不同 pool.

投递消息

使用 gen:producer 命令创建一个 producer

php bin/hyperf.php gen:amqp-producer DemoProducer

在 DemoProducer 文件中,我们可以修改 @Producer 注解对应的字段来替换对应的 exchangeroutingKey。其中 payload 就是最终投递到消息队列中的数据,所以我们可以随意改写 __construct 方法,只要最后赋值 payload 即可。示例如下。

使用 @Producer 注解时需 use HyperfAmqpAnnotationProducer; 命名空间;

<?php

declare(strict_types=1);

namespace AppAmqpProducers;

use HyperfAmqpAnnotationProducer;
use HyperfAmqpMessageProducerMessage;
use AppModelsUser;

/**
 * DemoProducer
 * @Producer(exchange="hyperf", routingKey="hyperf")
 */
class DemoProducer extends ProducerMessage
{
    public function __construct($id)
    {
        // 设置不同 pool
        $this->poolName = 'pool2';

        $user = User::where('id', $id)->first();
        $this->payload = [
            'id' => $id,
            'data' => $user->toArray()
        ];
    }
}

通过 DI Container 获取 HyperfAmqpProducer 实例,即可投递消息。以下实例直接使用 ApplicationContext 获取 HyperfAmqpProducer 其实并不合理,DI Container 具体使用请到 依赖注入 章节中查看。

<?php
use HyperfAmqpProducer;
use AppAmqpProducersDemoProducer;
use HyperfUtilsApplicationContext;

$message = new DemoProducer(1);
$producer = ApplicationContext::getContainer()->get(Producer::class);
$result = $producer->produce($message);

消费消息

使用 gen:amqp-consumer 命令创建一个 consumer

php bin/hyperf.php gen:amqp-consumer DemoConsumer

在 DemoConsumer 文件中,我们可以修改 @Consumer 注解对应的字段来替换对应的 exchangeroutingKeyqueue。其中 $data 就是解析后的消息数据。示例如下。

使用 @Consumer 注解时需 use HyperfAmqpAnnotationConsumer; 命名空间;

<?php

declare(strict_types=1);

namespace AppAmqpConsumers;

use HyperfAmqpAnnotationConsumer;
use HyperfAmqpMessageConsumerMessage;
use HyperfAmqpResult;

/**
 * @Consumer(exchange="hyperf", routingKey="hyperf", queue="hyperf", nums=1)
 */
class DemoConsumer extends ConsumerMessage
{
    public function consume($data): string
    {
        print_r($data);
        return Result::ACK;
    }
}

禁止消费进程自启

默认情况下,使用了 @Consumer 注解后,框架会自动创建子进程启动消费者,并且会在子进程异常退出后,重新拉起。如果出于开发阶段,进行消费者调试时,可能会因为消费其他消息而导致调试不便。

这种情况,只需要在 @Consumer 注解中配置 enable=false (默认为 true 跟随服务启动)或者在对应的消费者中重写类方法 isEnable() 返回 false 即可

<?php

declare(strict_types=1);

namespace AppAmqpConsumers;

use HyperfAmqpAnnotationConsumer;
use HyperfAmqpMessageConsumerMessage;
use HyperfAmqpResult;

/**
 * @Consumer(exchange="hyperf", routingKey="hyperf", queue="hyperf", nums=1, enable=false)
 */
class DemoConsumer extends ConsumerMessage
{
    public function consume($data): string
    {
        print_r($data);
        return Result::ACK;
    }

    public function isEnable(): bool
    {
        return parent::isEnable();
    }
}

消费结果

框架会根据 Consumer 内的 consume 方法所返回的结果来决定该消息的响应行为,共有 4 中响应结果,分别为 HyperfAmqpResult::ACKHyperfAmqpResult::NACKHyperfAmqpResult::REQUEUEHyperfAmqpResult::DROP,每个返回值分别代表如下行为:

返回值 行为
HyperfAmqpResult::ACK 确认消息正确被消费掉了
HyperfAmqpResult::NACK 消息没有被正确消费掉,以 basic_nack 方法来响应
HyperfAmqpResult::REQUEUE 消息没有被正确消费掉,以 basic_reject 方法来响应,并使消息重新入列
HyperfAmqpResult::DROP 消息没有被正确消费掉,以 basic_reject 方法来响应
原文地址:https://www.bookstack.cn/read/hyperf-1.1.20/amqp.md
文章来源与用户投稿或网络采集,如果您是本文的作者,发现版权或转载方式问题请右侧邮箱联系管理员。

抢沙发

我们不是孤独的个体,留下足迹,保持联系,成为团体...
姓名
电子邮件
个人主页