mica-mqtt 2.1.0 发布，更好的支持 ssl 双向认证

一、简介

mica-mqtt 基于 java aio 实现的简单、低延迟、高性能 的 mqtt 物联网开源组件。

mica-mqtt 更加易于集成到已有服务和二次开发，降低自研物联网平台开发成本。

二、功能

• 支持 MQTT v3.1、v3.1.1 以及 v5.0 协议。
• 支持 websocket mqtt 子协议（支持 mqtt.js）。
• 支持 http rest api，http api 文档详见。
• 支持 MQTT client 客户端。
• 支持 MQTT server 服务端。
• 支持 MQTT 遗嘱消息。
• 支持 MQTT 保留消息。
• 支持自定义消息（mq）处理转发实现集群。
• MQTT 客户端 阿里云 mqtt 连接 demo。
• 支持 GraalVM 编译成本机可执行程序。
• 支持 Spring boot 项目快速接入（mica-mqtt-spring-boot-starter）。
• mica-mqtt-spring-boot-starter 支持对接 Prometheus + Grafana。
• 基于 redis pub/sub 实现集群，详见 mica-mqtt-broker 模块。

三、使用场景

• 物联网（云端 mqtt broker）
• 物联网（边缘端消息通信）
• 群组类 IM
• 消息推送
• 简单、易用的 mqtt client 客户端

四、更新记录

v2.1.0 - 2023-03-05

• ✨ 【不兼容】调整接口参数，方便使用
• ✨ 【不兼容】底层重构调整
• ✨ 兼容更多 Spring boot 版本，支持 2.1.0.RELEASE 以上版本。
• ✨ ssl 支持双向认证 gitee #I61AHJ 感谢 @DoubleH 反馈
• 🐛 修复遗嘱消息判断 gitee #I6BRBV 感谢 @tan90 反馈。
• 🐛 修复错别字 gitee #I6F2PA 感谢 @hpz 反馈
• ⬆️ 依赖升级

五、迁移指南

• mica-mqtt-core 拆分成了 mica-mqtt-client 和 mica-mqtt-server，避免一些依赖引用问题。
• HexUtil 由 net.dreamlu.iot.mqtt.core.util.HexUtil 移动到了 org.tio.utils.mica.HexUtils。

5.1 客户端

5.1.1 订阅回调接口调整

注意：mica-mqtt-client-spring-boot-starter 使用注解订阅可以直升。

IMqttClientMessageListener#onMessage(ChannelContext context, String topic, MqttPublishMessage message, ByteBuffer payload) 方法统一添加 context、message 参数。

订阅系列方法需要调整：

// 消息订阅，同类方法 subxxx
client.subQos0("/test/#", (context, topic, message, payload) -> {
    logger.info(topic + '\t' + ByteBufferUtil.toString(payload));
});

5.1.2 SSL 双向认证支持

mica:
  ssl:
    enabled: false            # 是否开启 ssl 认证，2.1.0 开始支持双向认证
    keystore-path:            # 可选参数：ssl 双向认证 keystore 目录，支持 classpath:/ 路径。
    keystore-pass:            # 可选参数：ssl 双向认证 keystore 密码
    truststore-path:          # 可选参数：ssl 双向认证 truststore 目录，支持 classpath:/ 路径。
    truststore-pass:          # 可选参数：ssl 双向认证 truststore 密码

注意： ssl 存在三种情况

服务端开启ssl	客户端
ClientAuth 为 NONE（不需要客户端验证）	仅仅需要开启 ssl 即可不用配置证书
ClientAuth 为 OPTIONAL（与客户端协商）	需开启 ssl 并且配置 truststore 证书
ClientAuth 为 REQUIRE (必须的客户端验证)	需开启 ssl 并且配置 truststore、 keystore证书

5.1.2 服务端

5.1.2.1 IMqttMessageListener 调整

IMqttMessageListener onMessage 参数也做了调整，添加了 topic、qoS，message 改为了原始 MqttPublishMessage，方便自行获取 mqtt5.x 的属性。

/**
 * 监听到消息
 *
 * @param context  ChannelContext
 * @param clientId clientId
 * @param topic    topic
 * @param qoS      MqttQoS
 * @param message  Message
 */
void onMessage(ChannelContext context, String clientId, String topic, MqttQoS qoS, MqttPublishMessage message);

5.1.2.2 ssl 双向认证支持

mica:
  ssl:                        # mqtt tcp ssl 认证
    enabled: false            # 是否开启 ssl 认证，2.1.0 开始支持双向认证
    keystore-path:            # 必须参数：ssl keystore 目录，支持 classpath:/ 路径。
    keystore-pass:            # 必选参数：ssl keystore 密码
    truststore-path:          # 可选参数：ssl 双向认证 truststore 目录，支持 classpath:/ 路径。
    truststore-pass:          # 可选参数：ssl 双向认证 truststore 密码
    client-auth: none         # 是否需要客户端认证（双向认证），默认：NONE（不需要）

六、使用文档和示例

• mica-mqtt-client 使用文档
• mica-mqtt-server 使用文档
• mica-mqtt-client-spring-boot-starter 使用文档
• mica-mqtt-server-spring-boot-starter 使用文档
• mica-mqtt http api 文档详见
• mica-mqtt 发行版本记录