MQTT云平台使用说明文档(私有MQTT服务器的搭建与使用)说明书

2024年1月29日发(作者：)

MQTT云平台使用说明文档（私有MQTT服务器的搭建与使用）

文档版本控制文档版本REV1.0修改内容记录创建文档，完成初稿编写第1页共16页

版权申明：本手册版权归属海口丰润动漫单片机微控科技开发有限公司所有，并保留一切权利。非经本公司（书面形式）同意，任何单位及个人不得擅自摘录或修改本手册部分或全部内容，违者我们将追究其法律责任。本手册（文档）涉及的应用产品不得用于任何违法、违规的场合，任何单位及个人使用本公司产品及技术均需合法合规，若触犯国家或地区的法律法规，一切后果由使用者自行承担，我司将保留追究其法律责任的权力。感谢您购买购买本公司旗下产品，本手册（文档）会不定期更新，建议您使用时下载最新版本。Frun官网：/Frun官方淘宝店：/联系方式：*************第2页共16页

目录一、MQTT服务器搭建背景.................................................................................................................4二、搭建过程必备软件.........................................................................................................................5三、MQTT服务器搭建过程.................................................................................................................63.1、安装JAVA软件......................................................................................................................63.2、配置Windows上JDK的环境变量......................................................................................73.3、下载并安装Apache-Apollo服务器....................................................................................11四、MQTT私有服务器通讯测试.......................................................................................................13第3页共16页

一、MQTT服务器搭建背景我们知道，MQTT协议是广泛应用的物联网协议，使用测试MQTT协议需要MQTT的代理（即Broker）。有两种方法可以实现MQTT服务，一种是租用现成的MQTT服务器，如中国移动OneNET、阿里云，百度云，腾讯云、华为云等公用的云平台提供的MQTT服务，使用公用的MQTT服务器的好处是省事、安全级别高、性能良好。但有的企业产品商业保密性较高，不想数据上传至别人的云平台，或者有的初学者不想注册各种各样的开发者账号，想更快地学习MQTT通讯协议的，这些情况下，可以使用另一方法实现MQTT服务，即自己使用开源的MQTT组件来搭建私有的MQTT服务器。MQTT服务器MQTT服务器非常多，如apache的ActiveMQ、Apollo，emtqqd，HiveMQ，Emitter，Mosquitto，Moquette等。本文档以Apache-Apollo为例进行讲解，其他服务器搭建大同小异。第4页共16页

二、搭建过程必备软件本文档搭建的MQTT服务器以Windows64位的操作系统为平台，若读者电脑不是该类型系统，请自行寻找合适的发行版本软件替代，整体安装过程是一致的。搭建MQTT服务器，需要以下这几种软件的支撑：（1）JAVA软件（JDK）（2）Apache-Apollo服务器（3）MQTT客户端调试助手需要的软件不多，下面我们就开始一步步进行安装和配置。第5页共16页

三、MQTT服务器搭建过程3.1、安装JAVA软件在整个搭建之前，我们需要在系统中安装JAVA软件（JDK），并且要配置好环境变量。我们移步至Oracle公司的JDK下载官网，可以自行百度搜索“JDK”或者直接输入以下网址：/technetwork/java/javase/downloads/进入下图所示界面：我们的系统是Windows64的，因此我们下载红框中的文件即可。下载完成之后双击安装即可，笔者选择全部默认配置和路径安装，过程是傻瓜式的，一步第6页共16页

步往下进行即可，这里就不截图说明，读者若在安装的时候修改了路径，请自行记住，后续会用到。JDK安装成功之后，会在系统安装目录下出现两个文件夹，一个是jdkxxxx，另外一个是jrexxxx，如下图所示：打开jdk的安装目录下的bin目录，里面有许多后缀名为exe的可执行程序，这些都是JDK包含的工具。通过后面讲到的配置JDK的变量环境，我们可以方便地调用这些工具及它们的命令。3.2、配置Windows上JDK的环境变量根据实际使用需求，我们需要设置三个系统变量，分别是JAVA_HOME，CLASSPATH和Path。下面是这三个变量的设置方法。（1）JAVA_HOME我们先设置JAVA_HOME这个系统变量名称，变量值为JDK在你电脑上的安装路径。笔者的安装路径是：C:ProgramFilesJavajdk1.8.0_201，注意这里必须定位到jdkxxxx目录。点击“我的电脑”->右键“属性”->“高级系统设置”，出现以下界面：第7页共16页

