Paho MQTT JavaScript 客户端使用教程

白娥林

于 2025-04-01 09:27:21 发布

阅读量501

点赞数 17

本文链接：https://blog.youkuaiyun.com/gitblog_00181/article/details/146898992

版权

Paho MQTT JavaScript 客户端使用教程

paho.mqtt.javascript Paho.MQTT.JS: 一个用于 JavaScript 的 MQTT 客户端库，可用于在 Web 应用程序中实现 IoT 设备的连接和通信。项目地址: https://gitcode.com/gh_mirrors/pa/paho.mqtt.javascript

1. 项目的目录结构及介绍

Paho MQTT JavaScript 客户端项目的目录结构如下：

paho.mqtt.javascript/
├── src/                       # 源代码目录
│   ├── utility/               # 工具类目录
│   ├── tests/                 # 测试用例目录
│   ├── .eslintrc.json         # ESLint 配置文件
│   ├── .gitignore             # Git 忽略文件
│   ├── .project               # 项目配置文件
│   ├── .travis.yml            # Travis CI 配置文件
│   ├── CODE_OF_CONDUCT.md     # 行为准则
│   ├── CONTRIBUTING.md        # 贡献指南
│   ├── LICENSE                # 许可证文件
│   ├── NOTICE                 # 通知文件
│   ├── PULL_REQUEST_TEMPLATE.md # Pull Request 模板
│   ├── README.md              # 项目说明文件
│   ├── SECURITY.md            # 安全策略
│   ├── about.html             # 关于页面
│   ├── edl-v10                # 许可证文件
│   ├── epl-v10                # 许可证文件
│   ├── notice.html            # 通知页面
│   ├── package.json           # npm 包配置文件
│   ├── pom.xml                # Maven 构建配置文件
│   ├── runTests.sh            # 运行测试脚本
│   ├── start-broker.sh        # 启动代理脚本
│   └── travis.env             # Travis CI 环境变量文件
└── target/                    # 构建输出目录

src/: 源代码目录，包含了 JavaScript 客户端的所有核心代码。
utility/: 工具类目录，包含了项目所需的一些工具函数。
tests/: 测试用例目录，包含了用于验证客户端功能的测试代码。
.eslintrc.json: ESLint 配置文件，用于定义代码风格规则。
.gitignore: Git 忽略文件，用于指定 Git 应该忽略的文件和目录。
.project: 项目配置文件，用于配置开发工具的一些设置。
.travis.yml: Travis CI 配置文件，用于自动化测试和构建。
其他文件包括项目说明、许可证、贡献指南、安全策略等。

2. 项目的启动文件介绍

项目的启动主要是通过在浏览器中运行 HTML 文件来实现，以下是一个基本的 HTML 文件示例，用于启动 MQTT 客户端：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>Paho MQTT JavaScript 客户端示例</title>
</head>
<body>
    <script src="path/to/paho-mqtt.js"></script>
    <script>
        // 创建客户端实例
        var client = new Paho.Client(location.hostname, Number(location.port), "clientId");

        // 设置回调函数
        client.onConnectionLost = onConnectionLost;
        client.onMessageArrived = onMessageArrived;

        // 连接客户端
        client.connect({ onSuccess: onConnect });

        // 连接成功的回调函数
        function onConnect() {
            console.log("连接成功");
            client.subscribe("World");
            var message = new Paho.Message("Hello");
            message.destinationName = "World";
            client.send(message);
        }

        // 连接丢失的回调函数
        function onConnectionLost(responseObject) {
            if (responseObject.errorCode !== 0) {
                console.log("连接丢失：" + responseObject.errorMessage);
            }
        }

        // 消息到达的回调函数
        function onMessageArrived(message) {
            console.log("消息到达：" + message.payloadString);
        }
    </script>
</body>
</html>

在这个 HTML 文件中，我们通过 <script> 标签引入了 paho-mqtt.js 文件，然后创建了 MQTT 客户端实例，并设置了一系列的回调函数来处理连接、消息发送和接收等事件。

3. 项目的配置文件介绍

项目的主要配置文件是 package.json 和 pom.xml。

package.json: npm 包配置文件，定义了项目的依赖、脚本和元数据。例如：

{
  "name": "paho.mqtt.javascript",
  "version": "1.1.0",
  "description": "Paho MQTT JavaScript 客户端",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "jasmine"
  },
  "dependencies": {
    "some-dependency": "^1.0.0"
  }
}

pom.xml: Maven 构建配置文件，用于配置 Maven 构建过程。例如：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.eclipse.paho</groupId>
    <artifactId>mqtt-javascript</artifactId>
    <version>1.1.0</version>
    <build>
        <plugins>
            <!-- 构建插件配置 -->
        </plugins>
    </build>
</project>

这些配置文件提供了项目构建和运行所需的依赖和脚本指令。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考