JS 连接MQTT的方法（mqtt.js的使用方法）

本文章是介绍

mqtt.js

的使用方法

一、说明

1. 本文章使用的版本是 4.1.x ，没用最新版的原因是 4.2.x 以上版本会报错，具体报错可以看我的另一篇文章，点击查看。
2. 使用的 4.1.x 版本地址：https://cdn.bootcdn.net/ajax/libs/mqtt/4.1.0/mqtt.min.js
3. 如果遇到 无法连接/错误提示 WebSocket connection to …… 的问题，请看我另一篇文章，其中记录了我多次用到，遇见的连接问题，点击查看。

二、安装

CDN 安装

<script src="https://cdn.bootcdn.net/ajax/libs/mqtt/4.1.0/mqtt.min.js"></script><script>// 会在全局初始化一个 mqtt 变量，直接使用就可以
  console.log(mqtt)</script>

npm 安装

npm install mqtt --save

npm 安装后使用

// 页面使用，直接 import 就可以import mqtt from'mqtt';

三、使用

常用方式 下面有详细介绍

// 连接地址，有很多连接失败都是因为地址没写对const connectUrl =`ws://XXXX/mqtt/ws`;// 客户端IDconst clientId =`mqtt_${Math.random().toString(16).slice(3)}`;// 连接设置let options ={clean:true,// 保留会话connectTimeout:4000,// 超时时间reconnectPeriod:1000,// 重连时间间隔// 认证信息
  clientId,username:'zhongketianji',password:'zhongketianji123',}// 需要订阅的主题const topic ='/mqtt_backend/format_tracking/Uibox.car190';const topic1 ='/mqtt_backend/format_tracking/Uibox.car191';// 创建客户端var client = mqtt.connect(connectUrl, options);// 成功连接后触发的回调
client.on('connect',()=>{
    console.log('已经连接成功');// 订阅主题，这里可以订阅多个主题
    client.subscribe([topic, topic1],()=>{
        console.log(`订阅了主题 ${[topic, topic1].join('和')}`)})});// 当客户端收到一个发布过来的消息时触发回调/** 
 * topic：收到的报文的topic 
 * message：收到的数据包的负载playload 
 * packet：MQTT 报文信息，其中包含 QoS、retain 等信息
 */
client.on('message',function(topic, message, packet){// 这里有可能拿到的数据格式是Uint8Array格式，可以直接用toString转成字符串// let data = JSON.parse(message.toString());
    console.log("获取到的数据：", message)
    console.log("数据对应订阅主题：", topic)
    console.log("获取到的数据包：", packet)});// 关闭客户端（断开连接）
client.end();// 发送信息给 topic（主题）
client.publish(topic,'这是给topic发送的信息');

options 连接设置（常用）
属性说明keepalive单位为秒，数值类型，默认为 60 秒，设置为 0 时禁止。用于解决半连接问题，在该时间内是否接收两次传输clientId默认为 ‘mqttjs_’ + Math.random().toString(16).substr(2, 8)，可自定义修改，字符串类型protocolVersionMQTT 协议版本号，默认为 4（v3.1.1）可以修改为 3（v3.1）和 5（v5.0）clean是否清除会话，默认为 true。当设置为 true 时，断开连接后将清除会话，订阅过的 Topic 也将失效。当设置为 false 时，离线状态下也能收到 QoS 为 1 和 2 的消息reconnectPeriod重连间隔时间，单位为毫秒，默认为 1000 毫秒，注意：当设置为 0 以后将取消自动重连connectTimeout连接超时时长，收到 CONNACK 前的等待时间，单位为毫秒，默认 30000 毫秒username认证用户名，如果 Broker 要求用户名认证的话，请设置该值password认证密码，如果 Broker 要求密码认证的话，请设置该值will遗嘱消息，一个可配置的对象值，当客户端非正常断开连接时，Broker 就会向遗嘱 Topic 里面发布一条消息。
will 格式：

