PHP MQTT客户端使用指南

一、项目目录结构及介绍

PHP MQTT客户端项目采用清晰的目录布局，以支持易维护性和可扩展性。以下是其主要目录结构及各部分简介：

php-mqtt/client/
├── src                       # 核心源代码目录
│   ├── Client.php            # MQTT客户端类定义文件，是实现连接、发布、订阅功能的核心。
│   └── ...
├── examples                  # 示例代码目录，提供了快速上手的实例。
│   ├── simple-publish.php     # 发布消息示例
│   └── simple-subscribe.php   # 订阅主题示例
├── tests                     # 自动化测试相关文件
│   └── ...
├── README.md                 # 项目说明文件，介绍项目概览和快速入门指南。
└── composer.json             # Composer依赖管理文件，定义了项目的依赖关系。

src 目录包含了所有核心类库，其中Client.php是最关键的文件，实现了MQTT协议的客户端逻辑。examples目录则是提供给开发者学习和参考的实际应用案例。

二、项目启动文件介绍

本项目的设计鼓励通过包含核心类并实例化Client来启动。虽然没有特定命名为“启动文件”，但通常在示例或实际应用中，你会创建一个新的PHP文件，如在examples中的simple-publish.php或simple-subscribe.php，作为项目的入口点：

<?php
require_once 'vendor/autoload.php'; // 引入Composer自动加载器
use PhpMqtt\Client as MqttClient;

// 实例化MQTT客户端
$client = new MqttClient([
    'server' => 'tcp://localhost', // MQTT服务器地址
    'port' => 1883,                // 默认端口
    'client_id' => 'my_unique_client_id', // 客户端ID
    // 其它配置项...
]);

$client->connect(); // 建立连接

// 接下来进行消息发布或订阅等操作...

$client->disconnect(); // 操作完成后断开连接

这里的“启动”更多是指具体的应用逻辑起点，而非一个预置的脚本文件。

三、项目的配置文件介绍

直接操作中，PHP MQTT客户端并没有强制的外部配置文件。配置是通过实例化Client类时传入的关联数组（键值对）完成的。这允许灵活配置，无需依赖于固定的配置文件路径。例如：

$config = [
    'server' => 'your_mqtt_broker_address',
    'port' => 1883,
    'keepalive' => 60,       // 心跳间隔，单位秒
    'clean_session' => true,  // 控制会话清除标志
    // 更多自定义配置...
];

$client = new MqttClient($config);

在更复杂的应用场景下，开发者可以选择将这些配置存储在外部文件（如.env或JSON/YAML文件），然后在运行时读取并传递给客户端实例，以实现配置的分离与管理。但这不是项目默认提供的功能，需开发者自行实现。