乐趣区

关于mqtt:micamqtt-102-发布完善-stater-和-example

jiezi

一、简介

mica-mqtt 基于 t-io 实现的 简略 、 低提早 、 高性能 的 mqtt 物联网开源组件。 应用详见 mica-mqtt gitee 源码 mica-mqtt-example 模块。

二、性能

  • [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 多模块增量编译问题。

五、Spring boot 疾速接入

5.1 增加依赖

<dependency>
    <groupId>net.dreamlu</groupId>
    <artifactId>mica-mqtt-spring-boot-starter</artifactId>
    <version>1.0.2</version>
</dependency>

5.2 服务端 yml 配置

mqtt:
  server:
    enabled: true               # 是否开启，默认：true
    ip: 127.0.0.1               # 服务端 ip 默认：127.0.0.1
    port: 5883                  # 端口，默认：1883
    name: Mica-Mqtt-Server      # 名称，默认：Mica-Mqtt-Server
    buffer-allocator: HEAP      # 堆内存和堆外内存，默认：堆内存
    heartbeat-timeout: 120000   # 心跳超时，单位毫秒，默认: 1000 * 120
    read-buffer-size: 8092      # 接收数据的 buffer size，默认：8092
    max-bytes-in-message: 8092  # 音讯解析最大 bytes 长度，默认：8092
    debug: true                 # 如果开启 prometheus 指标收集倡议敞开

5.3 服务端可实现接口（注册成 Spring Bean 即可）

接口 是否必须 阐明
IMqttServerAuthHandler 是 用于客户端认证
IMqttMessageListener 是 音讯监听
IMqttConnectStatusListener 是 连贯状态监听
IMqttSessionManager 否 session 治理
IMqttMessageStore 集群是，单机否 遗嘱和保留音讯存储
AbstractMqttMessageDispatcher 集群是，单机否 音讯转发，（遗嘱、保留音讯转发）
IpStatListener 否 t-io ip 状态监听

5.4 服务端自定义配置（可选）

@Configuration(proxyBeanMethods = false)
public class MqttServerCustomizerConfiguration {

    @Bean
    public MqttServerCustomizer activeRecordPluginCustomizer() {return new MqttServerCustomizer() {
            @Override
            public void customize(MqttServerCreator creator) {
                // 此处可自定义配置 creator，会笼罩 yml 中的配置
                System.out.println("----------------MqttServerCustomizer-----------------");
            }
        };
    }

}

5.5 MqttServerTemplate 应用示例

import net.dreamlu.iot.mqtt.codec.MqttQoS;
import net.dreamlu.iot.mqtt.spring.server.MqttServerTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.nio.ByteBuffer;

/**
 * @author wsq
 */
@Service
public class ServerService {
    @Autowired
    private MqttServerTemplate server;

    public boolean publish(String body) {server.publishAll("/test/123", ByteBuffer.wrap(body.getBytes()));
        return true;
    }
}

5.6 基于 mq 音讯播送集群解决

  • 实现 IMqttConnectStatusListener 解决设施状态存储。
  • 实现 IMqttMessageListener 将音讯转发到 mq，业务按需解决 mq 音讯。
  • 实现 IMqttMessageStore 存储遗嘱和保留音讯。
  • 实现 AbstractMqttMessageDispatcher 将音讯发往 mq，mq 再播送回 mqtt 集群，mqtt 将音讯发送到设施。
  • 业务音讯发送到 mq，mq 播送到 mqtt 集群，mqtt 将音讯发送到设施。

5.7 Prometheus + Grafana 监控对接

得益于 t-io 良好的设计，监控指标间接对接的 t-io stat，目前反对下列指标，前期会不断完善。

反对得指标 阐明
mqtt_connections_accepted 共承受过连接数
mqtt_connections_closed 敞开过的连接数
mqtt_connections_size 以后连接数
mqtt_messages_handled_packets 已解决音讯数
mqtt_messages_handled_bytes 已解决音讯字节数
mqtt_messages_received_packets 已接管音讯数
mqtt_messages_received_bytes 已解决音讯字节数
mqtt_messages_send_packets 已发送音讯数
mqtt_messages_send_bytes 已发送音讯字节数

对于 mica-mqtt-spring-boot-starter 客户端等更多应用形式请查看文档：https://gitee.com/596392912/mica-mqtt/tree/master/mica-mqtt-spring-boot-starter

六、一般 java 我的项目接入

6.1 maven 依赖

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

6.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();

6.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();

七、成果演示

八、关注咱们

扫描下面二维码，更多 精彩内容 每天举荐！

退出移动版