在PHP中使用MQTT协议的流程步骤

2023-06-01 00:00:00 协议 步骤 流程

PHP是一种应用广泛的开源多用途脚本语言,可以嵌入到 HTML 中,特别适用于 Web 开发。

本文主要介绍如何php-mqtt/client在 PHP 项目中使用客户端库来实现MQTT 客户端与MQTT 服务器之间的连接、订阅、退订、消息接收和发送等功能。


MQTT 客户端库选择

本文选用php-mqtt/clientcomposer上下载量最高的客户端库。

更多PHP-MQTT客户端库,请查看Packagist-Search MQTT。

https://packagist.org/search/?query%20=mqtt

更多关于 php-mqtt/client 的文档,请参考Packagist php-mqtt/client。

https://packagist.org/packages/php-mqtt/client

MQTT 通信属于 HTTP 系统之外的网络通信场景。

由于PHP特性的限制,在PHP系统中使用Swoole/Workerman等网络通信扩展可以带来更好的体验。

它的使用在本文中不再赘述。

相关的 MQTT 客户端库如下:

workerman/mqtt:基于workerman的PHP异步MQTT客户端。

https://packagist.org/packages/workerman/mqtt

simps/mqtt: PHP 的MQTT 协议分析和协程客户端。

https://packagist.org/packages/simps/mqtt


项目初始化

确认PHP版本

本项目使用 7.4.21 进行开发和测试。读者可以通过以下命令确认 PHP 版本。

php --version
PHP 7.4.21 (cli) (built: Jul 12 2021 11:52:30) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
    with Zend OPcache v7.4.21, Copyright (c), by Zend Technologies

使用 Composer 安装 php-mqtt/client

Composer 是一个 PHP 的依赖管理工具,可以管理你的 PHP 项目需要的所有依赖。

composer require php-mqtt/client


PHP MQTT 用法

连接到 MQTT 服务器

本文将使用 EMQX 提供的Free Public MQTT Server,

它是在 EMQX 的MQTT 云服务上创建的。

服务器访问信息如下:

Broker:broker.emqx.io
TCP 端口:1883
SSL/TLS 端口:8883

导入 Composer 自动加载文件和 php-mqtt/client

require('vendor/autoload.php');
use \PhpMqtt\Client\MqttClient;

设置 MQTT 代理连接参数

设置 MQTT Broker 连接地址、端口和主题。同时,我们调用PHPrand函数随机生成MQTT客户端id。

$server   = 'broker.emqx.io';
$port     = 1883;
$clientId = rand(5, 15);
$username = 'emqx_user';
$password = null;
$clean_session = false;

编写 MQTT 连接函数

使用以上参数进行连接,通过 设置连接参数ConnectionSettings,如:

$connectionSettings  = new ConnectionSettings();
$connectionSettings
  ->setUsername($username)
  ->setPassword(null)
  ->setKeepAliveInterval(60)
  ->setLastWillTopic('emqx/test/last-will')
  ->setLastWillMessage('client disconnect')
  ->setLastWillQualityOfService(1);

订阅

程序订阅 的主题emqx/test,并为订阅配置回调函数处理接收到的消息。

这里我们打印出订阅得到的主题和消息:

$mqtt->subscribe('emqx/test', function ($topic, $message) {
    printf("Received message on topic [%s]: %s\n", $topic, $message);
}, 0);

发布

构造一个有效负载并调用该publish函数以将消息发布到该emqx/test主题。发布后,客户端需要进入轮询状态来处理传入的消息和重传队列:

for ($i = 0; $i< 10; $i++) {
  $payload = array(
    'protocol' => 'tcp',
    'date' => date('Y-m-d H:i:s'),
    'url' => 'https://github.com/emqx/MQTT-Client-Examples'
  );
  $mqtt->publish(
    // topic
    'emqx/test',
    // payload
    json_encode($payload),
    // qos
    0,
    // retain
    true
  );
  printf("msg $i send\n");
  sleep(1);
}
// The client loop to process incoming messages and retransmission queues
$mqtt->loop(true);


完整代码

服务器连接、消息发布和接收代码。

<?php
require('vendor/autoload.php');
use \PhpMqtt\Client\MqttClient;
use \PhpMqtt\Client\ConnectionSettings;
$server   = 'broker.emqx.io';
$port     = 1883;
$clientId = rand(5, 15);
$username = 'emqx_user';
$password = null;
$clean_session = false;
$connectionSettings  = new ConnectionSettings();
$connectionSettings
  ->setUsername($username)
  ->setPassword(null)
  ->setKeepAliveInterval(60)
  ->setLastWillTopic('emqx/test/last-will')
  ->setLastWillMessage('client disconnect')
  ->setLastWillQualityOfService(1);
$mqtt = new MqttClient($server, $port, $clientId);
$mqtt->connect($connectionSettings, $clean_session);
printf("client connected\n");
$mqtt->subscribe('emqx/test', function ($topic, $message) {
    printf("Received message on topic [%s]: %s\n", $topic, $message);
}, 0);
for ($i = 0; $i< 10; $i++) {
  $payload = array(
    'protocol' => 'tcp',
    'date' => date('Y-m-d H:i:s'),
    'url' => 'https://github.com/emqx/MQTT-Client-Examples'
  );
  $mqtt->publish(
    // topic
    'emqx/test',
    // payload
    json_encode($payload),
    // qos
    0,
    // retain
    true
  );
  printf("msg $i send\n");
  sleep(1);
}
$mqtt->loop(true);

测试

运行MQTT消息发布代码后,我们会看到客户端已经连接成功,并且消息已经一一发布并成功接收:

php pubsub_tcp.php

//输出
client connected
msg 0 send
...
msg 9 send
Received message on topic [emqx/test]: {"protocol":"tcp","date":"2021-07-27 08:43:24","url":"https:\/\/github.com\/emqx\/MQTT-Client-Examples"}
...

概括

至此,我们已经使用php-mqtt/client连接公共MQTT服务器,实现了测试客户端与MQTT服务器的连接、消息发布和订阅。


转:

https://dev.to/emqtech/how-to-use-mqtt-in-php-5dk6

相关文章