react 使用 mqtt

也许很多人都好奇这个mqtt是什么东西，其实在互联网上可能不会使用到它，它是物联网上的东西，也是一种通信协议跟websocket。但它也能在浏览器跟服务器上跑，它的底层实现也是封装了websocket。

MQTT

MQTT是一个客户端服务端架构的发布/订阅模式的消息传输协议。它的设计思想是轻巧、开放、简单、规范，易于实现。这些特点使得它对很多场景来说都是很好的选择，特别是对于受限的环境如机器与机器的通信（M2M）以及物联网环境（IoT）。
本协议运行在TCP/IP，或其它提供了有序、可靠、双向连接的网络连接上。它有以下特点：

使用发布/订阅消息模式，提供了一对多的消息分发和应用之间的解耦。
消息传输不需要知道负载内容。
提供三种等级的服务质量：.

• “最多一次”，尽操作环境所能提供的最大努力分发消息。消息可能会丢失。例如，这个等级可用于环境传感器数据，单次的数据丢失没关系，因为不久之后会再次发送。
• “至少一次”，保证消息可以到达，但是可能会重复。
• “仅一次”，保证消息只到达一次。例如，这个等级可用在一个计费系统中，这里如果消息重复或丢失会导致不正确的收费。
  很小的传输消耗和协议数据交换，最大限度减少网络流量

异常连接断开发生时，能通知到相关各方。

常见API

• mqtt.connect()
• mqtt.Client()
• mqtt.Client#publish()
• mqtt.Client#subscribe()
• mqtt.Client#unsubscribe()
• mqtt.Client#end()
• mqtt.Client#removeOutgoingMessage()
• mqtt.Client#reconnect()
• mqtt.Client#handleMessage()
• mqtt.Client#connected
• mqtt.Client#reconnecting
• mqtt.Client#getLastMessageId()
• mqtt.Store()
• mqtt.Store#put()
• mqtt.Store#del()
• mqtt.Store#createStream()
• mqtt.Store#close()

使用

