介绍

MQTT X 是一款开源的MQTT 5.0 桌面测试客户端，相比其他mqtt的桌面客户端工具，比如paho、mqtt.fx，Mqttx有以下的优势：

• 支持创建多个同时在线的 MQTT 客户端，方便用户快速测试 MQTT/TCP、MQTT/TLS 、MQTT/WebSocket的连接/发布/订阅功能及其他 MQTT 协议特性。
• 支持自动重连和自动恢复订阅。
• 全面的 MQTT 参数配置，以便用户应对任何使用场景。
• 可以记录订阅主题，以应对多主题订阅带来的不便。
• 支持运行script来对实时接收到的消息进行处理，应对复杂消息难以观测的难题。
• 数据的导入导出。

效果演示

本文主要讲解如何使用mqtt x的脚本功能。

安装

进入官网访问选择对应平台下载：https://mqttx.app/zh
Github仓库：https://github.com/emqx/MQTTX

Script功能说明

以下为mqttx从接收订阅消息到显示在控制台的流程图：

image.png

从流程图可以看出重要的一点是，script处理的消息是经过解码之后得到的字符串，所以如果没有在控制台正确选中解码方式，那么script运行可能得不到正确输出。

脚本编写与测试

Script功能例程

需求：已知接收到的消息为hex，如果第一个字节是0xF0, 那么其中第二第三个字节是0-65535的数值A，另外第四个字节的第三个位为一个开关量B。现在需要在接收到消息时，提取到A和B直接显示出来。
Script如下：

/**
* @description: 处理mqtt接收到的消息
* @param {any} value - Payload 接收到的消息并且经过解码后的字符串
* @param {string} msgType - 消息的类型,是订阅消息还是发送消息 'received' or 'publish'
* @param {number} index - 消息的索引 Index of the message, valid only when script is used in the publish message and timed message is enabled
* @return {any} - 经过处理后的消息 Payload after script processing
*/
function handlePayload(value, msgType, index) {
    const hexStrArray = toHexStrArray(value)
    var printTextArr = [];
    if(hexStrArray[0] == "F0"){
        printTextArr.push("A值:"+parseHexStrArraytoInt(hexStrArray.slice(1, 3)))
        printTextArr.push("B开关:"+extractBitFromHexStr(hexStrArray[3], 3))
    }
    printTextArr.push("原paylod:"+value)
    return printTextArr.join(",")
}

/**
 * @description: 
 * 将value(payload)转为hex字符串数组并返回
 * 例如:
 *  输入: "3C3C 0014"
 *  输出: ["3C", "3C", "00", "14"]
 *
 * @param {any} value - Payload,类型是string
 * @return {any} - hex字符串数组
 */
function toHexStrArray(value){
    const rep = value.replace(/\s*/g,"")
    let array = []
    let arrLen = rep.length/2
    for(var i = 0; i < arrLen; i++){
        array.push(rep.substr(i*2, 2))
    }
    return array
}

/**
 * @description: 
 * 大端模式下,将hex字符串数组转为整形数
 * 例如:
 *  输入:["ff","ff"] 
 *  输出:65535
 * 
 * @param {array} hexStrArray - hex字符串数组
 * @return {number} - 整形数
 */
function parseHexStrArraytoInt(hexStrArray){
    return parseInt(hexStrArray.join(""), 16)
}

/**
 * @description: 从hex字符串中提取位,返回0或者1
 * 
 * @param {string} hexStr - hex字符串
 * @param {number} bitNum - 取第几位,低位从右边开始,最小为1
 * @return {number} - 0或者1
 */
function extractBitFromHexStr(hexStr,bitNum){
    return (parseInt(hexStr, 16) >>> (bitNum-1)) & 1
}

/**
 * @description: 执行handlePayload方法
 */
execute(handlePayload)

输入消息与结果对照

E0 00 FF FF 输出 原paylod:E0 00 FF FF

F0 00 FF FF 输出 A值:255,B开关:1,原paylod:F0 00 FF FF 

F0 FF 01 FF 输出 A值:65281,B开关:1,原paylod:F0 FF 01 FF

F0 FF 01 FB 输出 A值:65281,B开关:0,原paylod:F0 FF 01 FB 

控制台输出