SpringBoot集成MQTT实现交互服务通信

已于 2024-07-18 14:29:32 修改
阅读量702 收藏 13
点赞数 28
分类专栏： spring 文章标签： spring boot 交互 后端 mqtt
于 2024-07-18 00:01:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_40141628/article/details/140502559
版权

引言

本文是springboot集成mqtt的一个实战案例。
gitee代码库地址：源码地址

一、什么是MQTT

MQTT（Message Queuing Telemetry Transport，消息队列遥测传输协议），是一种基于发布/订阅（publish/subscribe）模式的“轻量级”通讯协议，该协议构建于 TCP/IP 协议上，由 IBM 于 1999 年发明。MQTT 协议的主要特征是开放、简单、轻量级和易于实现，这些特征使得它适用于受约束的应用环境，如：

网络受限：网络带宽较低且传输不可靠
终端受限：协议运行在嵌入式设备上，嵌入式终端的处理器、内存等是受限的

MQTT 非常适用于物联网领域，如传感器与服务器的通信、传感器信息采集等。

二、发布/订阅模式

发布/订阅模式（Publish/Subscribe Pattern，简称Pub/Sub）是一种消息通信模式，在这种模式下，消息的发送者（发布者）不会将消息直接发送给特定的接收者（订阅者）。而是将代表消息内容的通知（事件）发布到一个特定的主题或频道上，而订阅了这个主题的接收者会收到所有在这个主题上发布的通知。这种模式解耦了消息的发送者和接收者，使得系统更加灵活和可扩展。

主要组成部分

  1. 发布者（Publisher）：负责生成消息并将其发布到特定的主题或频道。

  2. 订阅者（Subscriber）：注册对特定主题的兴趣，并接收该主题上的所有消息。

  3. 消息代理（Message Broker）：作为中间件，它接收来自发布者的消息，并将这些消息传递给所有相关的订阅者。

优点

  • 解耦：发布者和订阅者之间不需要直接交互，这降低了系统的耦合度。

  • 灵活性：可以动态添加或删除订阅者，不影响其他组件。

  • 可扩展性：系统容易扩展，可以轻松增加新的发布者或订阅者。

缺点

  • 复杂性：引入了额外的组件（如消息代理），增加了系统的复杂性和管理成本。

  • 性能开销：消息的传递需要通过中间件，可能会有延迟和性能损失。

应用场景

  • 事件驱动架构：在微服务架构中，不同的服务通过发布/订阅模式进行异步通信。

  • 数据流处理：如实时数据分析，多个组件可以订阅数据流并进行处理。

  • 分布式系统：用于跨系统或跨服务的消息传递。

发布/订阅模式并不是 MQTT 协议特有的模式，很多消息中间件都有使用发布/订阅模式，有同学可能认为这就是观察者模式，还真不是，这两个模式很容易混淆。观察者模式只有观察者 + 被观察者两个角色，而发布/订阅模式还有一个经纪人 Broker；往更深层次的讲观察者和被观察者，是松耦合的关系，而发布者和订阅者，则完全不存在耦合。

三、Windows下安装MQTT消息服务器

非常遗憾，EMQ X Broker 在 5.4.0 版本的发行版中已不支持 windows 版本的安装包了，笔者从网上找了一个最后支持版本的压缩包，已上传资源。

  • 解压后，在bin文件下，使用cmd执行运行命令 .\emqx console
  • 访问MQTT管理页面 http://localhost:18083/#/ 用户名密码 admin/public

如果报错缺少Erlang环境，需要自行安装下该环境

在这里插入图片描述
在这里插入图片描述

浏览器访问：http://localhost:18083/#，输入账号密码进入，会要求你修改密码，可以暂时跳过

在这里插入图片描述

四、Windows安装MQTT消息代理客户端MQTTX

下载地址：MQTTX下载地址

点击免费下载
在这里插入图片描述

选择64位版本

在这里插入图片描述
下好后点击安装，启动运行界面如下：
在这里插入图片描述
语言是英文，可以在设置按钮里调成中文。这个客户端代理主要是进行消息发送的测试服务。

五、新建MQTT集成项目

随便新建了一个springboot应用，用的是JDK17，在pom文件中引入如下依赖：

        <!-- MQTT -->
        <dependency>
            <groupId>org.eclipse.paho</groupId>
            <artifactId>org.eclipse.paho.client.mqttv3</artifactId>
            <version>1.2.5</version>
        </dependency>

