在物联网（IoT）应用中，消息队列遥测传输（MQTT）作为一种轻量级的消息协议，因其低带宽需求和高效传输特点，广泛应用于设备通信中。对于刚接触MQTT的开发者来说，了解如何在Spring Boot项目中集成MQTT客户端并建立连接是迈向实际应用的重要一步。今天，我将分享一个详细的入门指南，带你一步步在Spring Boot中建立MQTT连接，并通过JUnit进行简单的单元测试。

项目配置

首先，我们需要在pom.xml中配置Spring Boot的父依赖以及必要的MQTT和测试依赖。以下是一个示例配置：

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.0.5</version>
</parent><dependencies><!-- Spring Boot整合JUnit单元测试的起步依赖 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency><!-- MQTT Java客户端依赖 --><dependency><groupId>org.eclipse.paho</groupId><artifactId>org.eclipse.paho.client.mqttv3</artifactId><version>1.2.5</version></dependency></dependencies>

在这个配置中，我们引入了spring-boot-starter-test用于单元测试，以及org.eclipse.paho.client.mqttv3作为MQTT客户端库。这些依赖为我们后续的开发和测试提供了必要的基础。

编写MQTT测试类

接下来，我们在项目中创建一个测试类MqttPahoTest，用于测试MQTT连接的建立。以下是完整的代码示例：

java">package com.takumilove.mqtt.test;import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttException;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
import org.junit.jupiter.api.Test;/*** @author: Takumilove* @description: 通过JUnit测试，验证MQTT客户端与服务器的连接是否成功。* @date: 2024/12/13**/
public class MqttPahoTest {// MQTT服务器地址String serverURI = "tcp://156.238.***.***:1883";// 客户端IDString clientId = "paho_test";@Testpublic void createConnection() throws MqttException {// 创建MqttClient对象，使用内存持久化MqttClient mqttClient = new MqttClient(serverURI, clientId, new MemoryPersistence());// 配置连接选项MqttConnectOptions options = new MqttConnectOptions();options.setUserName("admin"); // 设置用户名options.setPassword("123456".toCharArray()); // 设置密码options.setCleanSession(true); // 设置是否清除会话// 连接到MQTT服务器mqttClient.connect(options);System.out.println("连接成功");// 让当前线程阻塞，保持连接while (true) ;}
}

代码解析

1. 导入必要的类：我们引入了MqttClient、MqttConnectOptions等类，这些都是Paho MQTT客户端库提供的，用于建立和管理MQTT连接。

2. 配置MQTT服务器信息：

   • serverURI：指定MQTT服务器的地址和端口。
   • clientId：为客户端生成一个唯一的ID。

3. 创建MQTT客户端：

   • 使用MqttClient构造函数，传入服务器URI、客户端ID以及持久化策略（这里使用内存持久化MemoryPersistence）。

4. 设置连接选项：

   • setUserName和setPassword：设置连接MQTT服务器所需的认证信息。
   • setCleanSession：决定是否清除会话，true表示每次连接都是新的会话。

5. 建立连接：

   • 调用connect方法，使用之前配置的选项与MQTT服务器建立连接。
   • 成功连接后，输出“连接成功”。

6. 保持连接：

   • 通过一个无限循环while (true);，保持当前线程不退出，以维持MQTT连接。

验证连接状态

成功运行上述测试类后，连接是否建立成功可以通过MQTT服务器的管理仪表盘进行验证。大多数MQTT服务器，如Mosquitto、HiveMQ等，都会提供一个仪表盘界面，用于监控当前连接的客户端。

在仪表盘中，你应该能够看到刚刚创建的客户端paho_test已经成功连接。连接状态通常会显示为“在线”或“已连接”，并且可能会显示一些连接细节，如客户端ID、连接时间等。通过这种方式，你可以直观地确认MQTT客户端与服务器之间的连接是否正常建立，为后续的消息发布和订阅操作奠定基础。

运行测试

确保你的MQTT服务器（例如Mosquitto）已经启动，并且能够接受来自客户端的连接。然后运行上述测试类，如果一切配置正确，你应该会在控制台看到“连接成功”的提示。同时，在MQTT服务器的仪表盘中，可以看到客户端paho_test的连接状态。

总结

通过以上步骤，我们成功地在Spring Boot项目中集成了MQTT客户端，并通过JUnit进行了简单的连接测试。