net.dreamlu.iot.mqtt.spring.client.MqttClientTemplate Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2019-2029, Dreamlu 卢春梦 ([email protected] & dreamlu.net).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dreamlu.iot.mqtt.spring.client;
import lombok.Getter;
import net.dreamlu.iot.mqtt.codec.MqttMessageBuilders;
import net.dreamlu.iot.mqtt.codec.MqttProperties;
import net.dreamlu.iot.mqtt.codec.MqttQoS;
import net.dreamlu.iot.mqtt.core.client.*;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.SmartInitializingSingleton;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.Ordered;
import org.tio.client.ClientChannelContext;
import org.tio.client.TioClient;
import org.tio.client.TioClientConfig;
import org.tio.utils.timer.TimerTask;
import java.util.List;
import java.util.concurrent.Executor;
import java.util.function.Consumer;
/**
* mqtt client 模板
*
* @author wsq（冷月宫主）
*/
public class MqttClientTemplate implements ApplicationContextAware, SmartInitializingSingleton, InitializingBean, DisposableBean, Ordered {
public static final String DEFAULT_CLIENT_TEMPLATE_BEAN = "mqttClientTemplate";
@Getter
private final MqttClientCreator clientCreator;
private ApplicationContext applicationContext;
private MqttClient client;
public MqttClientTemplate(MqttClientCreator clientCreator) {
this.clientCreator = clientCreator;
}
/**
* 订阅
*
* @param topicFilter topicFilter
* @param listener MqttMessageListener
* @return MqttClient
*/
public MqttClient subQos0(String topicFilter, IMqttClientMessageListener listener) {
return client.subscribe(topicFilter, MqttQoS.QOS0, listener);
}
/**
* 订阅
*
* @param topicFilter topicFilter
* @param listener MqttMessageListener
* @return MqttClient
*/
public MqttClient subQos1(String topicFilter, IMqttClientMessageListener listener) {
return client.subscribe(topicFilter, MqttQoS.QOS1, listener);
}
/**
* 订阅
*
* @param topicFilter topicFilter
* @param listener MqttMessageListener
* @return MqttClient
*/
public MqttClient subQos2(String topicFilter, IMqttClientMessageListener listener) {
return client.subscribe(topicFilter, MqttQoS.QOS2, listener);
}
/**
* 订阅
*
* @param mqttQoS MqttQoS
* @param topicFilter topicFilter
* @param listener MqttMessageListener
* @return MqttClient
*/
public MqttClient subscribe(MqttQoS mqttQoS, String topicFilter, IMqttClientMessageListener listener) {
return client.subscribe(mqttQoS, topicFilter, listener);
}
/**
* 订阅
*
* @param mqttQoS MqttQoS
* @param topicFilter topicFilter
* @param listener MqttMessageListener
* @return MqttClient
*/
public MqttClient subscribe(String topicFilter, MqttQoS mqttQoS, IMqttClientMessageListener listener) {
return client.subscribe(topicFilter, mqttQoS, listener);
}
/**
* 订阅
*
* @param mqttQoS MqttQoS
* @param topicFilter topicFilter
* @param listener MqttMessageListener
* @param properties MqttProperties
* @return MqttClient
*/
public MqttClient subscribe(String topicFilter, MqttQoS mqttQoS, IMqttClientMessageListener listener, MqttProperties properties) {
return client.subscribe(topicFilter, mqttQoS, listener, properties);
}
/**
* 订阅
*
* @param topicFilters topicFilter 数组
* @param mqttQoS MqttQoS
* @param listener MqttMessageListener
* @return MqttClient
*/
public MqttClient subscribe(String[] topicFilters, MqttQoS mqttQoS, IMqttClientMessageListener listener) {
return client.subscribe(topicFilters, mqttQoS, listener);
}
/**
* 订阅
*
* @param topicFilters topicFilter 数组
* @param mqttQoS MqttQoS
* @param listener MqttMessageListener
* @param properties MqttProperties
* @return MqttClient
*/
public MqttClient subscribe(String[] topicFilters, MqttQoS mqttQoS, IMqttClientMessageListener listener, MqttProperties properties) {
return client.subscribe(topicFilters, mqttQoS, listener, properties);
}
/**
* 批量订阅
*
* @param subscriptionList 订阅集合
* @return MqttClient
*/
public MqttClient subscribe(List subscriptionList) {
return client.subscribe(subscriptionList);
}
/**
* 批量订阅
*
* @param subscriptionList 订阅集合
* @param properties MqttProperties
* @return MqttClient
*/
public MqttClient subscribe(List subscriptionList, MqttProperties properties) {
return client.subscribe(subscriptionList, properties);
}
/**
* 取消订阅
*
* @param topicFilters topicFilter 集合
* @return MqttClient
*/
public MqttClient unSubscribe(String... topicFilters) {
return client.unSubscribe(topicFilters);
}
/**
* 取消订阅
*
* @param topicFilters topicFilter 集合
* @return MqttClient
*/
public MqttClient unSubscribe(List topicFilters) {
return client.unSubscribe(topicFilters);
}
/**
* 发布消息
*
* @param topic topic
* @param payload 消息内容
* @return 是否发送成功
*/
public boolean publish(String topic, byte[] payload) {
return client.publish(topic, payload, MqttQoS.QOS0);
}
/**
* 发布消息
*
* @param topic topic
* @param payload 消息内容
* @param qos MqttQoS
* @return 是否发送成功
*/
public boolean publish(String topic, byte[] payload, MqttQoS qos) {
return client.publish(topic, payload, qos);
}
/**
* 发布消息
*
* @param topic topic
* @param payload 消息内容
* @param retain 是否在服务器上保留消息
* @return 是否发送成功
*/
public boolean publish(String topic, byte[] payload, boolean retain) {
return client.publish(topic, payload, retain);
}
/**
* 发布消息
*
* @param topic topic
* @param payload 消息体
* @param qos MqttQoS
* @param retain 是否在服务器上保留消息
* @return 是否发送成功
*/
public boolean publish(String topic, byte[] payload, MqttQoS qos, boolean retain) {
return client.publish(topic, payload, qos, retain);
}
/**
* 发布消息
*
* @param topic topic
* @param payload 消息体
* @param qos MqttQoS
* @param retain 是否在服务器上保留消息
* @param properties MqttProperties
* @return 是否发送成功
*/
public boolean publish(String topic, byte[] payload, MqttQoS qos, boolean retain, MqttProperties properties) {
return client.publish(topic, payload, qos, retain, properties);
}
/**
* 发布消息
*
* @param topic topic
* @param payload 消息体
* @param qos MqttQoS
* @param builder PublishBuilder
* @return 是否发送成功
*/
public boolean publish(String topic, byte[] payload, MqttQoS qos, Consumer builder) {
return client.publish(topic, payload, qos, builder);
}
/**
* 添加定时任务，注意：如果抛出异常，会终止后续任务，请自行处理异常
*
* @param command runnable
* @param delay delay
* @return TimerTask
*/
public TimerTask schedule(Runnable command, long delay) {
return client.schedule(command, delay);
}
/**
* 添加定时任务，注意：如果抛出异常，会终止后续任务，请自行处理异常
*
* @param command runnable
* @param delay delay
* @param executor 用于自定义线程池，处理耗时业务
* @return TimerTask
*/
public TimerTask schedule(Runnable command, long delay, Executor executor) {
return client.schedule(command, delay, executor);
}
/**
* 添加定时任务
*
* @param command runnable
* @param delay delay
* @return TimerTask
*/
public TimerTask scheduleOnce(Runnable command, long delay) {
return client.scheduleOnce(command, delay);
}
/**
* 添加定时任务
*
* @param command runnable
* @param delay delay
* @param executor 用于自定义线程池，处理耗时业务
* @return TimerTask
*/
public TimerTask scheduleOnce(Runnable command, long delay, Executor executor) {
return client.scheduleOnce(command, delay, executor);
}
/**
* 重连
*/
public void reconnect() {
client.reconnect();
}
/**
* 重连到新的服务端节点
*
* @param ip ip
* @param port port
* @return 是否成功
*/
public boolean reconnect(String ip, int port) {
return client.reconnect(ip, port);
}
/**
* 断开 mqtt 连接
*
* @return 是否成功
*/
public boolean disconnect() {
return client.disconnect();
}
/**
* 获取 TioClient
*
* @return TioClient
*/
public TioClient getTioClient() {
return client.getTioClient();
}
/**
* 获取 ClientTioConfig
*
* @return ClientTioConfig
*/
public TioClientConfig getClientTioConfig() {
return client.getClientTioConfig();
}
/**
* 获取 ClientChannelContext
*
* @return ClientChannelContext
*/
public ClientChannelContext getContext() {
return client.getContext();
}
/**
* 判断客户端跟服务端是否连接
*
* @return 是否已经连接成功
*/
public boolean isConnected() {
return client.isConnected();
}
/**
* 判断客户端跟服务端是否断开连接
*
* @return 是否断连
*/
public boolean isDisconnected() {
return client.isDisconnected();
}
/**
* 获取 MqttClient
*
* @return MqttClient
*/
public MqttClient getMqttClient() {
return client;
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
@Override
public void afterPropertiesSet() throws Exception {
// 需要支持注解订阅所以 clientSession 配置的时机要早一些
IMqttClientSession clientSession = this.clientCreator.getClientSession();
if (clientSession == null) {
clientSession = this.applicationContext.getBeanProvider(IMqttClientSession.class)
.getIfAvailable(DefaultMqttClientSession::new);
this.clientCreator.clientSession(clientSession);
}
}
@Override
public void afterSingletonsInstantiated() {
// 配置客户端连接监听器
this.applicationContext.getBeanProvider(IMqttClientConnectListener.class).ifAvailable(clientCreator::connectListener);
// 全局监听器
this.applicationContext.getBeanProvider(IMqttClientGlobalMessageListener.class).ifAvailable(clientCreator::globalMessageListener);
// 自定义处理
this.applicationContext.getBeanProvider(MqttClientCustomizer.class).ifAvailable(customizer -> customizer.customize(clientCreator));
// 连接超时时间，如果没设置，改成 3s，减少因连不上卡顿时间
Integer timeout = clientCreator.getTimeout();
if (timeout == null) {
clientCreator.timeout(3);
}
// 使用同步连接，不过如果连不上会卡一会
client = clientCreator.connectSync();
}
@Override
public void destroy() {
client.stop();
}
@Override
public int getOrder() {
return Ordered.LOWEST_PRECEDENCE;
}
}