will:{topic:'WillMsg',// 发布消息的主题payload:'Connection Closed abnormally!',// 要发布的消息qos:0,// 消息等级retain:false// 保留消息标识},

Client 监听 （on方法）

// 成功连接后触发的回调
client.on('connect',()=>{
    console.log('已经连接成功');});// 当客户端收到一个发布过来的消息时触发回调/** 
 * topic：收到的数据包的topic 
 * message：收到的数据包的负载playload 
 * packet：MQTT 报文信息，其中包含 QoS、retain 等信息
 */
client.on('message',function(topic, message, packet){// 这里有可能拿到的数据格式是Uint8Array格式，可以直接用toString转成字符串// let data = JSON.parse(message.toString());
    console.log("获取到的数据：", data_190)
    console.log("数据对应订阅主题：", topic)
    console.log("获取到的数据包：", packet)});// 当重新连接启动触发回调 
client.on('reconnect',()=>{
    console.log("正在重新连接")});// 连接断开后触发的回调 
client.on("close",function(){
    console.log("已断开连接")});// 在收到 Broker（消息服务器） 发送过来的断开连接的报文时触发的回调，参数 packet 即为断开连接时接收到的报文。MQTT 5.0特性 
client.on("disconnect",function(packet){ 
    console.log("从broker接收到断开连接的报文："+packet);});// 客户端脱机下线触发回调 
client.on("offline",function(){
    console.log("您已断开连接，请检查网络")});// 当客户端无法成功连接时或发生解析错误时触发的回调，参数 error 为错误信息
client.on("error",(error)=>{
    console.log("客户端出现错误：", error);});//当客户端发送任何数据包时发出。这包括publish()以及MQTT用于管理订阅和连接的包 
client.on("packetsend",(packet)=>{
    console.log("客户端已发出报文", packet);});//当客户端接收到任何报文时发出。这包括来自订阅主题的信息包以及MQTT用于管理订阅和连接的信息 
client.on("packetreceive",(packet)=>{// 会在 client.on('message', function (topic, message, packet) {}); 之前触发
    console.log("客户端接收报文", packet);});

Client 方法（除on方法）

1. 向某一 topic（主题） 发布消息

Client.publish(topic, message,[options],[callback])

topic： 要发送的主题（字符串）
message： 要发送的主题的下的消息，可以是字符串或者是

Buffer

options： 可选值，发布消息时的配置信息，主要是设置发布消息时的

QoS

、

Retain

值等。
callback： 发布消息后的回调函数，参数为

error

，当发布失败时，该参数才存在

// 向 test 主题发送一条 QoS 为 0 的消息
client.publish('test','这是一条信息',{qos:0,retain:false},function(error){if(error){
    console.log(error)}else{
    console.log('Published')}})

1. 订阅一个或者多个 topic（主题） 的方法（当连接成功后需要订阅主题来获取消息）

Client.subscribe(topic/topic array/topic object,[options],[callback])

topic： 可传入一个字符串，或者一个字符串数组，也可以是一个

topic

对象，例如：{‘test1’: {qos: 0}, ‘test2’: {qos: 1}}
options： 可选值，订阅

Topic

时的配置信息，主要是填写订阅的

Topic

的

QoS

等级的
callback： 订阅

Topic

后的回调函数，参数为

error

和

granted

，当订阅失败时

error

参数才存在，

granted

是一个 {topic, qos} 的数组，其中

topic

是一个被订阅的主题，

qos

是

Topic

是被授予的

QoS

等级

// 订阅一个名为 test 且 QoS 为 0 的 Topic
client.subscribe('test',{qos:0},function(error, granted){if(error){
    console.log("订阅失败:", error)}else{
    console.log("已订阅：", granted[0].topic)}})

1. 取消订阅单个 topic（主题）或多个 topic（主题）

Client.unsubscribe(topic/topic array,[options],[callback])

topic： 可传入一个字符串或一个字符串数组
options： 可选值，取消订阅时的配置信息
callback： 取消订阅时的回调函数，参数为

error

，当取消订阅失败时

error

参数才存在

// 取消订阅名为 test 的 Topic
client.unsubscribe('test',function(error){if(error){
    console.log(error)}else{
    console.log('已取消订阅')}})

1. 关闭客户端

Client.end([force],[options],[callback])

force： 设置为

true

时将立即关闭客户端，而无需等待断开连接的消息被接受。这个参数是可选的，默认为

false

。注意： 使用该值为

true

时，

Broker

无法接收到

disconnect

的报文
options： 可选值，关闭客户端时的配置信息，主要是可以配置

reasonCode

，断开连接时的

Reason Code

callback： 当客户端关闭时的回调函数

client.end();

四、测试

EMQX 提供的 免费公共 MQTT 服务器，该服务基于 EMQX 的 MQTT 物联网云平台 创建。
服务器接入信息如下：

Broker： broker.emqx.io
TCP Port： 1883
Websocket Port： 8083

const connectUrl =`ws://broker.emqx.io:8083/mqtt`;
client = mqtt.connect(connectUrl,{clean:true,connectTimeout:4000,reconnectPeriod:1000,clientId:'emqx_test',username:'emqx_test',password:'emqx_test'})// 需要订阅的主题const topic ='test';//成功连接后触发的回调
client.on('connect',()=>{
  console.log('已经连接成功');// 这里可以订阅多个主题
  client.subscribe([topic],()=>{
    console.log(`订阅了主题 ${topic}`)})});// 当客户端收到一个发布过来的消息时触发回调
client.on('message',function(message){// 这里有可能拿到的数据格式是Uint8Array格式，所以可以直接用toString转成字符串// let data = JSON.parse(message.toString());
  console.log("返回的数据：", message)});// 连接断开后触发的回调
client.on("close",function(){
  console.log("已断开连接")});

五、测试结果