[PHP](https://www.php.net) 是一種被廣泛應用的開放原始碼的多用途指令碼語言，它可嵌入到 HTML 中，尤其適合 Web 開發。

本文主要介紹如何在 PHP 專案中使用 `php-mqtt/client` 客戶端庫 ，實現 [MQTT 客戶端](https://www.emqx.com/zh/blog/introduction-to-the-commonly-used-mqtt-client-library)與 [MQTT 伺服器](https://www.emqx.io/zh)的連線、訂閱、取消訂閱、收發訊息等功能。

## MQTT 客戶端庫選擇

本文選擇了 composer 上下載量最高的 `php-mqtt/client` 這個客戶端庫，更多 PHP-MQTT 客戶端庫可以在 [Packagist - Search MQTT](https://packagist.org/search/?query=mqtt) 中檢視。

有關 php-mqtt/client 更多使用文件請參閱 [Packagist php-mqtt/client](https://packagist.org/packages/php-mqtt/client)。

MQTT 通訊屬於 HTTP 體系之外的網路通訊場景，由於 PHP 特性限制，使用 PHP 體系中的 Swoole/Workerman 等專為網路通訊打造的擴充可以帶來更好的體驗，其使用本文不再贅述，相關的 MQTT 客戶端庫如下：

- [workerman/mqtt](https://packagist.org/packages/workerman/mqtt)：Asynchronous MQTT client for PHP based on workerman.
- [simps/mqtt](https://packagist.org/packages/simps/mqtt)：MQTT Protocol Analysis and Coroutine Client for PHP.

## 專案初始化

### 確認 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 專案所需要的所有依賴關係。

```bash
composer require php-mqtt/client
```

## PHP MQTT 使用

### 連線 MQTT 伺服器

本文將使用 EMQ X 提供的 [免費公共 MQTT 伺服器](https://www.emqx.com/zh/mqtt/public-mqtt5-broker)，該服務基於 EMQ X 的 [MQTT 物聯網雲平臺](https://cloud.emqx.cn/) 建立。伺服器接入資訊如下：

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

#### 匯入 composer autoload 檔案和 php-mqtt/client

```php
require('vendor/autoload.php');

use \PhpMqtt\Client\MqttClient;
```

#### 設定 MQTT Broker 連線引數

設定 MQTT Broker 連線地址，埠以及 topic，同時我們呼叫 PHP `rand` 函式隨機生成 MQTT 客戶端 id。

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

#### 編寫 MQTT 連線函式

使用上述的引數進行連線，透過 `ConnectionSettings` 設定連線引數，比如

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

### 訂閱訊息

編寫程式碼訂閱 `emqx/test` 主題，併為該訂閱配置回撥函式以處理接收到的訊息，此處我們將訂閱得到的主題和訊息列印出來：

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

### 釋出訊息

構造一個 payload，呼叫 `publish` 函式向 `emqx/test` 主題釋出訊息，釋出完成之後客戶端需要進入輪詢狀態，處理傳入的訊息和重發佇列：

```php
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);
```

### 完整程式碼

伺服器連線、訊息釋出與接收程式碼。

```php
<?php require('vendor/autoload.php');="" use="" \PhpMqtt\Client\MqttClient;="" \PhpMqtt\Client\ConnectionSettings;="" $server="broker.emqx.io" ;="" $port="1883;" $clientId="rand(5," 15);="" $username="emqx_user" $password="null;" $clean_session="false;" $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 訊息釋出程式碼，我們將看到客戶端已經成功連線，且訊息已經逐條釋出並接收成功：

```bash
php pubsub_tcp.php
```

![PHP MQTT 測試](https://static.emqx.net/images/61618d56823886f101feaf6741a20c3f.png)

## 總結

至此，我們完成了使用 **php-mqtt/client** 客戶端連線到[公共 MQTT 伺服器](https://www.emqx.com/zh/mqtt/public-mqtt5-broker)，並實現了測試客戶端與 MQTT 伺服器的連線、訊息釋出和訂閱。

>版權宣告： 本文為  [EMQ]( https://www.emqx.io/cn/) 原創，轉載請註明出處。
>
>原文連結：[https://www.emqx.com/zh/blog/how-to-use-mqtt-in-php](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-php)</?php>

如何在 PHP 專案中使用 MQTT

相關文章