5.1 yml配置

server:
  port: 8081

#允许循环依赖
spring:
  main:
    allow-circular-references: true

customer:
  mqtt:
    broker: tcp://localhost:1883
    clientList:
      #发布客户端ID
      - clientId: nays_service
        #监听主题 同时订阅多个主题 使用 - 分割开
        subscribeTopic: mqtt/publish
        #用户名
        userName: admin
        #密码
        password: public
      #接收客户端ID
      - clientId: receive_service
        #监听主题 同时订阅多个主题 使用 - 分割开
        subscribeTopic: mqtt/receive
        #用户名
        userName: admin
        #密码
        password: public

5.2 Mqtt配置类

package com.hulei.mqttproject.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

import java.util.List;

/**
 * Mqtt配置类
 */
@Data
@Configuration
@ConfigurationProperties(prefix = "customer.mqtt")
public class MqttConfig {
    /**
     * mqtt broker地址
     */
    String broker;
    /**
     * 需要创建的MQTT客户端
     */
    List<MqttClient> clientList;
}

5.3 MQTT客户端

package com.hulei.mqttproject.config;

import lombok.Data;


/**
 * MQTT客户端
 */
@Data
public class MqttClient {
    /**
     * 客户端ID
     */
    private String clientId;
    /**
     * 监听主题
     */
    private String subscribeTopic;
    /**
     * 用户名
     */
    private String userName;
    /**
     * 密码
     */
    private String password;
}

5.4 MQTT客户端管理类

package com.hulei.mqttproject.config;

import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttException;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
import org.eclipse.paho.client.mqttv3.MqttClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * MQTT客户端管理类,如果客户端非常多后续可入redis缓存
 */
@Slf4j
@Component
public class MqttClientManager {

    @Value("${customer.mqtt.broker}")
    private String mqttBroker;

    @Resource
    private MqttCallBackContext mqttCallBackContext;
    /**
     * 存储MQTT客户端
     */
    public static Map<String, MqttClient> MQTT_CLIENT_MAP = new ConcurrentHashMap<>();

    public MqttClient getMqttClientById(String clientId) {
        return MQTT_CLIENT_MAP.get(clientId);
    }

    /**
     * 创建mqtt客户端
     *
     * @param clientId       客户端ID
     * @param subscribeTopic 订阅主题，可为空
     * @param userName       用户名，可为空
     * @param password       密码，可为空
     */
    public void createMqttClient(String clientId, String subscribeTopic, String userName, String password) {
        MemoryPersistence persistence = new MemoryPersistence();
        try {
            MqttClient client = new MqttClient(mqttBroker, clientId, persistence);
            MqttConnectOptions connOpts = new MqttConnectOptions();
            if (null != userName && !userName.isEmpty()) {
                connOpts.setUserName(userName);
            }

            if (null != password && !password.isEmpty()) {
                connOpts.setPassword(password.toCharArray());
            }

            connOpts.setCleanSession(true);

            if (null != subscribeTopic && !subscribeTopic.isEmpty()) {
                AbsMqttCallBack callBack = mqttCallBackContext.getCallBack(clientId);

                if (null == callBack) {
                    callBack = mqttCallBackContext.getCallBack("default");
                }

                callBack.setClientId(clientId);
                callBack.setConnectOptions(connOpts);
                client.setCallback(callBack);
            }

            //连接mqtt服务端broker
            client.connect(connOpts);
            // 订阅主题
            if (null != subscribeTopic && !subscribeTopic.isEmpty()) {
                if (subscribeTopic.contains("-"))
                    client.subscribe(subscribeTopic.split("-"));
                else {
                    client.subscribe(subscribeTopic);
                }
            }

            MQTT_CLIENT_MAP.putIfAbsent(clientId, client);
        } catch (MqttException e) {
            log.error("Create mqttClient failed!", e);
        }
    }
}

5.5 MQTT客户端创建

package com.hulei.mqttproject.config;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.util.List;

/**
 * MQTT客户端创建
 */
@Component
@Slf4j
public class MqttClientCreate {
    @Resource
    private MqttClientManager mqttClientManager;
    @Resource
    private MqttConfig mqttConfig;

