6.1 MQTT

# 有关MQTT的概念
[MQTT详解1](https://doc.bdgca.com/doc/48/)
[MQTT详解2](https://doc.bdgca.com/doc/49/)
[MQTT服务端部署](https://doc.bdgca.com/doc/50/)
[MQTT自签名证书制作方法](https://doc.bdgca.com/doc/52/)
[MQTT转发变量配置示例](https://doc.bdgca.com/doc/13/#mqtt_trans)

# MQTT通道参数配置
在DGather中，MQTT分为`MQTT-Publisher`(MQTT发布者)和`MQTT-Subscriber`(MQTT消息订阅者)两种驱动，前者作为主动转发类型的驱动程序对外转发消息，后者作为标签型变量的数据采集驱动将订阅消息转换为DGather的变量。两者的参数配置是完全相同的，此处统一介绍。

## MQTT参数配置示例

![MQTT参数配置](/media/202406/2024-06-30_180626_4333200.9339730253113638.png "MQTT参数配置")
![MQTT参数配置](/media/202406/2024-06-30_123110_5699810.14379909329477125.png "MQTT参数配置")

## MQTT参数说明

|名称|类型|必填|推荐值|说明
|----|----|----|----|----|
|名称|string|是|无|通信通道的名称，根据需要自由定义，50各字符以内
|说明|string|否|无|通信通道的说明性文字，根据需要自由填写，250各字符以内
|禁用|bool|是|否|如果选`是`则当前通道及当前通道下的所有变量将被禁用
|连接地址|string|是|无|MQTT服务器的连接地址，要根据MQTT服务器的监听配置和IP地址(或者域名)设置。 设置的格式为：`类型://IP:端口[/路径]`，其中，类型可选:</br>`tpc`或`mqtt`:普通TCP连接,可选用户名和密码，一般对应的端口号为`1883` </br>`ssl`或`mqtts`:TLS/SSL对称加密TCP连接, 需要CA证书和客户端证书与密钥，一般对应的端口号为`8883` </br>`ws`:普通WebSocket连接,可选用户名和密码 ，一般对应的端口号为`8083`</br>`wss`:SSL对称加密WebSocket连接, 需要CA证书和客户端证书与密钥，一般对应的端口号为`8084`。当使用`ws`或者`wss`时，还需要在连接地址的`端口`后添加`/路径`，`路径`由MQTT服务器定义，一般情况下`路径`的值是`mqtt`。**通信类型和端口号一定要与MQTT服务器端相适配**。
|超时时间(毫秒)|int|是|3000|连接超时时长，收到服务器连接确认前的等待时间，等待时间内未收到连接确认则为连接失败。
|扫描周期(毫秒)|int|是|1000|扫描当前通道下待发布变量的周期，周期越短发送约频繁
|保留日志|bool|是|否|调试阶段可选保留报文日志，生产阶段**切勿**保留日志，以防止大量日志占用硬盘和内存
|客户端识别码|string|是|无|当前通道在MQTT服务器端的识别码，连接到服务器的每个客户端都必须要有唯一的客户端识别码,长度通常为为 1 至 23 个字节的 UTF-8 字符串
|用户名|string|否|无|请根据服务器端的配置和连接类型选择如何填写用户名
|密码|string|否|无|请根据服务器端的配置和连接类型选择如何填写密码
|清除会话|bool|是|否|为 false 时表示创建一个持久会话，在客户端断开连接时，会话仍然保持并保存离线消息，直到会话超时注销。为 true 时表示创建一个新的临时会话，在客户端断开时，会话自动销毁。
|自动重连接|bool|是|是|用于设定在断开连接后是否自动重新连接
|遗嘱消息|string|否|无|遗嘱消息是 MQTT 为那些可能出现意外断线的设备提供的将遗嘱优雅地发送给其他客户端的能力。设置了遗嘱消息消息的 MQTT 客户端异常下线时，MQTT 服务器会发布该客户端设置的遗嘱消息。遗嘱消息可以看作是一个简化版的 MQTT 消息，它也包含 Topic、Payload、QoS、Retain 等信息，格式为:`{"topic":"", "qos":0, "payload":"", "retain":true}`,其中的消息内容可以根据实情填写。
|CA证书文件|string|否|无|如果MQTT服务端的证书是CA签发的证书，此处和CA证书和下面的客户端证书无需填写。如果服务器端使用的是自签发证书，则需要向MQTT服务器的运维人员索要证书文件。此处应填写证书在DGather所在计算机上的绝对路径
|客户端证书文件|string|否|无|根据CA证书生成的客户端证书，此处应填写证书在DGather所在计算机上的绝对路径。如何制作证书请参阅[MQTT自签名证书制作方法](https://doc.bdgca.com/doc/52/)
|客户端密钥文件|string|否|无|根据CA证书生成的客户端密钥，此处应填写证书密钥在DGather所在计算机上的绝对路径。如何制作证书请参阅[MQTT自签名证书制作方法](https://doc.bdgca.com/doc/52/)
|保活周期(秒)|int|是|10|保活周期（Keep Alive），是一个以秒为单位的时间间隔。客户端在无报文发送时，将按 Keep Alive 设定的值定时向服务端发送心跳报文，确保连接不被服务端断开.在连接建立成功后，如果服务器没有在 Keep Alive 的 1.5 倍时间内收到来自客户端的任何包，则会认为和客户端之间的连接出现了问题，此时服务器便会断开和客户端的连接。