README

php-mqtt/laravel-client 由 Marvin Mall 创建并维护。它是 php-mqtt/client 包的 Laravel 封装，允许您连接到 MQTT 代理，在那里您可以发布消息并订阅主题。

安装

该软件包可在 packagist.org 上获取，并可以使用 composer 进行安装

composer require php-mqtt/laravel-client

该软件包将通过 Laravel 自动发现包来注册自己。注册的将包括服务提供者以及 MQTT 外观。

如果您正在使用 Lumen，则需要手动将以下代码添加到 bootstrap/app.php

$app->register(\PhpMqtt\Client\MqttClientServiceProvider::class);

安装软件包后，您应使用以下命令发布配置文件

php artisan vendor:publish --provider="PhpMqtt\Client\MqttClientServiceProvider" --tag="config"

并根据您的需要更改 config/mqtt-client.php 中的配置。

配置

该软件包允许您配置多个命名连接。一个带有内联文档的初始示例可以在发布的配置文件中找到。大多数配置选项都是可选的，并带有合理的默认值（尤其是所有的 connection_settings）。

以下是一个配置两个连接的示例，其中一个用于共享公共数据，另一个用于私有数据

'default_connection' => 'private',

'connections' => [
    'private' => [
        'host' => 'mqtt.example.com',
        'port' => 1883,
    ],
    'public' => [
        'host' => 'test.mosquitto.org',
        'port' => 1883,
    ],
],

在此示例中，私有连接是默认连接。

注意：建议使用环境变量来配置 MQTT 客户端。配置文件中可以找到可用的环境变量。

用法

发布（QoS 级别 0）

使用 QoS 级别 0 发布消息非常简单，只需一个命令即可完成

use PhpMqtt\Client\Facades\MQTT;

MQTT::publish('some/topic', 'Hello World!');

如果需要，可以将 retain 标志（默认：false）作为第三个参数传递，并将连接名称作为第四个参数传递

use PhpMqtt\Client\Facades\MQTT;

MQTT::publish('some/topic', 'Hello World!', true, 'public');

使用 MQTT::publish($topic, $message) 将隐式调用 MQTT::connection()，但在使用后不会关闭连接。如果因为您的脚本不再需要连接而需要手动关闭连接，您可以调用 MQTT:disconnect()（可选地带有连接名称作为参数）。请注意，使用 MQTT::publish($topic, $message) 将始终使用 QoS 级别 0。如果需要不同的 QoS 级别，您将需要直接使用 MqttClient，这将在下面解释。

发布（QoS 级别 1 & 2）

与 QoS 级别 0 不同，我们需要运行事件循环才能使 QoS 1 和 2 的工作。这是因为使用单次命令，我们无法保证消息到达目标。事件循环将确保在代理在宽限期内没有返回确认的情况下，再次发送已发布的消息。

use PhpMqtt\Client\Facades\MQTT;

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
$mqtt = MQTT::connection();
$mqtt->publish('some/topic', 'foo', 1);
$mqtt->publish('some/other/topic', 'bar', 2, true); // Retain the message
$mqtt->loop(true);

$mqtt->loop() 实际上启动了一个无限循环。要退出循环，有多种选择。在仅发布消息的情况下，我们只想收到确认。因此，我们可以简单地将 true 作为第二个参数传递，以便在所有重发队列清除后立即退出循环。

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
$mqtt->loop(true, true);

为了跳出循环，您还可以调用 $mqtt->interrupt()，这将使循环在下一个迭代中退出。例如，该方法可以在注册的信号处理程序中调用。

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
pcntl_signal(SIGINT, function () use ($mqtt) {
    $mqtt->interrupt();
});

订阅

与使用 QoS 级别 1 和 2 的发布类似，订阅也需要运行一个事件循环。尽管在运行循环之前，需要订阅主题。

use PhpMqtt\Client\Facades\MQTT;

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
$mqtt = MQTT::connection();
$mqtt->subscribe('some/topic', function (string $topic, string $message) {
    echo sprintf('Received QoS level 1 message on topic [%s]: %s', $topic, $message);
}, 1);
$mqtt->loop(true);

特性

此库允许您使用由 php-mqtt/client 提供的所有功能。只需使用 MQTT::connection(string $name = null) 获取 \PhpMqtt\Client\Contracts\MqttClient 的实例，然后直接使用它。

有关如何使用 MQTT 客户端（直接）的广泛示例集合，您可以访问 php-mqtt/client-examples 存储库。

许可协议

php-mqtt/laravel-client 是开源软件，使用 MIT 许可协议 许可。