    /**
     * 创建MQTT客户端
     */
    @PostConstruct
    public void createMqttClient() {
        List<MqttClient> mqttClientList = mqttConfig.getClientList();

        for (MqttClient mqttClient : mqttClientList) {
            log.info("{}", mqttClient);
            //创建客户端，客户端ID：demo，回调类跟客户端ID一致
            mqttClientManager.createMqttClient(mqttClient.getClientId(), mqttClient.getSubscribeTopic(), mqttClient.getUserName(), mqttClient.getPassword());
        }
    }
}

5.6 MQTT回调抽象类

package com.hulei.mqttproject.config;

import jakarta.annotation.Resource;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttMessage;

/**
 * MQTT回调抽象类
 */
@Setter
@Getter
@Slf4j
public abstract class AbsMqttCallBack implements MqttCallback {

    private String clientId;

    private MqttConnectOptions connectOptions;

    @Resource
    MqttClientManager mqttClientManager;

    /**
     * 失去连接操作,进行重连
     *
     * @param throwable 异常
     */
    @Override
    public void connectionLost(Throwable throwable) {
        try {
            if (null != clientId) {
                if (null != connectOptions) {
                    mqttClientManager.getMqttClientById(clientId).connect(connectOptions);
                } else {
                    mqttClientManager.getMqttClientById(clientId).connect();
                }
            }

        } catch (Exception e) {
            log.error("{} reconnect failed!", e.getMessage(), e);
        }
    }

    /**
     * 接收订阅消息
     * @param topic    主题
     * @param mqttMessage 接收消息
     * @throws Exception 异常
     */
    @Override
    public void messageArrived(String topic, MqttMessage mqttMessage) throws Exception {
		String content = new String(mqttMessage.getPayload());
     	handleReceiveMessage(topic, content);
    }

    /**
     * 消息发送成功
     *
     * @param iMqttDeliveryToken toke
     */
    @Override
    public void deliveryComplete(IMqttDeliveryToken iMqttDeliveryToken) {
        log.info("消息发送成功");
    }


    /**
     * 处理接收的消息
     * @param topic   主题
     * @param message 消息内容
     */
    protected abstract void handleReceiveMessage(String topic, String message);
}

5.7 MQTT订阅回调环境类

package com.hulei.mqttproject.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * MQTT订阅回调环境类
 */
@Component
@Slf4j
public class MqttCallBackContext {

    private final Map<String, AbsMqttCallBack> callBackMap = new ConcurrentHashMap<>();

    /**
     * 默认构造函数
     *
     * @param callBackMap 回调集合
     */
    public MqttCallBackContext(Map<String, AbsMqttCallBack> callBackMap) {
        this.callBackMap.putAll(callBackMap);
    }

    /**
     * 获取MQTT回调类
     *
     * @param clientId 客户端ID
     * @return MQTT回调类
     */
    public AbsMqttCallBack getCallBack(String clientId) {
        return this.callBackMap.get(clientId);
    }
}

5.8 默认回调类

package com.hulei.mqttproject.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

/**
 * 默认回调
 */
@Slf4j
@Component("default")
public class DefaultMqttCallBack extends AbsMqttCallBack {

    /**
     * @param topic   主题
     * @param message 消息内容
     */
    @Override
    protected void handleReceiveMessage(String topic, String message) {
        log.info("接收到主题---{}", topic);
        log.info("接收到消息---{}", message);
        // 自定义消息处理业务

    }
}

六、测试服务类

package com.hulei.mqttproject.controller;

import com.hulei.mqttproject.config.MqttClientManager;
import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class SendController {

    @Resource
    private MqttClientManager mqttClientManager;

    @RequestMapping("/sendMessage")
    public String sendMessage(String topic){
        try {
            MqttMessage mqttMessage = new MqttMessage("你好".getBytes());
            mqttClientManager.getMqttClientById("nays_service").publish(topic,mqttMessage);
            return "发送成功";
        } catch (Exception e) {
            log.error("发送失败",e);
            return "发送失败";
        }
    }
}

七、启动springboot

启动日志可以看到，mqtt消息服务器连接成功

在这里插入图片描述
EMQX工具显示发布客户端和接收客户端均已成功注册

在这里插入图片描述

