PHP实战RabbitMQ🏆 掘金技术征文|双节特别篇

1,077 阅读4分钟

简介

RabbitMQ是一个高可用的消息中间件,学习和使用RabbitMQ非常有必要。

  • 异步消息传递
  • 支持各种开发语言java、python、php等
  • 可插拔的身份验证、授权
  • RabbitMQ-Manager可用于管理和监视。

安装

这里直接使用docker,很方便的进行安装

拉取镜像 docker pull rabbitmq:3.8.3-management-alpine

运行 docker run --name run-rabbitmq -d -p 15672:15672 -p 5672:5672 rabbitmq

15672端口是RabbitMQ Web管理页面,直接访问:http://localhost:15672/,初始用户密码:guest

使用

RabbitMQ作为生产者和消费者来使用时,基本上有2中场景

  • 一个/多个生产者,多个共享消费者
  • 一个/多个生产者,多个独立消费者

共享的消费者可以同时消费一个队列的数据,增加吞吐量 独立的消费者不共享队列,每个消费者都有自己的队列,可以定义规则从exchange中pull数据到自己的queue中

下面将通过代码来实现各种场景

基础概念

queue

数据队列,数据可以推送到queue,也可以从queue中消费

exchange 交换机

将数据推送到交换机中,队列可以绑定交换机,交换机的类型不同所支持的绑定规则也不同

  • fanout 没有规则,所有exchange中的数据
  • direct 精确匹配,只绑定routingkey指定值的数据
  • topic 更加灵活的规则,路由键routingkey必须是一个由.分隔开的词语,* (星号) 用来表示一个单词,# (井号) 用来表示任意数量(零个或多个)单词

封装RabbitMQ一些常用操作

<?php


namespace RabbitMQ;

use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;

class RabbitMQ
{

    private $host = '127.0.0.1';
    private $port = 5672;
    private $user = 'guest';
    private $password = 'guest';
    protected $connection;
    protected $channel;


    /**
     * RabbitMQ constructor.
     */
    public function __construct()
    {
        $this->connection = new AMQPStreamConnection($this->host, $this->port, $this->user, $this->password);
        $this->channel    = $this->connection->channel();
    }

    /**
     * @param $exchangeName
     * @param $type
     * @param $pasive
     * @param $durable
     * @param $autoDelete
     */
    public function createExchange($exchangeName, $type, $pasive = false, $durable = false, $autoDelete = false)
    {
        $this->channel->exchange_declare($exchangeName, $type, $pasive, $durable, $autoDelete);
    }

    /**
     * @param $queueName
     * @param $pasive
     * @param $durable
     * @param $exlusive
     * @param $autoDelete
     */
    public function createQueue($queueName, $pasive = false, $durable = false, $exlusive = false, $autoDelete = false, $nowait = false, $arguments = [])
    {
        $this->channel->queue_declare($queueName, $pasive, $durable, $exlusive, $autoDelete, $nowait, $arguments);
    }

    /**
     * 生成信息
     * @param $message
     */
    public function sendMessage($message, $routeKey, $exchange = '', $properties = [])
    {
        $data = new AMQPMessage(
            $message, $properties
        );
        $this->channel->basic_publish($data, $exchange, $routeKey);
    }

    /**
     * 消费消息
     * @param $queueName
     * @param $callback
     * @throws \ErrorException
     */
    public function consumeMessage($queueName, $callback, $tag = '', $noLocal = false, $noAck = false, $exclusive = false, $noWait = false)
    {
        $this->channel->basic_consume($queueName, $tag, $noLocal, $noAck, $exclusive, $noWait, $callback);
        while ($this->channel->is_consuming()) {
            $this->channel->wait();
        }
    }

    /**
     * @throws \Exception
     */
    public function __destruct()
    {
        $this->channel->close();
        $this->connection->close();
    }
}

多个共享消费者

多个消费者可以增加消费速度,提供系统吞吐量

小二,直接上代码吧 生产者代码

<?php

require_once '../../vendor/autoload.php';

use RabbitMQ\RabbitMQ;
use PhpAmqpLib\Message\AMQPMessage;

$rabbit = new RabbitMQ();