import * as mqtt from 'mqtt/dist/mqtt'
var clientMqtt = null //mqtt实例
let defalutTopic = ''export const connectMqtt = (baseURL, userId,uuid) => {return new Promise(async(resolve, reject) => {let message = {id: `${userId}`,type: "login",msg: "0",optional:new Date(),deviceId:uuid}const options = {keepalive: 30,protocolId: 'MQTT',protocolVersion: 4,clean: true,reconnectPeriod: 3000,connectTimeout: 30 * 1000,clientId: "mqtt" + Math.random().toString(16).substr(2, 8),will: {topic: `api/user/${userId}/login`,payload: JSON.stringify(message),qos: 0,retain: false},rejectUnauthorized: false};if (!clientMqtt) {//如果没有clientMatt 说明还没链接  就链接一下clientMqtt = await mqtt.connect(baseURL, options);await  clientMqtt?.on('error', (error) => {clientMqtt?.end()reject('链接失败')})await clientMqtt?.on("connect", () => {resolve('链接成功')});} else {//如果已经存在clientMqtt,就说明已经链接成功resolve('链接成功')}})
}

订阅了才能接受信息

export const subscribeMqtt = (topic = defalutTopic, qos = 1) => {return new Promise((resolve, reject) => {clientMqtt?.subscribe(topic, qos, (err) => {if (err) {reject('订阅失败')} else {// console.log(topic, '订阅');resolve('订阅成功')}});})
}

取消订阅

export const unSubscribeMqtt = (unTopic) => {return new Promise((resolve, reject) => {clientMqtt?.unsubscribe(unTopic, (err) => {if (err) {reject('失败')} else {console.log(unTopic, '取消订阅');resolve('取消成功')}})})
}

topic 发布

export const pubilshMqtt = (topic, message) => {let options = {qos: 0,retain: false,}return new Promise((resolve, reject) => {clientMqtt?.publish(topic, JSON.stringify(message), { ...options }, (error) => {if (error) {reject('发布信息失败')} else {resolve('发布信息成功')}})})
}

结束

export const endMqtt = async () => {return new Promise((resolve, reject) => {clientMqtt?.end((error) => {if (error) {reject('关闭失败')} else {clientMqtt = nullresolve('关闭成功')}})})
}

消息接收

export const messageMqtt = (reciveMessageMqtt) => {clientMqtt?.on('message',(topic, message,packet) => {if (packet.length>0) {reciveMessageMqtt(topic, JSON.parse(message))}})
}

注意

on.('message')这个方法与其它的是不同的，它会保存在clientMqtt中直到clientMqtt实例销毁。不然就会叠加消息，这个bug我找了两天。

WebSocket

WebSocket 是一种网络通信协议，很多高级功能都需要它。

初次接触 WebSocket 的人，都会问同样的问题：我们已经有了 HTTP 协议，为什么还需要另一个协议？它能带来什么好处？

答案很简单，因为 HTTP 协议有一个缺陷：通信只能由客户端发起。举例来说，我们想了解今天的天气，只能是客户端向服务器发出请求，服务器返回查询结果。HTTP 协议做不到服务器主动向客户端推送信息。HTTP 协议的这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。我们只能使用“轮询”：每隔一段时候，就发出一个询问，了解服务器有没有新的信息。最典型的场景就是聊天室。

轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。因此，工程师们一直在思考，有没有更好的方法。WebSocket 就是这样发明的。

简介

WebSocket 协议在2008年诞生，2011年成为国际标准。所有浏览器都已经支持了。

它的最大特点就是，服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息，是真正的双向平等对话，属于服务器推送技术的一种。WebSocket 允许服务器端与客户端进行全双工（full-duplex）的通信。举例来说，HTTP 协议有点像发电子邮件，发出后必须等待对方回信；WebSocket 则是像打电话，服务器端和客户端可以同时向对方发送数据，它们之间存着一条持续打开的数据通道。

其他特点包括：

（1）建立在 TCP 协议之上，服务器端的实现比较容易。

（2）与 HTTP 协议有着良好的兼容性。默认端口也是80和443，并且握手阶段采用 HTTP 协议，因此握手时不容易屏蔽，能通过各种 HTTP 代理服务器。

（3）数据格式比较轻量，性能开销小，通信高效。

（4）可以发送文本，也可以发送二进制数据。

（5）没有同源限制，客户端可以与任意服务器通信，完全可以取代 Ajax。

（6）协议标识符是ws（如果加密，则为wss，对应 HTTPS 协议），服务器网址就是 URL。

ws://example.com:80/some/path

WebSocket 握手

浏览器发出的 WebSocket 握手请求类似于下面的样子：

GET / HTTP/1.1
Connection: Upgrade
Upgrade: websocket
Host: example.com
Origin: null
Sec-WebSocket-Key: sN9cRrP/n9NdMgdcy2VJFQ==
Sec-WebSocket-Version: 13

上面的头信息之中，有一个 HTTP 头是Upgrade。HTTP1.1 协议规定，Upgrade字段表示将通信协议从HTTP/1.1转向该字段指定的协议。Connection字段表示浏览器通知服务器，如果可以的话，就升级到 WebSocket 协议。Origin字段用于提供请求发出的域名，供服务器验证是否许可的范围内（服务器也可以不验证）。Sec-WebSocket-Key则是用于握手协议的密钥，是 Base64 编码的16字节随机字符串。

服务器的 WebSocket 回应如下。

HTTP/1.1 101 Switching Protocols
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Accept: fFBooB7FAkLlXgRSz0BT3v4hq5s=
Sec-WebSocket-Origin: null
Sec-WebSocket-Location: ws://example.com/

上面代码中，服务器同样用Connection字段通知浏览器，需要改变协议。Sec-WebSocket-Accept字段是服务器在浏览器提供的Sec-WebSocket-Key字符串后面，添加 RFC6456 标准规定的“258EAFA5-E914-47DA-95CA-C5AB0DC85B11”字符串，然后再取 SHA-1 的哈希值。浏览器将对这个值进行验证，以证明确实是目标服务器回应了 WebSocket 请求。Sec-WebSocket-Location字段表示进行通信的 WebSocket 网址。

完成握手以后，WebSocket 协议就在 TCP 协议之上，开始传送数据。

客户端的简单示例

WebSocket 的用法相当简单。

下面是一个网页脚本的例子，基本上一眼就能明白。

var ws = new WebSocket('wss://echo.websocket.org');ws.onopen = function(evt) {console.log('Connection open ...');ws.send('Hello WebSockets!');
};ws.onmessage = function(evt) {console.log('Received Message: ' + evt.data);ws.close();
};ws.onclose = function(evt) {console.log('Connection closed.');
};

客户端 API

浏览器对 WebSocket 协议的处理，无非就是三件事。

• 建立连接和断开连接
• 发送数据和接收数据
• 处理错误

构造函数 WebSocket

WebSocket对象作为一个构造函数，用于新建WebSocket实例。

var ws = new WebSocket('ws://localhost:8080');

执行上面语句之后，客户端就会与服务器进行连接。

webSocket.readyState

readyState属性返回实例对象的当前状态，共有四种。

• CONNECTING：值为0，表示正在连接。
• OPEN：值为1，表示连接成功，可以通信了。
• CLOSING：值为2，表示连接正在关闭。
• CLOSED：值为3，表示连接已经关闭，或者打开连接失败。

下面是一个示例。

switch (ws.readyState) {case WebSocket.CONNECTING:// do somethingbreak;case WebSocket.OPEN:// do somethingbreak;case WebSocket.CLOSING:// do somethingbreak;case WebSocket.CLOSED:// do somethingbreak;default:// this never happensbreak;
}

webSocket.onopen

实例对象的onopen属性，用于指定连接成功后的回调函数。

ws.onopen = function () {ws.send('Hello Server!');
}

如果要指定多个回调函数，可以使用addEventListener方法。

ws.addEventListener('open', function (event) {ws.send('Hello Server!');
});

webSocket.onclose

实例对象的onclose属性，用于指定连接关闭后的回调函数。

ws.onclose = function(event) {var code = event.code;var reason = event.reason;var wasClean = event.wasClean;// handle close event
};ws.addEventListener("close", function(event) {var code = event.code;var reason = event.reason;var wasClean = event.wasClean;// handle close event
});

webSocket.onmessage

实例对象的onmessage属性，用于指定收到服务器数据后的回调函数。

ws.onmessage = function(event) {var data = event.data;// 处理数据
};ws.addEventListener("message", function(event) {var data = event.data;// 处理数据
});

注意，服务器数据可能是文本，也可能是二进制数据（blob对象或Arraybuffer对象）。

ws.onmessage = function(event){if(typeOf event.data === String) {console.log("Received data string");}if(event.data instanceof ArrayBuffer){var buffer = event.data;console.log("Received arraybuffer");}
}

除了动态判断收到的数据类型，也可以使用binaryType属性，显式指定收到的二进制数据类型。

// 收到的是 blob 数据
ws.binaryType = "blob";
ws.onmessage = function(e) {console.log(e.data.size);
};// 收到的是 ArrayBuffer 数据
ws.binaryType = "arraybuffer";
ws.onmessage = function(e) {console.log(e.data.byteLength);
};

webSocket.send()

实例对象的send()方法用于向服务器发送数据。

发送文本的例子。

ws.send('your message');

发送 Blob 对象的例子。

var file = document.querySelector('input[type="file"]').files[0];
ws.send(file);

发送 ArrayBuffer 对象的例子。

// Sending canvas ImageData as ArrayBuffer
var img = canvas_context.getImageData(0, 0, 400, 320);
var binary = new Uint8Array(img.data.length);
for (var i = 0; i < img.data.length; i++) {binary[i] = img.data[i];
}
ws.send(binary.buffer);

webSocket.bufferedAmount

实例对象的bufferedAmount属性，表示还有多少字节的二进制数据没有发送出去。它可以用来判断发送是否结束。

var data = new ArrayBuffer(10000000);
socket.send(data);if (socket.bufferedAmount === 0) {// 发送完毕
} else {// 发送还没结束
}

webSocket.onerror

实例对象的onerror属性，用于指定报错时的回调函数。

socket.onerror = function(event) {// handle error event
};socket.addEventListener("error", function(event) {// handle error event
});

WebSocket 服务器

WebSocket 协议需要服务器支持。各种服务器的实现，可以查看维基百科的列表。

常用的 Node 实现有以下三种。

• µWebSockets
• Socket.IO
• WebSocket-Node

具体的用法请查看它们的文档，本教程不详细介绍了。

总结

相同点

• MQTT 和 WebSocket 都是应用层协议
• 目前底层都是使用 TCP 协议确保可靠传输数据
• 都规定了自己的报文（消息）结构
• 都支持双向通信
• 都使用二进制编码（有别于 HTTP 这一类基于文本编码的协议）
• 都是公开标准

不同

• 通信模型不同WebSocket 是一种简单的报文协议，着重解决浏览器和服务端不能进行双向通信的问题。MQTT 则是一种比较复杂的消息协议。
• 报文结构不同虽然两都均使用二进行编码，但 WebSocket 的报文要远比 MQTT 简单。
• 消息收发方式不同。WebSocket 收发消息不需要对方确认。MQTT 收发消息需要根据投递级别进行确认。
• 保活机制不同。WebSocket 只规定了 ping/pong 两种报文，但并不强制要求定时收发心跳包。MQTT 则有明确的心跳协商机制。

最后

• MQTT 主要应用在物联网等场景，WebSocket 因为有配套的浏览器API，主要应用在 Web 开发领域。但两者均为通用的应用层协议，可以在任何相关的场景使用。
• MQTT和WebSocket都是面向报文的二进制传输协议。WebSocket更简单，更灵活；MQTT相对复杂，但功能强大。大家可以根据自己的使用场景按需选择。

参考链接

• Ryan Stewart, Real-time data exchange in HTML5 with WebSockets
• Malte Ubl & Eiji Kitamura，Introducing WebSockets: Bringing Sockets to the Web
• Jack Lawson, WebSockets: A Guide
• Michael W., Starting with Node and Web Sockets
• Jesse Cravens, Introduction to WebSockets
• Matt West, An Introduction to WebSockets
• Maciej Sopyło, Node.js: Better Performance With Socket.IO and doT
• Jos Dirksen, Capture Canvas and WebGL output as video using websockets
• Fionn Kellehe, Understanding Socket.IO
• How to Use WebSockets
• WebSockets - Send & Receive Messages