SpringBoot中使用MQTT实现消息的订阅和发布(示例代码)

      <!--mqtt相关依赖-->
        <dependency>
            <groupid>org.springframework.integration</groupid>
            <artifactid>spring-integration-mqtt</artifactid>
            <version>5.5.14</version>
        </dependency>

#mqtt
mqtt:
  mqtturl: tcp://127.0.0.1
  mqttport: 1883
  mqttusername: admin
  mqttpassword: public
  mqttclientid: aaa
# mqtt回调类型 按一个mqtt服务区分
# 如果mqtt服务端换了 回调处理的是新的业务需求  就把这个换了
#  然后在mqtt配置文件中扩展新的回调类
mqtttypecallback: breakercallback  

package com.xxx.iotjava.mqtt.config;
import com.xxx.iotjava.mqtt.callback.breakercallback;
import lombok.extern.slf4j.slf4j;
import org.eclipse.paho.client.mqttv3.*;
import org.eclipse.paho.client.mqttv3.persist.memorypersistence;
import org.springframework.beans.factory.annotation.value;
import org.springframework.context.annotation.configuration;
import org.springframework.util.stringutils;
/**
 * user:json
 * date: 2024/6/17
 **/
@configuration
@slf4j
public class mqttconfig {
    @value("${mqtt.mqttusername}")
    private string mqttusername;
    @value("${mqtt.mqttpassword}")
    private string mqttpassword;
    @value("${mqtt.mqtturl}")
    private string mqtturl;
    @value("${mqtt.mqttport}")
    private integer mqttport;
    @value("${mqtt.mqttclientid}")
    private string mqttclientid;
    @value("${mqtttypecallback}")
    private string mqtttypecallback;
    private static string breakercallback = "breakercallback";
    /**
     * 客户端对象
     */
    private mqttclient client;
    /**
     * 客户端连接服务端
     * 目前只支持一个 mqtt服务端 如果后续一个项目有多个mqtt服务端那就设计成工厂模式
     */
    public boolean connect() {
        if (ismqtt()){
            return false;
        }
        try {
            //new memorypersistence() 使用内存持久化
            // 优点：不会在文件系统中创建任何文件（如 .lck 文件），适合对会话持久性没有要求的场景。
            // 缺点:  客户端断开连接或重启后，会话数据会丢失，无法保留订阅信息和未发送的消息
           // string persistencedirectory = "/path/to/your/mqtt/persistence";
            //new mqttdefaultfilepersistence(persistencedirectory) 使用文件持久化
             //如果persistencedirectory 不写 他默认创建 根目录 linux要给权限
            // 优点: 客户端断开连接或重启后，能够保留订阅信息和未发送的消息。这对于需要保持会话状态的应用非常重要
            // 缺点 会在指定的目录中创建文件（如 .lck 文件），需要确保指定的目录是有效的，并且应用有权限访问该目录
            //创建mqtt客户端对象
            client = new mqttclient(mqtturl + ":" + mqttport, mqttclientid,new memorypersistence());
            //连接设置
            mqttconnectoptions options = new mqttconnectoptions();
            //是否清空session，设置false表示服务器会保留客户端的连接记录（订阅主题，qos）,客户端重连之后能获取到服务器在客户端断开连接期间推送的消息
            //设置为true表示每次连接服务器都是以新的身份
            //如果他为true 会出现一个问题 
            //当网络断开后，客户端会进行重连，但是重连之前订阅的主题就失效了，不再接受之前订阅主题的消息。
             //因为配置里将cleansession 设为 true ，当客户端掉线时 ，
            //服务器端会清除 客户端 session 。 重连后 客户端会有一个新的session。 
            // 所以如果大家把他为true 重新连接mqtt后，要注意需要手动再订阅一下主题
            // 推荐文档：https://www.cnblogs.com/a-yes/p/9894144.html
            options.setcleansession(true);
            //设置连接用户名
            options.setusername(mqttusername);
            //设置连接密码
            options.setpassword(mqttpassword.tochararray());
            options.setautomaticreconnect(true);  // 启用自动重连
            //设置超时时间，单位为秒  如果在指定的时间内未能建立连接，客户端会放弃连接尝试并抛出异常。
            options.setconnectiontimeout(100);
            //设置心跳时间 单位为秒，表示服务器每隔 1.5*20秒的时间向客户端发送心跳判断客户端是否在线
            options.setkeepaliveinterval(20);
            //设置遗嘱消息的话题，若客户端和服务器之间的连接意外断开，服务器将发布客户端的遗嘱信息
            //  options.setwill("willtopic",(mqttclientid + ":与服务器断开连接").getbytes(),0,false);
            if (stringutils.isempty(mqtttypecallback)) {
                log.error("mqtt回调类型为空，请去java_config配置文件配置！");
            }
            //设置回调
            if (breakercallback.equals(mqtttypecallback)) {
                //断路器回调
                client.setcallback(new breakercallback());
            }
            client.connect(options);
            return true;
        } catch (mqttexception e) {
            log.error("mqtt启动报错：" + e.getmessage());
            e.printstacktrace();
            return false;
        }
    }
    /**
     * qos
     * 0  最多一次传递【适用于对消息丢失不敏感的场景，如传感器数据频繁发送，可以接受偶尔的数据丢失】
     * 1 至少一次传递  【消息至少传递一次，但可能会重复（即重复消息）】
     * 2 仅一次传递 【消息确保仅传递一次，既不会丢失也不会重复。】
     * retained
     * 保留消息：如果 retained 参数设置为 true，消息会被代理保留。代理将记住这个消息，并在新客户端订阅该主题时立即发送这个消息。
     * 非保留消息：如果 retained 参数设置为 false，消息不会被保留，只会发送给当前在线并订阅该主题的客户端。
     * topic    主题
     * message  内容
     */
    public void publish(int qos, boolean retained, string topic, string message) {
        log.info("topic为:【"+topic+"】,qos为：【"+qos+"】 mqtt 发布数据为："+message);
        mqttmessage mqttmessage = new mqttmessage();
        mqttmessage.setqos(qos);
        mqttmessage.setretained(retained); //代理将记住这个消息，并在新客户端订阅该主题时立即发送这个消息。
        mqttmessage.setpayload(message.getbytes());
        //主题的目的地，用于发布信息
        mqtttopic mqtttopic = client.gettopic(topic);
        mqttdeliverytoken token;
        try {
            //将指定消息发布到主题，但不等待消息传递完成，返回的token可用于跟踪消息的传递状态
            token = mqtttopic.publish(mqttmessage);
            //token.waitforcompletion(); // 等待完成 会堵塞
        } catch (mqttexception e) {
            log.warn("clientid【" + mqttclientid + "】发布失败！主题【" + topic + "】，发布数据为：" + message);
            e.printstacktrace();
        }
    }
    /**
     * 断开连接
     */
    public void disconnect() {
        try {
            client.disconnect();
        } catch (mqttexception e) {
            e.printstacktrace();
        }
    }
    /***
     *  手动连接
     *  可用于断线后 手动重连
     * ***/
    public boolean againconnect() {
        try {
            if (client != null && !client.isconnected()) {
                client.connect();
            }
            return true;
        } catch (mqttexception e) {
            e.printstacktrace();
            return false;
        }
    }
    //验证是否启动mqtt连接
    private boolean ismqtt(){
        if (stringutils.isempty(mqtturl) || stringutils.isempty(mqttport)
                || stringutils.isempty(mqttusername) || stringutils.isempty(mqttpassword)
                || stringutils.isempty(mqttclientid)
        ) {
            log.info("==========mqtt 参数不全，无需启动mqtt连接==================");
            return true;
        }
        return false;
    }
    /**
     * 订阅指定主题
     * @param topic 订阅的主题
     * @param qos   订阅的服务质量
     */
    public boolean subscribe(string topic, int qos) {
        if (ismqtt()){
            return false;
        }
        try {
            if (client != null && client.isconnected()) {
                client.subscribe(topic, qos);
                log.info("订阅主题 {} 成功！", topic);
            } else {
                log.error("mqtt客户端尚未连接，无法订阅主题 {}！", topic);
            }
            return true;
        } catch (mqttexception e) {
            log.error("订阅主题 {} 失败：{}", topic, e.getmessage());
            e.printstacktrace();
            return false;
        }
    }
    /**
     * 批量订阅主题
     *  消息等级，和主题数组一一对应，服务端将按照指定等级给订阅了主题的客户端推送消息
     * @param topic 订阅的主题集合
     * @param qos   订阅的服务质量集合
     */
    public boolean subscribe(string[] topic, int[] qos) {
        if (ismqtt()){
            return false;
        }
        try {
            if (client != null && client.isconnected()) {
                client.subscribe(topic, qos);
                log.info("订阅主题 {} 成功！", topic);
            } else {
                log.error("mqtt客户端尚未连接，无法订阅主题 {}！", topic);
            }
            return true;
        } catch (mqttexception e) {
            log.error("订阅主题 {} 失败：{}", topic, e.getmessage());
            e.printstacktrace();
            return false;
        }
    }
}

