mica-mqtt 1.0.2 发布,完善 stater 和 example

一、简介

mica-mqtt 基于 t-io 实现的简单低延迟高性能 的 mqtt 物联网开源组件。使用详见 mica-mqtt gitee 源码 mica-mqtt-example 模块。

源码地址https://gitee.com/596392912/mica-mqtt

二、功能

  • [x] 支持 MQTT v3.1、v3.1.1 以及 v5.0 协议。

  • [x] 支持 MQTT client 客户端。

  • [x] 支持 MQTT server 服务端。

  • [x] 支持 MQTT 遗嘱消息。

  • [x] 支持 MQTT 保留消息。

  • [x] 支持自定义消息(mq)处理转发实现集群。

  • [x] MQTT 客户端 阿里云 mqtt 连接 demo。

  • [x] 支持 GraalVM 编译成本机可执行程序。

  • [x] 支持 Spring boot 项目快速接入(mica-mqtt-spring-boot-starter)。

  • [x] mica-mqtt-spring-boot-starter 支持对接 Prometheus + Grafana。

三、待办

  • [ ] 添加 websocket 支持(已预研成功)。

  • [ ] 优化处理 mqtt session,以及支持 v5.0

四、更新记录

  • 📝 文档添加集群处理步骤说明,添加遗嘱消息、保留消息的使用场景。

  • ✨ 去除演示中的 qos2 参数,性能损耗大避免误用。

  • ✨ 遗嘱、保留消息内部消息转发抽象。

  • ✨ 添加 mica-mqtt-spring-boot-example 。感谢 wsq( @冷月宫主 )pr。

  • ✨ mica-mqtt-spring-boot-starter 支持客户端接入和服务端优化。感谢 wsq( @冷月宫主 )pr。

  • ✨ mica-mqtt-spring-boot-starter 服务端支持指标收集。可对接 Prometheus + Grafana 监控。

  • ✨ mqtt server 接受连接时,先判断该 clientId 是否存在其它连接,有则解绑并关闭其他连接。

  • ⬆️ 升级 mica-auto 到 2.1.3 修复 ide 多模块增量编译问题。

五、普通 java 项目接入

5.1 maven 依赖

 <dependency>
   <groupId>net.dreamlu</groupId>
   <artifactId>mica-mqtt-core</artifactId>
   <version>1.0.2</version>
 </dependency>

5.2 mica-mqtt 客户端

 // 初始化 mqtt 客户端
 MqttClient client = MqttClient.create()
     .ip("127.0.0.1")
     .port(1883)                     // 默认:1883
     .username("admin")
     .password("123456")
     .version(MqttVersion.MQTT_5)    // 默认:3_1_1
     .clientId("xxxxxx")             // 默认:MICA-MQTT- 前缀和 36进制的纳秒数
     .connect();                     // 连接
 
     // 消息订阅,同类方法 subxxx
     client.subQos0("/test/#", (topic, payload) -> {
         logger.info(topic + '\t' + ByteBufferUtil.toString(payload));
     });     // 取消订阅
     client.unSubscribe("/test/#"); 
     // 发送消息
     client.publish("/test/client", ByteBuffer.wrap("mica最牛皮".getBytes(StandardCharsets.UTF_8))); 
     // 断开连接
     client.disconnect();     // 重连
     client.reconnect();     // 停止
     client.stop();

5.3 mica-mqtt 服务端

 // 注意:为了能接受更多链接(降低内存),请添加 jvm 参数 -Xss129k
 MqttServer mqttServer = MqttServer.create()     // 默认:127.0.0.1
     .ip("127.0.0.1")     // 默认:1883
     .port(1883)     // 默认为: 8092(mqtt 默认最大消息大小),为了降低内存可以减小小此参数,如果消息过大 t-io 会尝试解析多次(建议根据实际业务情况而定)
     .readBufferSize(512)     // 自定义认证
     .authHandler((clientId, userName, password) -> true)     // 消息监听
     .messageListener((clientId, topic, mqttQoS, payload) -> {
         logger.info("clientId:{} topic:{} mqttQoS:{} message:{}", clientId, topic, mqttQoS, ByteBufferUtil.toString(payload));
     })     // ssl 配置
     .useSsl("", "", "")     // 自定义客户端上下线监听
     .connectStatusListener(new IMqttConnectStatusListener() {         @Override
         public void online(String clientId) {
 
         } 
         @Override
         public void offline(String clientId) {
 
         }
     })     // 自定义消息转发,可用 mq 广播实现集群化处理
     .messageDispatcher(new IMqttMessageDispatcher() {         @Override
         public void config(MqttServer mqttServer) {
 
         } 
         @Override
         public boolean send(Message message) {             return false;
         } 
         @Override
         public boolean send(String clientId, Message message) {             return false;
         }
     })
     .debug() // 开启 t-io debug 信息日志
     .start(); 
 // 发送给某个客户端
 mqttServer.publish("clientId","/test/123", ByteBuffer.wrap("mica最牛皮".getBytes())); 
 // 发送给所有在线监听这个 topic 的客户端
 mqttServer.publishAll("/test/123", ByteBuffer.wrap("mica最牛皮".getBytes())); 
 // 停止服务
 mqttServer.stop();

5.4 基于 mq 消息广播集群处理

  • 实现 IMqttConnectStatusListener 处理设备状态存储。

  • 实现 IMqttMessageListener 将消息转发到 mq,业务按需处理 mq 消息。

  • 实现 IMqttMessageStore 存储遗嘱和保留消息。

  • 实现 AbstractMqttMessageDispatcher 将消息发往 mq,mq 再广播回 mqtt 集群,mqtt 将消息发送到设备。

  • 业务消息发送到 mq,mq 广播到 mqtt 集群,mqtt 将消息发送到设备。

六、效果演示

评论区

听风道长

2021-08-13 10:36

大神有计划扩展TCP和UDP吗?

icaotw

2021-08-13 10:54

如梦大神牛!!

Dreamlu

2021-08-18 10:42

@听风道长 t-io 本来就支持 TCP和UDP

听风道长

2021-08-19 16:43

@Dreamlu 恩,去看了,以前没太关注,😂