一、简介
mica-mqtt 基于 t-io 实现的简单、低延迟、高性能 的 mqtt 物联网开源组件。使用详见:mica-mqtt-example
模块。
二、功能
- 支持 MQTT v3.1、v3.1.1 以及 v5.0 协议。
- 支持 MQTT client 客户端。
- 支持 MQTT server 服务端。
- 支持 MQTT 遗嘱消息。
- 支持 MQTT 保留消息。
- 支持自定义消息(mq)处理转发实现集群。
- MQTT 客户端 阿里云 mqtt 连接 demo。
- 支持 Spring boot 项目快速接入(mica-mqtt-spring-boot-starter)。
三、待办
- 添加 websocket 支持(已预研成功)。
- 优化处理 mqtt session,以及支持 v5.0
四、更新记录
- ✨ 订阅管理集成到 session 管理中。
- ✨ MqttProperties.MqttPropertyType 添加注释,考虑 mqtt V5.0 新特性处理。
- ✨ 添加 Spring boot starter 方便接入,兼容低版本 Spring boot。
- ✨ 调研 t-io websocket 子协议。
- 🐛 修复 java8 运行期间的部分问题,NoSuchMethodError: java.nio.ByteBuffer.xxx
五、Spring boot 快速接入
5.1 添加依赖
<dependency>
<groupId>net.dreamlu</groupId>
<artifactId>mica-mqtt-spring-boot-starter</artifactId>
<version>${最新版本}</version>
</dependency>
5.2 配置项
配置项 | 默认值 | 说明 |
---|---|---|
mqtt.server.name | Mica-Mqtt-Server | 名称 |
mqtt.server.port | 1883 | 端口 |
mqtt.server.ip | 127.0.0.1 | 服务端 ip |
mqtt.server.buffer-allocator | 堆内存 | 堆内存和堆外内存 |
mqtt.server.heartbeat-timeout | 120s | 心跳超时时间(单位: 毫秒 默认: 1000 * 120),如果用户不希望框架层面做心跳相关工作,请把此值设为0或负数 |
mqtt.server.read-buffer-size | 8092 | 接收数据的 buffer size,默认:8092 |
mqtt.server.max-bytes-in-message | 8092 | 消息解析最大 bytes 长度,默认:8092 |
mqtt.server.debug | false | debug |
5.3 可实现接口(注册成 Spring Bean 即可)
接口 | 是否必须 | 说明 |
---|---|---|
IMqttServerAuthHandler | 是 | 用于客户端认证 |
IMqttMessageListener | 是 | 消息监听 |
IMqttConnectStatusListener | 是 | 连接状态监听 |
IMqttSessionManager | 否 | session 管理 |
IMqttMessageStore | 集群是,单机否 | 遗嘱和保留消息存储 |
IMqttMessageDispatcher | 集群是,单机否 | 消息转发 |
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-----------------");
}
};
}
}
六、普通 java 项目接入
6.1 maven 依赖
<dependency>
<groupId>net.dreamlu</groupId>
<artifactId>mica-mqtt-core</artifactId>
<version>1.0.1</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()), MqttQoS.EXACTLY_ONCE);
// 发送给所有在线监听这个 topic 的客户端
mqttServer.publishAll("/test/123", ByteBuffer.wrap("mica最牛皮".getBytes()), MqttQoS.EXACTLY_ONCE);
// 停止服务
mqttServer.stop();
七、效果演示
八、关注我们
扫描上面二维码,更多精彩内容每天推荐!