package com.xxx.iotjava.mqtt.callback;
import com.alibaba.fastjson.json;
import com.alibaba.fastjson.jsonobject;
import com.xxx.iotjava.entities.breakerdata;
import com.xxx.iotjava.enums.breaker.breakerkeywordsenum;
import com.xxx.iotjava.enums.breaker.breakerkeywordsvalueenum;
import com.xxx.iotjava.enums.breaker.breakeroperationenum;
import com.xxx.iotjava.service.inteface.ibreakerdataservice;
import lombok.extern.slf4j.slf4j;
import org.eclipse.paho.client.mqttv3.*;
import com.alibaba.fastjson.jsonarray;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.stereotype.component;
import org.springframework.util.objectutils;
import org.springframework.util.stringutils;
/**
 * user:json
 * date: 2024/6/17
 **/
@component
@slf4j
public class breakercallback implements mqttcallback {
    @autowired
    ibreakerdataservice ibreakerdataservice;
    /**
     * 与服务器断开的回调 
     *  这里可以做手动连接 但是配置config类 配置了 自动检测异常 true 这里可以也不做
     *      options.setautomaticreconnect(true);  // 启用自动重连
     */
    @override
    public void connectionlost(throwable throwable) {
        log.error("mqtt连接有异常：" + throwable.getmessage());
    }
    /**
     * 订阅的回调
     * 消息到达的回调
     * 注意 如果这个回调方法 如果有异常 报错 ，mqtt会重新连接 
     * 因为配置文件 设置了  options.setautomaticreconnect(true);  // 启用自动重连
     * 如果自动重连了 如果是开启新的会话 以前的订阅会消失  具体操作 再上面的配置文件类说明过了
     */
    @override
    public void messagearrived(string topic, mqttmessage mqttmessage) throws exception {
//        system.out.println("上报时间："+ localdatetime.now());
//        system.out.println(string.format("接收消息主题 : %s",topic));
//        system.out.println(string.format("接收消息qos : %d",mqttmessage.getqos()));
//        system.out.println(string.format("接收消息内容 : %s",new string(mqttmessage.getpayload())));
//        system.out.println(string.format("接收消息retained : %b",mqttmessage.isretained()));
    }
    /**
     * 发布的回调
     * 消息发布成功的回调
     */
    @override
    public void deliverycomplete(imqttdeliverytoken token) {
        imqttasyncclient client = token.getclient();
        log.info(client.getclientid() + "发布消息成功！");
    }
}

