PHP MQTT 客户端技术文档
client An MQTT client written in and for PHP. 项目地址: https://gitcode.com/gh_mirrors/client9/client
概览
PHP MQTT 客户端是由Marvin Mall开发并维护的一个库,它允许用户连接到MQTT代理,并在那里发布消息与订阅主题。该实现支持所有服务质量(QoS)级别,尽管存在一些限制。本文档将指导您完成安装过程,并提供详细使用说明以及API示例。
安装指南
通过Composer安装是最简单且推荐的方式。确保您的环境已配置PHP 8.0或更高版本,然后执行以下命令:
composer require php-mqtt/client
这将会自动下载并管理依赖关系,使您可以立即开始使用PHP MQTT客户端。
使用说明
发布消息(Publish)
发布一个简单的消息到MQTT代理涉及三个步骤:连接、发布、断开连接。
$mqtt = new \PhpMqtt\Client\MqttClient('some-broker.example.com', 1883, 'test-publisher');
$mqtt->connect();
$mqtt->publish('php-mqtt/client/test', 'Hello World!', 0);
$mqtt->disconnect();
不指定$clientId
时,系统会自动生成,保持会话干净。
订阅主题(Subscribe)
订阅操作需要维持事件循环来处理来自代理的消息。
$mqtt = new \PhpMqtt\Client\MqttClient('some-broker.example.com', 1883, 'test-subscriber');
$mqtt->connect();
$mqtt->subscribe('php-mqtt/client/test', function ($topic, $message, $retained, $matchedWildcards) {
echo "接收到消息,主题: [$topic], 内容: $message\n";
}, 0);
$mqtt->loop(true); // 持续监听,true表示阻塞直到显式中断
$mqtt->disconnect();
可以通过$mqtt->interrupt();
在循环运行期间中断它。
高级设置
客户端初始化设置
客户端可以接受额外的参数以定制其行为,例如协议版本、存储仓库和日志处理程序。
$mqtt = new \PhpMqtt\Client\MqttClient(
$server, $port, $clientId,
\PhpMqtt\Client\MqttClient::MQTT_3_1,
new \PhpMqtt\Client\Repositories\MemoryRepository(),
new \Psr\Log\NullLogger()
);
连接设置
使用ConnectionSettings
来控制连接细节,如认证信息、TLS安全设置等。
$settings = (new \PhpMqtt\Client\ConnectionSettings)
->setUsername('your_username')
->setPassword('your_password')
->setUseTls(true);
$mqtt->connect($settings);
API使用文档简述
虽然具体API文档应参考官方文档和源码注释,基本方法如下:
publish(topic, payload, qos=0)
: 发布消息。subscribe(topic, callback, qos=0)
: 订阅主题,提供回调处理接收的消息。connect([ConnectionSettings], [bool cleanSession])
: 建立到MQTT代理的连接。disconnect()
: 断开与MQTT代理的连接。loop(blocking=true)
: 运行事件循环,处理订阅的消息。interrupt()
: 中断当前的事件循环。
总结
PHP MQTT客户端为PHP应用程序提供了全面的MQTT通讯功能,从简单的消息发送到复杂的交互都得以实现。记住,在实际应用中,适当处理异常和配置正确的连接选项是关键,确保与MQTT服务器稳定通信。对于更复杂的应用场景,查阅官方仓库中的高级示例和详细的API文档将非常有帮助。
client An MQTT client written in and for PHP. 项目地址: https://gitcode.com/gh_mirrors/client9/client
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考