如何在 PHP 项目中使用 MQTT

PHP是一种广泛使用的开放源代码脚本语言，专门针对Web开发而设计，并可嵌入到HTML中直接执行。起初，PHP是代表“Personal Home Page”的缩写，但现在它是“PHP: Hypertext Preprocessor”的递归缩写。PHP支持各种数据库、协议和具有丰富的内置函数库。运行于大多数服务器、操作系统平台，并且与其他流行的数据库完美集成。随着时间的推移，许多框架如Laravel、Symfony和CodeIgniter为PHP开发提供了极大的便利，使其在现代Web开发中继续保持其核心地位。

MQTT（Message Queuing Telemetry Transport）是一种轻量级的发布/订阅消息传输协议，专为低带宽和不稳定的网络环境设计。起初为监控远程传感器和设备而开发，现在已广泛应用于物联网（IoT）领域。它允许设备在最小的代码和电源消耗下进行有效通信，使其成为联网设备的理想选择。随着物联网的发展，MQTT已被多家大型技术公司所采纳，并且逐渐成为物联网通信的事实标准。其核心概念包括Broker（消息中心）和客户端，通过Topic（主题）实现消息的分发和接收。

本篇文章深入探讨了如何在PHP项目中通过php-mqtt/client库，有效地建立MQTT客户端与MQTT服务器的连接，并实现订阅、取消订阅以及消息的收发功能。

选择MQTT客户端库

当谈及PHP中的MQTT客户端库，php-mqtt/client无疑是composer平台上最受欢迎的选择，其下载量领先于其他库。对于感兴趣的开发者，Packagist的Search MQTT功能提供了更多的客户端库选择。

为了更深入地了解如何使用php-mqtt/client，您可以参考Packagist上的php-mqtt/client官方文档。

PHP中的MQTT通信

值得注意的是，MQTT通信并不属于传统的HTTP体系。由于PHP的某些特性限制，采用专为网络通信设计的PHP拓展，如Swoole或Workerman，会为开发者带来更为流畅的体验。在这里，我们不再深入这些拓展的具体使用方法，但以下是一些与MQTT相关的客户端库：

• workerman/mqtt: 一个基于workerman的PHP异步MQTT客户端。
• simps/mqtt: 专为PHP设计的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

准备 MQTT Broker

在继续之前，您需要一个 MQTT Broker 进行通信和测试。你可以通过一下方式获取 MQTT Broker：

• 私有部署EMQX 是应用于物联网、工业物联网和车联网的最具可扩展性的开源 MQTT Broker。您可以通过以下 Docker 命令来安装 EMQX：

docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx

本文将使用 EMQX 提供的 免费公共 MQTT 服务器，该服务基于 EMQX 的 MQTT 物联网云平台 创建。服务器接入信息如下：

• Broker: broker-cn.emqx.io
• TCP Port: 1883
• SSL/TLS Port: 8883

PHP MQTT 使用指南

导入 composer autoload 文件和 php-mqtt/client

require('vendor/autoload.php');

use \PhpMqtt\Client\MqttClient;

设置 MQTT Broker 连接参数

设置 MQTT Broker 连接地址，端口，客户端 ID，用户名以及 topic，这里我们调用 PHP rand 函数随机生成 MQTT 客户端 ID，避免与其他客户端 ID 重复。

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

使用上述的参数进行连接，通过 ConnectionSettings 设置连接参数：

$connectionSettings  = new ConnectionSettings();
$connectionSettings
  ->setUsername($username)
  ->setPassword(null)
  ->setKeepAliveInterval(60)
  // Last Will 设置
  ->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);

发布消息

构造一个 payload，调用 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);
}

// 客户端轮询以处理传入消息和重发队列
$mqtt->loop(true);

// 断开 MQTT 连接
// $client->disconnect();

完整代码

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

<?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)
  // Last Will 设置
  ->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 连接
// $client->disconnect();

测试

运行 MQTT 消息发布代码，我们将看到客户端已经成功连接，且消息已经逐条发布并接收成功：

php pubsub_tcp.php

5. 总结

整合MQTT到PHP项目可能初看有些复杂，但随着上述指南的帮助，流程将变得明确和简单。选择适当的客户端库、理解PHP与MQTT的通信特性，再结合实战经验，即可轻松实现MQTT在PHP中的应用。