如何在Spring Boot项目中集成MQTT协议

更新时间：2025年06月24日 14:36:30 作者：getapi

本文介绍在SpringBoot中集成MQTT的步骤,包括安装Broker、添加Eclipse Paho依赖、配置连接参数、实现消息发布订阅、测试接口及注意事项,如唯一客户端ID、安全措施等,帮助开发者快速实现物联网通信,感兴趣的朋友一起看看吧

1. 准备工作

在开始之前，请确保以下条件已满足：

已安装并运行MQTT Broker（如 Eclipse Mosquitto 或 EMQX）。
Spring Boot项目已创建（可以通过 Spring Initializr 快速生成）。

2. 引入依赖

在pom.xml文件中添加必要的依赖项。我们使用 Eclipse Paho MQTT Client 作为MQTT客户端库。

<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <!-- Eclipse Paho MQTT Client -->
    <dependency>
        <groupId>org.eclipse.paho</groupId>
        <artifactId>org.eclipse.paho.client.mqttv3</artifactId>
        <version>1.2.5</version>
    </dependency>
</dependencies>

3. 配置MQTT连接

在application.yml或application.properties中配置MQTT相关参数，例如Broker地址、客户端ID等。

application.yml 示例：

mqtt:
  broker-url: tcp://localhost:1883
  client-id: springboot-mqtt-client
  username: mqtt_user
  password: mqtt_password
  topic: test/topic
  qos: 1

4. 创建MQTT配置类

创建一个配置类来初始化MQTT客户端，并设置连接选项、回调函数等。

import org.eclipse.paho.client.mqttv3.*;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MqttConfig {
    @Value("${mqtt.broker-url}")
    private String brokerUrl;
    @Value("${mqtt.client-id}")
    private String clientId;
    @Value("${mqtt.username}")
    private String username;
    @Value("${mqtt.password}")
    private String password;
    @Bean
    public MqttClient mqttClient() throws MqttException {
        MqttClient client = new MqttClient(brokerUrl, clientId, new MemoryPersistence());
        MqttConnectOptions options = new MqttConnectOptions();
        options.setCleanSession(true);
        options.setUserName(username);
        options.setPassword(password.toCharArray());
        options.setConnectionTimeout(10);
        options.setKeepAliveInterval(20);
        // 设置回调
        client.setCallback(new MqttCallback() {
            @Override
            public void connectionLost(Throwable cause) {
                System.out.println("MQTT连接丢失：" + cause.getMessage());
            }
            @Override
            public void messageArrived(String topic, MqttMessage message) throws Exception {
                System.out.println("收到消息 - 主题：" + topic + "，内容：" + new String(message.getPayload()));
            }
            @Override
            public void deliveryComplete(IMqttDeliveryToken token) {
                System.out.println("消息发送完成");
            }
        });
        // 连接到MQTT Broker
        client.connect(options);
        return client;
    }
}

5. 实现消息发布与订阅

创建服务类来处理消息的发布和订阅操作。

消息发布服务

import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class MqttPublishService {
    @Autowired
    private MqttClient mqttClient;
    @Value("${mqtt.topic}")
    private String topic;
    @Value("${mqtt.qos}")
    private int qos;
    public void publish(String payload) throws Exception {
        MqttMessage message = new MqttMessage(payload.getBytes());
        message.setQos(qos);
        mqttClient.publish(topic, message);
        System.out.println("消息已发布 - 主题：" + topic + "，内容：" + payload);
    }
}

消息订阅服务

import org.eclipse.paho.client.mqttv3.MqttClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class MqttSubscribeService {
    @Autowired
    private MqttClient mqttClient;
    @Value("${mqtt.topic}")
    private String topic;
    @Value("${mqtt.qos}")
    private int qos;
    public void subscribe() throws Exception {
        mqttClient.subscribe(topic, qos);
        System.out.println("已订阅主题：" + topic);
    }
}

6. 测试功能

在控制器中调用发布和订阅服务，测试MQTT功能。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/mqtt")
public class MqttController {
    @Autowired
    private MqttPublishService mqttPublishService;
    @Autowired
    private MqttSubscribeService mqttSubscribeService;
    @PostMapping("/publish")
    public String publishMessage(@RequestParam String message) {
        try {
            mqttPublishService.publish(message);
            return "消息发布成功";
        } catch (Exception e) {
            return "消息发布失败：" + e.getMessage();
        }
    }
    @GetMapping("/subscribe")
    public String subscribeTopic() {
        try {
            mqttSubscribeService.subscribe();
            return "订阅成功";
        } catch (Exception e) {
            return "订阅失败：" + e.getMessage();
        }
    }
}

7. 启动并测试

启动Spring Boot应用程序。
使用Postman或浏览器访问以下接口：
- 发布消息：POST http://localhost:8080/mqtt/publish?message=HelloMQTT
- 订阅主题：GET http://localhost:8080/mqtt/subscribe
检查控制台输出，验证消息是否正确发布和接收。

8. 注意事项

Broker地址：确保MQTT Broker的地址和端口正确无误。
客户端ID唯一性：每个MQTT客户端的clientId必须是唯一的，否则可能会导致连接冲突。
异常处理：在实际项目中，建议对MQTT连接和消息处理进行全面的异常捕获和日志记录。
安全性：生产环境中应启用TLS加密，并使用强密码保护MQTT Broker。

到此这篇关于如何在Spring Boot项目中集成MQTT协议的文章就介绍到这了,更多相关Spring Boot集成MQTT协议内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Netty实战源码解析NIO编程
这篇文章主要为大家介绍了Netty实战源码解析NIO编程的核心组件及关系详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-12-12
Java中的Kafka消费者详解
这篇文章主要介绍了Java中的Kafka消费者详解,Kafka是一个分布式流行消息系统,通常用于大规模数据处理和实时数据流应用程序,它具有高吞吐量、可扩展性和容错性的特点,需要的朋友可以参考下
2023-09-09
详解Java的Hibernat框架中的Map映射与SortedMap映射
这篇文章主要介绍了Java的Hibernat框架中的Map映射与SortedMap映射,Hibernat是Java的SSH三大web开发框架之一,需要的朋友可以参考下
2015-12-12
浅析如何在Java应用中优雅的发送短信
很多业务场景里,我们都需要发送短信,比如登陆验证码、告警、营销通知、节日祝福等等,这篇文章,我们聊聊 Java 应用中如何优雅的发送短信,文中有详细的代码示例供大家参考,需要的朋友可以参考下
2023-11-11
Java实现掷骰子控制台和窗体两种方法
这篇文章主要为大家详细介绍了Java实现掷骰子控制台和窗体两种方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-08-08
SpringMVC配置多个properties文件之通配符解析
这篇文章主要介绍了SpringMVC配置多个properties文件之通配符解析，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
jconsole使用介绍(图文)
大家在学习java的时候，难免会对jvm进行一些深入的了解。推荐大家使用jdk下面的jconsole.exe来辅助理解jvm的一些概念
2015-12-12
Maven配置多仓库无效的解决
在项目中使用Maven管理jar包依赖往往会出现很多问题，所以这时候就需要配置Maven多仓库，本文介绍了如何配置以及问题的解决
2021-05-05
java多线程和并发包入门示例
这篇文章主要写了java多线程的使用方法和java并发包简单入门的示例，大家可以参考使用
2013-11-11
关于nacos无法正常下线问题记录
这篇文章主要介绍了关于nacos无法正常下线问题记录,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-07-07