MQTT -Groovy模板

## MQTT Groovy模板
```groovy
package eap5csxm.XiaoXiZhongXin.MQTT.groovy

import com.zhc.eap.config.mqtt.EapMqttConfig
import com.zhc.eap.config.mqtt.MqttGroovyConfig
import com.zhc.eap.config.mqtt.MqttItemConfig
import com.zhc.eap.config.mqtt.MqttSubConfig
import com.zhc.eap.config.mqtt.MqttTopicConfig
import com.zhc.eap.utils.MqttUtil
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import com.zhc.eap.mqtt.MqttContext;
import com.zhc.eap.exception.MqttRtException;

/**
 * MQTT消息订阅
 *
 * @author hzl
 * @date 2023-07-07
 */
class MQTT {
    private Logger logger = LoggerFactory.getLogger("MQTT.groovy")

//logger.info("日志信息"); 输日志
    //com.zhc.eap.util.ExceptionUtil.throwMessage(entityCo.get("controlDesc")); 抛异常
    //event-placeholder

/**
     * 初始化
     * @param mqttContext 上下文
     * @throws Exception
     */
    public void initializer(MqttContext mqttContext) throws Exception {
        //调用后端初始化环境及订阅
        MqttUtil.initializer(getSubMqttConfig());
        //初始化发布客户端
        MqttUtil.createMqttClient(getPubMqttConfig(),true);
    }

/**
     * 重新加载(一般用来动态实时订阅)
     * @throws Exception
     */
    public void reload(MqttContext context) {
        //获取mqtt订阅配置(可以与初始化的配置一样，也可以单独只处理新的主题订阅)
        MqttItemConfig mqttConfig = getSubMqttConfig();
        //调用后端动态实时加载订阅主题
        MqttUtil.reload(mqttConfig);
    }

/**
     * 消费
     * @param mqttContext 上下文
     * @throws Exception
     */
    public void consume(MqttContext mqttContext) throws Exception {
        //获取发布配置
        //EapMqttConfig mqttConfig = getPubMqttConfig();
        //长连接发布
        //MqttUtil.publish(mqttConfig, "donge");
        //一次发布
        //MqttUtil.oncePublish(mqttConfig, "donge");

//获取客户端对象
        //MqttClient client = mqttContext.getClient()
        //获取当前订阅的主题
        //String topic = mqttContext.getTopic();
        //获取当前主题配置
        //MqttTopicConfig topicConfig = mqttContext.getTopicConfig();
        //mqtt消息对象(官方对象)
        //MqttMessage message = mqttContext.getMessage()
        //获取消息字符串
        //String msg = mqttContext.getMsg()
        //获取消息字节数组(有些场景不需要转string，会乱码)
        //byte[] payload = mqttContext.getPayload();

//处理你的业务逻辑，这里示例抛异常验证是否订阅成功
        throw new MqttRtException(mqttContext.getMsg());
    }

/**
     * 获取mqtt配置
     * @return
     */
    private MqttItemConfig getSubMqttConfig() {
        //连接配置
        MqttItemConfig mqttConfig = new MqttItemConfig();
        //客户端ID(确保唯一，否则会被踢出)
        mqttConfig.setClientId("mqtt1");
        mqttConfig.setHost("tcp://192.168.4.106:1883");
        mqttConfig.setUserName("xxx");
        mqttConfig.setPassword("xxx");
        //设置连接超时
        mqttConfig.setTimeOut(30);
        //设置会话心跳时间单位为秒，服务器会每隔1.5*20秒的时间向客户端发送个消息判断客户端是否在线，但这个方法并没有重连的机制
        mqttConfig.setKeepAlive(60);
        // 是否清空session
        // 设置为false表示服务器会保留客户端的连接记录（订阅主题，qos），客户端重连之后能获取到服务器在客户端断开连接期间推送的消息
        // 设置为true表示每次连接到服务端都是以新的身份
        mqttConfig.setCleanSession(false);
        //设置自动重连
        mqttConfig.setAutomaticReconnect(true);

//回调groovy配置
        MqttGroovyConfig groovy = new MqttGroovyConfig();
        groovy.setProjectName("eap5csxm");
        groovy.setDevGroup("admin");
        groovy.setPath("eap5csxm/XiaoXiZhongXin/MQTT/groovy/MQTT.groovy");
        groovy.setMethod("consume");

//订阅配置
        MqttSubConfig subConfig = new MqttSubConfig();
        /**
         * 0：至多一次，客户机将在发布消息的同时废弃此消息。会发生消息丢失。 这一级别可用于如下情况,如环境传感器数据，
         * 这种情况下，丢失一次读记录无所谓,因为第二个 数据的发布紧跟其后
         * 1：至少一次，确保消息到达,但可能发生消息重复。（那么此消息为持久消息）
         * 2：只有一次，利用四次握手进行确认，网络延迟可能会增加（那么此消息为持久消息）
         */
        subConfig.setQos(0);
        subConfig.setGroovy(groovy);

//主题配置
        MqttTopicConfig topicConfig1 = new MqttTopicConfig();
        topicConfig1.setTopic("/donge/1");
        topicConfig1.setSubscribe(subConfig);
        
        MqttTopicConfig topicConfig2 = new MqttTopicConfig();
        topicConfig2.setTopic("/donge/2");
        topicConfig2.setSubscribe(subConfig);
        
        MqttTopicConfig topicConfig3 = new MqttTopicConfig();
        topicConfig3.setTopic("/donge/3");
        topicConfig3.setSubscribe(subConfig);

MqttTopicConfig topicConfig4 = new MqttTopicConfig();
        topicConfig4.setTopic("/donge/4");
        topicConfig4.setSubscribe(subConfig);

//添加到订阅主题列表
        //!!!!!!!!!!!!!!!!!!!!!
        //这里动态添加主题主题，然后手动调用reload接口，实时订阅
        //!!!!!!!!!!!!!!!!!!!!!
        List<MqttTopicConfig> topics = new ArrayList<>();
        topics.add(topicConfig1);
        topics.add(topicConfig2);
        //topics.add(topicConfig3);
        //topics.add(topicConfig4);
        mqttConfig.setTopics(topics);

return mqttConfig;
    }

/**
     * 获取mqtt发布配置
     * @return
     */
    private EapMqttConfig getPubMqttConfig() {
        //连接配置
        EapMqttConfig mqttConfig = new EapMqttConfig();
        mqttConfig.setClientId("mqtt-pub");
        mqttConfig.setHost("tcp://192.168.4.106:1883");
        mqttConfig.setUserName("xxx");
        mqttConfig.setPassword("xxx");
        mqttConfig.setTimeOut(30);
        mqttConfig.setKeepAlive(60);
        mqttConfig.setCleanSession(false);
        mqttConfig.setAutomaticReconnect(true);

//发布回调groovy配置
        //MqttPubGroovyConfig groovy = new MqttPubGroovyConfig();
        //groovy.setProjectName("eap5csxm");
        //groovy.setDevGroup("admin");
        //groovy.setPath("eap5csxm/XiaoXiZhongXin/MQTT/groovy/MQTT.groovy");
        //groovy.setSuccMethod("publishSucc");
        //groovy.setFailMethod("publishFail");

//发布配置
        //MqttPubConfig pubConfig = new MqttPubConfig();
        /**
         * 0：至多一次，客户机将在发布消息的同时废弃此消息。会发生消息丢失。 这一级别可用于如下情况,如环境传感器数据，
         * 这种情况下，丢失一次读记录无所谓,因为第二个 数据的发布紧跟其后
         * 1：至少一次，确保消息到达,但可能发生消息重复。（那么此消息为持久消息）
         * 2：只有一次，利用四次握手进行确认，网络延迟可能会增加（那么此消息为持久消息）
         */
        //pubConfig.setQos(2);
        /**
         * 保留消息定义： Broker会存储每个Topic的最后一条保留消息及其Qos，当订阅该Topic的客户端上线后，Broker需要将该消息投递给它
         * 保留消息作用： 可以让新订阅的客户端得到发布方的最新的状态值，而不必要等待发送
         * 缺点：因为会保留最后一条信息，导致消费端每次登入都会重复收到最后一条记录信息
         */
        //pubConfig.setRetained(false);
        //pubConfig.setGroovy(groovy);

//主题配置
        //MqttTopicConfig topicConfig = new MqttTopicConfig();
        //topicConfig.setTopic("/a/b/3");
        //topicConfig.setPublish(pubConfig);

//添加发布主题配置
        //mqttConfig.setTopicConfig(topicConfig);

return mqttConfig;
    }

/**
     * 发布成功
     * @param mqttContext 上下文
     * @throws Exception
     */
    public void publishSucc(MqttContext mqttContext) throws Exception {
    }

/**
     * 发布失败
     * @param mqttContext 上下文
     * @throws Exception
     */
    public void publishFail(MqttContext mqttContext) throws Exception {
    }
}
```