$queueName = 'test-single-queue';
$rabbit->createQueue($queueName,false,true,false,false);
for ($i = 0; $i < 10000; $i++) {
    $rabbit->sendMessage($i . "this is a test message.", $queueName,'',[
        'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT //消息持久化,重启rabbitmq,消息不会丢失
    ]);
}

unset($rabbit);//关闭连接

运行生产者php Producer,在manager web页面可以可看到这个queue信息

消费者代码

<?php

require_once '../../vendor/autoload.php';

use RabbitMQ\RabbitMQ;

$rabbit = new RabbitMQ();

$queueName = 'test-single-queue';
$callback = function ($message){
    var_dump("Received Message : " . $message->body);//print message
    sleep(2);//处理耗时任务
    $message->delivery_info['channel']->basic_ack($message->delivery_info['delivery_tag']);//ack
};
$rabbit->consumeMessage($queueName,$callback);

unset($rabbit);//关闭连接

运行消费者二次php Consumer.php 可以看到二个消费者不会重复消费message 也可通过manager web看到此queue的message正在被消费

多个独立消费者

RabbitMQ生产者将message推送到exchange,通过将多个queue与exchange进行绑定,来实现多个独立消费者

定义一个topic类型的交换机,消费规则是:test.ex.加一个单词

<?php

require_once '../../vendor/autoload.php';

use RabbitMQ\RabbitMQ;

$rabbit = new RabbitMQ();

$exchangeName = 'test-ex-topic';
$queueName    = 'test-consumer-ex-topic';
$routingKey   = 'test.ex.*';//消费规则定义

//创建队列
$rabbit->createQueue($queueName, false, true);
//绑定到交换机
$rabbit->bindQueue($queueName, $exchangeName, $routingKey);
//消费
$callback = function ($message) {
    var_dump("Received Message : " . $message->body);//print message
    sleep(2);//处理耗时任务
    $message->delivery_info['channel']->basic_ack($message->delivery_info['delivery_tag']);//ack
};
$rabbit->consumeMessage($queueName, $callback);

unset($rabbit);//关闭连接

启动消费者php Consumer.php

定义生产者,会向2个不同的routingkey中推送message

<?php

require_once '../../vendor/autoload.php';

use PhpAmqpLib\Exchange\AMQPExchangeType;
use PhpAmqpLib\Message\AMQPMessage;
use RabbitMQ\RabbitMQ;


$rabbit = new RabbitMQ();

$routingKey1  = 'test.ex.queue1';
$routingKey2  = 'test.ex.queue2';
$exchangeName = 'test-ex-topic';
$rabbit->createExchange($exchangeName, AMQPExchangeType::TOPIC, false, true, false);

//向交换机和routingkey = test-ex-queue1中推送10000条数据
for ($i = 0; $i < 10000; $i++) {
    $rabbit->sendMessage($i . "this is a queue1 message.", $routingKey1, $exchangeName, [
        'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT //消息持久化,重启rabbitmq,消息不会丢失
    ]);
}
//向交换机和routingkey = test-ex-queue2中推送10000条数据
for ($i = 0; $i < 10000; $i++) {
    $rabbit->sendMessage($i . "this is a queue2 message.", $routingKey2, $exchangeName, [
        'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT //消息持久化,重启rabbitmq,消息不会丢失
    ]);
}

unset($rabbit);//关闭连接

运行生产者php Producer.php,可以看到消费者有2万条message可以消费,包含了2个routingkey中的数据

延时队列

概念

延时队列的作用不再累述 本文使用rabbitmq的queue可以设置ttl时间,将到期的message设为死信,message会被push到delay_queue,消费delay_queue即可实现延时队列功能

场景

先假设这样一个场景: 小明在外卖平台下个一个订单,如果超过10分钟未支付,则系统自动取消订单,并推送给用户“订单已取消”信息。

开发思路: 下订单时就将订单orderId push到订单队列order_queue,并设置次条message的有效期为10分钟,当10分钟后此条message到期,会将此条message转化为死信push到exchange,将exchange和queue进行绑定,开一个/多个消费者消费queue,并判断queue中message订单是否已支付,若未支付则推送通知,取消订单。

