使用Node.js实现mqtt协议
记录一下自己学习mqtt的过程,如何从零开始使用Node.js实现mqtt协议,实现一个web页面向android端或其他client端发送消息,并接收其他client端发送的消息显示在web页面上。
主要用到的node模块是mqtt、mosca,web端使用mosca的mqtt over websocket功能,搭建web server可以使用express,存储数据以及mosca的backen都采用mongodb。
1、什么是MQTT
参见这位博主翻译的一系列hiveMQ 的文档,MQTT Part 1 简介 - 简书,非常详尽了。
2、安装nodejs模块
默认看到这篇文章的人已经了解Node.js
npm install mqtt --save
npm install mosca --save
安装mosca时,可能会遇到缺少依赖和环境的问题,
可能碰到ERR! configure error gyp ERR! stack Error: Can't find Python executable "python", ,需要安装python 2.7的环境。
还有可能碰到error MSB3428: Could not load the Visual C++ component "VCBuild.exe".遇到这个问题请安装visual studio 2015,不要装2017,然后
npm config set msvs_version 2015 --global
安装好后打开ide随便新建一个project,这样你需要的一切其他配置所需文件都有了,否则还会遇到各种其他问题,比如
node-gyp configure build KeyError: '2017' gyp ERR! configure error vs版本错误
Error: `C:\Program Files (x86)\MSBuild\14.0\bin\msbuild.exe`
MSB8036: The Windows SDK version 8.1 was not found. 安装对应sdk版本或vs中建project解决
error TRK0005: Failed to locate: "CL.exe". The system cannot find the file vs中建project解决
3、使用mqtt.js创建一个客户端用于测试
建立mqtt_client.js
这是MQTT.js文档中给出的example,看这里 GitHub - mqttjs/MQTT.js: The MQTT client for Node.js and the browser,连接到mosquitto的一个mqtt测试用server,subscribe订阅,publish发表,client.on('connect')连接已建立,client.on('message')收到订阅的消息,其他更多api等用法看文档。
运行响应可能有点慢,如果配置成功,以上代码运行成功会显示
4、建立mqtt服务端(broker)
mqtt本质上是client之间通过一个中间人即broker,来进行相互通信,之后通过websocket进行连接的web端也是一个client。服务端的搭建我们使用mosca,开源免费。文档什么的看这里Mosca basic usage · mcollina/mosca Wiki · GitHub
根据mosca的作者mcollina的解释,mosca只实现mqtt协议,大量的pub/sub服务需要一个backend作为支持。我们首先不使用backend,测试服务端与客户端的通信。建立mqtt_server.js
node运行后,cmd窗口会显示“Mosca server is up and running”,证明server已启动
5、测试客户端与服务端的通信
将第3步中的mqtt_client.js 第二行
var client=mqtt.connect('mqtt://test.mosquitto.org') 修改为
var client=mqtt.connect('mqtt://localhost')
再打开新的cmd窗口运行客户端,就可以建立与第四步中的server之间的通信啦。
成功通信后client端会显示'hello mqtt',而server端会显示连接的client ID,以及订阅发布的主题等。
6、使用mongodb作为backend
首先当然要在本地配置mongodb,具体配置过程不表,有很多文章讲解。
修改mqtt_server.js ,添加backend设置
然后在mongodb中建立mqtt的database,建立ascoltatori的collection,注意这个collection必须是固定集合(capped),否则会报错 ’Error: Cannot recover. Collection is not capped. mosca‘。
成功之后,在你建立的collection中就会存储所有连接的client的ID,sub/pub操作,topic等等。
7、通过server向client 发送消息
在server端的setup()函数中添加publish的代码段,注意这里不能直接把文档中的示例代码直接复制过来跑,会报错 Cannot read property 'insert' of undefined at EventEmitter.MongoAscoltatore.publish
= =因为是异步执行所以不写在setup里可能server还没ready就publish了。
然后还要修改一下mqtt_client.js,把client.end()去掉,还要订阅message topic。
然后启动服务端客户端客户端,就能从客户端看到message里的信息了。
8、mqtt over websockets
在工程目录下新建index.html
那个src中的mqtt.js存在于你深深的node module文件夹里,node module/mosca/public
然后在mqtt.server.js中添加web server的信息
然后启动完服务端,浏览器打开localhost:3000/index.html就打开了web的client端啦,启动mqtt_client.js,两个client端可以实现通信了。
先写到这里 ,之后或许使用express做路由分发,mongodb存储发送的信息,丰富html页面内容,有空再写。