我们点击“环境变量”按钮，继续进入下一级页面，如下所示，我们在“系统变量”分类中点击“新建”按钮，在弹出的提示框中输入以下内容。第8页共16页

JAVA_HOME，这里的变量名均为：但是变量值要依据自己的安装路径而定，笔者是默认路径安装，仅供参考。信息输入完成之后点击确认即可。（2）CLASSPATH接着我们在“环境变量”页面的“FrunPC的用户变量”分类中（其实在系统变量分类中创建也是可以的，看个人喜欢）点击“新建”按钮，在弹出的输入框中输入：变量名：CLASSPATH变量值：.;%JAVA_HOME%;%JAVA_HOME%注意变量值字符串前面有一个"."表示当前目录，设置CLASSPATH的目的，在于告诉Java执行环境，在哪些目录下可以找到你所要执行的Java程序所需要的第9页共16页

类或者包。信息填写完成之后点击确认即可。（3）Path继续在“环境变量”页面的“FrunPC的用户变量”分类中（其实在系统变量分类中创建也是可以的，看个人喜欢）点击“新建”按钮，在弹出的输入框中输入：变量名：PATH变量值：%JAVA_HOME%bin;%JAVA_HOME%jrebin信息填写完成之后点击确认即可。三个环境变量均配置完成之后，我们打开电脑CMD，输入：Java-version出现以下界面，说明我们的JAVA软件安装及环境变量配置大功告成，接下来我们安装Apache-Apollo服务器。第10页共16页

3.3、下载并安装Apache-Apollo服务器首先我们先下载Apache-Apollo，下载地址为：/apollo/下载完成之后将其解压至自己喜欢的目录，笔者的目录是：D:ApolloAPOLO。随后我们在cmd窗口，切换到D:ApolloAPOLObin目录下，创建一个Broker，输入命令：apollocreateD:ApolloAPOLOfrun-broker我们回头看APOLO文件夹下，会多一个“frun-broker”文件夹，这就是我们在cmd窗口创建的。第11页共16页

切换到创建好的broker目录下的bin目录。输入命令：即可运行MQTT服务器。看到上面的窗口，那么恭喜你，你的MQTT私有服务器搭建已经完成了，整个过程非常简单，这里我们只是以Windows64位操作系统平台为例子，实际上其他平台的大家也是一样的，包括如果读者自己租赁了一台云主机，也是可以这样搭建的，方法都是大同小异。搭建完成之后，下面我们开始测试我们搭建的MQTT服务器第12页共16页

四、MQTT私有服务器通讯测试需要我们搭建的MQTT私有服务器能否使用，最简单的方法就是采用MQTT客户端进行数据收发测试。这里我们使用本公司自主开发的MQTT客户端软件进行测试，读者也可以使用自己的软件或者网上第三方的客户端软件，视乎个人情况而定。我们打开我们的调试客户端“”，配置关键的信息。（1）服务器地址：是服务器的IP地址，这里为本机IP。（2）服务器端口：为apollo服务器tcp协议端口（默认61613为TCP连接的端口）。（3）设备ID：设备唯一标识符（这里可以随意填写，只要保证每个设备的ID不冲突即可）。（4）用户名和密码默认分别是admin、password。随后我们点击“连接”按钮，即可和刚才搭建的apollo服务器建立TCP连接。接着我们在订阅主题栏的输入框中输入要订阅的主题“/frun/test01”并点击“订阅主题”按钮，订阅该主题。第13页共16页

为了方便我们测试数据收发，我们再打开一个调试工具，并按照上述步骤填写信息，我们只需要改变设备ID，确保每一个设备的ID不冲突即可。设置完成后的界面如下所示：第14页共16页

我们设置这两个设备“互粉”，也就是设备ID“12345678”订阅的主题是设备ID“87654321”发布的主题；而设备ID“87654321”订阅的主题则是设备ID“12345678”发布的主题，这样就可以实现两个调试工具（MQTT客户端）之间的数据双向传输了。至此，MQTT私有服务器的搭建及通讯测试已经全部完成。第15页共16页