流程图,未考虑消息消费失败的情况

核心代码

对RabbitMQ进行简单的封装

<?php


namespace RabbitMQ;

use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;

class RabbitMQ
{

    private $host = '127.0.0.1';
    private $port = 5672;
    private $user = 'guest';
    private $password = 'guest';
    protected $connection;
    protected $channel;


    /**
     * RabbitMQ constructor.
     */
    public function __construct()
    {
        $this->connection = new AMQPStreamConnection($this->host, $this->port, $this->user, $this->password);
        $this->channel    = $this->connection->channel();
    }

    /**
     * 生成信息
     * @param $message
     */
    public function sendMessage($message, $routeKey, $exchange = '', $properties = [])
    {
        $data = new AMQPMessage(
            $message, $properties
        );
        $this->channel->basic_publish($data, $exchange, $routeKey);
    }

    /**
     * 消费消息
     * @param $queueName
     * @param $callback
     * @throws \ErrorException
     */
    public function consumeMessage($queueName,$callback)
    {
        $this->channel->basic_consume($queueName, '', false, false, false, false, $callback);
        while ($this->channel->is_consuming()) {
            $this->channel->wait();
        }
    }

    /**
     * @throws \Exception
     */
    public function __destruct()
    {
        $this->channel->close();
        $this->connection->close();
    }
}

创建延时队列

<?php


namespace RabbitMQ;

use PhpAmqpLib\Exchange\AMQPExchangeType;
use PhpAmqpLib\Message\AMQPMessage;
use PhpAmqpLib\Wire\AMQPTable;

/**
 * 使用RabbitMQ实现延时队列功能
 * Class DelayQueue
 * @package RabbitMQ
 */
class DelayQueue extends RabbitMQ
{

    /**
     * 创建延时队列
     * @param $ttl
     * @param $delayExName
     * @param $delayQueueName
     * @param $queueName
     */
    public function createQueue($ttl, $delayExName, $delayQueueName, $queueName)
    {
        $args = new AMQPTable([
            'x-dead-letter-exchange'    => $delayExName,
            'x-message-ttl'             => $ttl, //消息存活时间
            'x-dead-letter-routing-key' => $queueName
        ]);
        $this->channel->queue_declare($queueName, false, true, false, false, false, $args);
        //绑定死信queue
        $this->channel->exchange_declare($delayExName, AMQPExchangeType::DIRECT, false, true, false);
        $this->channel->queue_declare($delayQueueName, false, true, false, false);
        $this->channel->queue_bind($delayQueueName, $delayExName, $queueName, false);
    }
}

生产者,代码很简单,看看运行之后的效果,订单的message越来越多

<?php
require_once '../vendor/autoload.php';

// 生产者

$delay = new \RabbitMQ\DelayQueue();

$ttl            = 1000 * 100;//订单100s后超时
$delayExName    = 'delay-order-exchange';//超时exchange
$delayQueueName = 'delay-order-queue';//超时queue
$queueName      = 'ttl-order-queue';//订单queue

$delay->createQueue($ttl, $delayExName, $delayQueueName, $queueName);

//100个订单信息,每个订单超时时间都是10s
for ($i = 0; $i < 100; $i++) {
    $data = [
        'order_id' => $i + 1,
        'remark'   => 'this is a order test'
    ];
    $delay->sendMessage(json_encode($data), $queueName);
    sleep(1);
}

消费者,看看消费之后的,过一会会观察到,已经有到期message被push到了delay_order_queue 消费者也消费到了message !

<?php
require_once '../vendor/autoload.php';

// 消费者

$delay = new \RabbitMQ\DelayQueue();

$delayQueueName = 'delay-order-queue';

$callback = function ($msg) {
    echo $msg->body . PHP_EOL;
    $msg->delivery_info['channel']->basic_ack($msg->delivery_info['delivery_tag']);

    //处理订单超时逻辑,给用户推送提醒等等。。。
    sleep(10);
};

/**
 * 消费已经超时的订单信息,进行处理
 */
$delay->consumeMessage($delayQueueName, $callback);

代码

代码见:github.com/jiaoyang3/r…

🏆 掘金技术征文|双节特别篇