SpringBoot 2.7 整合 MQTT：实战代码解析

随着物联网(IoT)应用的迅速发展，消息传递协议在设备间通信中扮演着至关重要的角色。MQTT（Message Queuing Telemetry Transport）作为一项专门为低带宽、高延迟网络环境设计的轻量级发布/订阅协议，以其高效、可靠和易于部署的特点，成为众多物联网项目中的首选。本文将引导您使用SpringBoot 2.7.13版本，结合org.eclipse.paho.client.mqttv3库，实现对MQTT的无缝整合，并通过详实的代码示例展示客户端的生成与消息消费过程。

一、环境准备确保您的开发环境中已安装以下组件：

1. Java Development Kit (JDK)：版本至少为11或更高。

2. SpringBoot 2.7.13：可以通过Spring Initializr快速创建项目，或手动添加依赖至已存在的项目中。

3. Maven/Gradle：作为项目构建工具，用于管理依赖关系。

4. MQTT Broker：如EMQX、Mosquitto、HiveMQ等，本文将以本地运行的EMQX为例。

1.1 添加Maven依赖

在SpringBoot项目的pom.xml文件中添加org.eclipse.paho.client.mqttv3依赖：

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.eclipse.paho</groupId>
<artifactId>org.eclipse.paho.client.mqttv3</artifactId>
<version>1.2.5</version> <!-- 或使用最新稳定版本 -->
</dependency>
</dependencies>

二、SpringBoot整合MQTT配置在application.properties或application.yml中配置MQTT客户端连接参数：

spring.mqtt.host=localhost
spring.mqtt.port=1883
spring.mqtt.username=admin
spring.mqtt.password=123456
spring.mqtt.client-id=test-client
spring.mqtt.default-topic=my/topic

三、创建MQTT客户端服务创建一个MqttClientService类，用于封装MQTT客户端的连接、发布、订阅逻辑：

import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
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.MqttMessage;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MqttClientConfig {

@Value("${spring.mqtt.host}")
private String host;

@Value("${spring.mqtt.port}")
private int port;

@Value("${spring.mqtt.username}")
private String username;

@Value("${spring.mqtt.password}")
private String password;

@Value("${spring.mqtt.client-id}")
private String clientId;

@Bean
public MqttClient mqttClient() throws MqttException {
MqttClient client = new MqttClient("tcp://" + host + ":" + port, clientId, new MemoryPersistence());
MqttConnectOptions options = new MqttConnectOptions();
options.setUserName(username);
options.setPassword(password.toCharArray());

client.connect(options);

return client;
}

@Bean
public MqttCallback mqttCallback() {
return new MqttCallback() {
@Override
public void connectionLost(Throwable cause) {
System.out.println("MQTT connection lost: " + cause.getMessage());
}

@Override
public void messageArrived(String topic, MqttMessage message) throws Exception {
System.out.printf("Received message on topic '%s': %s%n", topic, new String(message.getPayload()));
}

@Override
public void deliveryComplete(IMqttDeliveryToken token) {
System.out.println("Delivery of message with token " + token + " completed.");
}
};
}
}

四、客户端消息生成与发布在控制器或其他业务逻辑中使用

MqttClientService发布消息：

import org.eclipse.paho.client.mqttv3.MqttClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MessageController {

@Autowired
private MqttClient mqttClient;

@GetMapping("/publish")
public String publishMessage() {
try {
String messagePayload = "Hello from SpringBoot MQTT Publisher!";
MqttMessage message = new MqttMessage(messagePayload.getBytes());
mqttClient.publish("my/topic", message);
return "Message published successfully.";
} catch (MqttException e) {
return "Error publishing message: " + e.getMessage();
}
}
}

 

五、客户端消息订阅与消费在MqttClientService中实现消息订阅逻辑：

import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
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.MqttMessage;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MqttClientConfig {

// ... (previous configuration)

@Bean
public MqttClient mqttClient() throws MqttException {
// ... (previous mqttClient bean definition)

mqttClient.setCallback(mqttCallback());
mqttClient.subscribe("my/topic");

return client;
}

// ... (previous mqttCallback bean definition)
}

至此，您已经完成了SpringBoot 2.7.13与MQTT（org.eclipse.paho.client.mqttv3库）的整合。当访问/publish端点时，会向my/topic主题发送一条消息；同时，由于订阅了同一主题，客户端会在收到消息时通过MqttCallback回调函数打印接收到的消息内容。在实际应用中，您可以根据需求进一步优化消息处理逻辑，例如将消息投递至消息队列、触发业务事件、更新数据库状态等。此外，确保在生产环境中正确配置MQTT Broker的安全性和性能参数，以保证系统的稳定性和数据安全性。注意： 以上代码仅为示例，实际使用时请根据项目需求和MQTT Broker的实际配置进行调整。务必遵循良好的编程实践，如异常处理、资源管理等。在集成过程中，建议查阅Spring Boot官方文档及org.eclipse.paho.client.mqttv3库的最新API文档以获取更详细的使用指导和最佳实践

。