package com.xxx.iotjava.utils;
import com.xxx.init.utils.appcontextutil;
import com.xxx.iotjava.enums.breaker.breakeroperationtopicenum;
import com.xxx.iotjava.mqtt.config.mqttconfig;
import lombok.extern.slf4j.slf4j;
/**
 * user:json
 * date: 2024/6/17
 **/
@slf4j
public class mqttutils {
    private static mqttconfig mqttconfig;
    public static mqttconfig getmqttconfig() {
        if (mqttconfig == null)
            mqttconfig = appcontextutil.getbean(mqttconfig.class);
        return mqttconfig;
    }
    //初始化 订阅
    public  static boolean subscribeinit(){
        return getmqttconfig().subscribe(breakeroperationtopicenum.reporting_api.gettopic(), 0);
    }
    /**
     * 发送消息
     * qos 0 最多一次传递  1 至少一次传递  2 仅一次传递
     * retained  true 保留消息  false 非保留消息
     * topic    主题
     * message  内容
     */
    public static boolean sendmqttmsg(int qos, boolean retained, string topic, string message) {
        try {
            getmqttconfig().publish(qos, retained, topic, message);
            return true;
        } catch (exception e) {
            e.printstacktrace();
            log.error("mqtt发送消息报错：" + e.getmessage());
            return false;
        }
    }
    /*
     * topic 主题
     * message 内容
     * */
    public static boolean sendmqttmsg(string topic, string message) {
        return sendmqttmsg(1, false, topic, message);
    }
}