使用Apifox测试下SendController中的接口，mqtt/receive是yaml中接收客户端订阅的主题，当然也可以往mqtt/publish主题发，mqtt中消息的发布者也可以订阅主题，监听某些消息。

在这里插入图片描述

在这里插入图片描述

熊出没
关注
  • 28
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot整合mqtt实现客户端之间的交互
01-26
这样的实现允许后端服务作为MQTT客户端与其他客户端进行通信，可以广泛应用于IoT场景，如智能家居、远程监控等领域。同时，结合Spring Boot的自动化配置和强大的扩展性，我们可以根据实际需求定制更复杂的交互逻辑和...
使用SpringBoot项目对接mqtt实现发布者与订阅者进行消息处理
10-14
结合MQTT（Message Queuing Telemetry Transport）协议，我们可以构建高效的消息传递系统，实现发布者与订阅者之间的实时通信。本文将深入探讨如何利用Spring Boot与MQTT进行集成，以实现发布和订阅功能。 首先，...
springboot集成MQTT,物联网通信
Alan_ran的博客
11-06 2340
一、MQTT基础理论了解 目前在做的项目里边涉及到了物联网这一块，在进行服务器和设备端通信的时候，用到了mqtt这一通信协议，既然要用到一门技术，首先要了解技术的基础原理->(3条消息) MQTT--入门_似水流年-CSDN博客_mqtthttps://blog.csdn.net/qq_28877125/article/details/78325003 二、搭建MQTT服务器并模拟简单通信 一脸懵逼的看完原理之后，一脸懵逼的出来了，莫慌，我们可以通过接下来的简单操作快...
SpringBoot集成MQTT协议
初念初恋的博客
01-03 775
MQTT 可以被解释为一种低开销，低带宽占用的即时通讯协议，可以用较少的代码和带宽为远程设备连接提供实时可靠的消息服务，它适用于硬件性能低下的远程设备以及网络状况糟糕的环境下，因此 MQTT 协议在 IoT（Internet of things，物联网），小型设备应用，移动应用等方面有较广泛的应用。优点：代码量少，开销低，带宽占用小，即时通讯协议。
Springboot整合Mqtt
m0_63600788的博客
05-30 916
MQTT（Message Queuing Telemetry Transport）是一种轻量级的发布/订阅消息传输协议，专为资源受限设备和低带宽、不可靠的网络环境设计。它特别适用于物联网（IoT）应用，广泛应用于传感器通信、远程监控、消息通知等场景。
SpringBoot整合MQTT总结
热门推荐
自我总结，分享所有，快乐每一天
01-25 3万+
目录 前言： 一、什么是mqtt 二、主要思想 发布/订阅模式 三、MQTT重要概念 3.1 MQTT Client 3.2 MQTT Broker 3.3 MQTT Connection 3.4 MQTT主要参数 四、软件和Apollo 4.1 安装Apollo 4.2安装Postman 4.3 安装MQTTBox 五、代码实现 5.1 配置pom.xml 5.2 配置MQTT服务器基本信息 5.3 配置读取yml文件的类MqttConfiguration 5.4...
SpringBoot实现MQTT消息发送和接收
大猩猩的博客
08-22 9421
SpringBoot实现MQTT消息发送和接收。
springboot整合mqtt实现消息发送和消费，以及客户端断线重连之后的消息恢复
weixin_45614461的博客
08-02 5426
参考资料： http://mqtt.p2hp.com/mqtt311 https://mcxiaoke.gitbooks.io/mqtt-cn/content/mqtt/02-ControlPacketFormat.html https://blog.csdn.net/anxianfeng55555/article/details/80908795 MQTT简介 ​ MQTT是一种基于发布/订阅模式的轻量级通讯协议，该协议构建在TCP/IP协议上。 MQTT最大的有点在于可以以极少的代码和有限的带宽，为远程
.Springboot+mqtt物联网开发
PJ老文的博客
03-25 7687
1.开篇聊聊，本人之前从事通信软件开发，对高并发和限流等有一定的实战，不过最近做物联网项目，这里聊聊怎么用mqtt进行双向通信，后面大家对通信开发有兴趣的也可以关注下本人博客！！！ 进入主题： 目前市面上有几种mqtt的开源项目，本人觉得emqtt这款开源的项目好用，是EMQTT， Erlang MQTT消息服务器简称EMQTT。 EMQTT是采用Erlang语言开发，全面支持...
物联网：SpringBoot 集成Websocket 前后端客户端 及 mqtt 实现设备联动
u014212540的博客
06-24 4760
SpringBoot 集成WebSocket 客户端/服务端，及mqtt
SpringBoot整合EMQX（MQTT协议）
SherlockerSun的博客
08-02 1万+
MQTT 全称为 Message Queuing Telemetry Transport（消息队列遥测传输），是一种基于 发布/订阅 模式的 轻量级物联网消息传输协议。
SpringBoot集成mqtt上下线提醒功能设计
最新发布
06-08
在本文中，我们将深入探讨如何在SpringBoot应用中集成MQTT（Message Queuing Telemetry Transport）协议，实现设备上线和下线的提醒功能。MQTT是一种轻量级的发布/订阅消息传输协议，广泛用于物联网(IoT)场景，因为...
MQTT+springboot 订阅/发布 多主题
06-28
在描述中提到的“Springboot集成MQTT，订阅发布一体，提供接口可发布主题”，这意味着开发人员已经创建了一个服务，该服务不仅具备订阅MQTT主题并处理接收到的消息的能力，还可以通过定义的API接口来主动发布消息到...
springboot-mqtt-master.rar
06-16
这个项目对于学习如何在SpringBoot应用中集成MQTT订阅发布功能，以及了解如何利用Apollo实现配置管理非常有帮助。开发者可以通过阅读源代码，理解如何配置和调用MQTT客户端API，以及如何与Apollo配置中心交互。
Springboot_MQTT.zip
06-24
通过结合这些工具和资源，开发者可以快速了解如何在Spring Boot环境中集成MQTT，并进行实际的订阅和发布操作。 综上所述，这个压缩包提供的资源对于想要学习和实践Spring Boot与MQTT集成的开发者来说非常有价值。它...
springboot整合mqtt
03-31
在SpringBoot项目中集成MQTT，可以方便地构建生产者和消费者，以便进行数据的发送和接收。 首先，我们需要在`pom.xml`文件中添加相应的依赖。SpringBoot提供了Spring Integration MQTT模块，它允许我们轻松地与MQTT...
SpringBoot项目 JAVA MQTT通信
12-28
在SpringBoot项目中集成MQTT，可以方便地实现设备间的数据交换和远程控制，尤其适用于资源受限的环境。 首先，让我们了解一下SpringBoot项目的基本结构。SpringBoot是基于Spring框架构建的，旨在简化微服务开发。它...
SpringBoot整合MQTT总结.pdf
06-10
【SpringBoot整合MQTT总结】 本文将探讨SpringBoot与MQTT的集成，以及MQTT协议的基本概念和...在设计和实现过程中，理解并熟练运用MQTT协议和SpringBoot的集成机制，能够帮助开发者构建出高效、可靠的IoT解决方案。
springboot集成mqtt服务器
09-14
要在Spring Boot项目中集成MQTT服务器，你可以按照以下步骤进行操作： 1. 首先，在项目的pom.xml文件中添加所需的依赖。根据引用中的内容，在<dependencies>标签中添加以下依赖项： ```xml <dependency> <groupId>org.springframework.integration</groupId> <artifactId>spring-integration-stream</artifactId> </dependency> <dependency> <groupId>org.springframework.integration</groupId> <artifactId>spring-integration-mqtt</artifactId> </dependency> ``` 2. 接下来，配置MQTT服务器的基本信息。根据引用中的说明，你需要提供MQTT服务器的地址、端口、用户名和密码等信息。你可以在Spring Boot的配置文件（如application.properties或application.yml）中添加以下配置： ``` spring.mqtt.username=your-username spring.mqtt.password=your-password spring.mqtt.url=tcp://your-mqtt-server:1883 ``` 请将"your-username"、"your-password"和"your-mqtt-server"替换为实际的值。 3. 现在，你可以在你的Spring Boot项目中使用MQTT。你可以创建一个消息处理类，用于接收和发送MQTT消息。你可以使用Spring Integration提供的MQTT适配器来简化与MQTT服务器的交互。你可以参考Spring Integration的文档和示例代码来了解如何使用MQTT适配器。 这样，你就可以在Spring Boot项目中成功集成MQTT服务器了。记得根据你的实际情况修改配置信息和代码。祝你成功！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值