Dromara mica-mqtt 组件技术文档

Dromara mica-mqtt 组件技术文档

【免费下载链接】mica-mqtt java mqtt 基于 java aio 实现，开源、简单、易用、低延迟、高性能百万级 java mqtt client 组件和 java mqtt broker 服务。降低自研 iot 物联网平台难度。🔝🔝 记得右上角点个star 关注更新！ 项目地址: https://gitcode.com/dromara/mica-mqtt

1. 安装指南

1.1 环境要求

• JDK 1.8+
• Maven 3.0+
• 支持 Spring Boot、Solon 或 JFinal 框架

1.2 依赖配置

根据项目类型选择对应的依赖：

Spring Boot 项目

客户端依赖：

<dependency>
  <groupId>org.dromara.mica-mqtt</groupId>
  <artifactId>mica-mqtt-client-spring-boot-starter</artifactId>
  <version>${mica-mqtt.version}</version>
</dependency>

服务端依赖：

<dependency>
  <groupId>org.dromara.mica-mqtt</groupId>
  <artifactId>mica-mqtt-server-spring-boot-starter</artifactId>
  <version>${mica-mqtt.version}</version>
</dependency>

Solon 项目

客户端依赖：

<dependency>
  <groupId>org.dromara.mica-mqtt</groupId>
  <artifactId>mica-mqtt-client-solon-plugin</artifactId>
  <version>${mica-mqtt.version}</version>
</dependency>

JFinal 项目

客户端依赖：

<dependency>
  <groupId>org.dromara.mica-mqtt</groupId>
  <artifactId>mica-mqtt-client-jfinal-plugin</artifactId>
  <version>${mica-mqtt.version}</version>
</dependency>

2. 项目使用说明

2.1 基本功能

• 支持 MQTT v3.1、v3.1.1 以及 v5.0 协议
• 支持 websocket mqtt 子协议
• 支持 HTTP REST API
• 支持 MQTT 客户端和服务端
• 支持共享订阅、遗嘱消息和保留消息

2.2 默认端口配置

端口号	协议	说明
1883	tcp	mqtt tcp 端口
8883	tcp ssl	mqtt tcp ssl 端口
8083	websocket	websocket mqtt 子协议端口
8084	websocket ssl	websocket ssl mqtt 子协议端口
18083	http	http、大模型 MCP 接口端口

3. 项目API使用文档

3.1 客户端API

// 创建客户端
IMqttClient client = MqttClient.create()
    .ip("127.0.0.1")
    .port(1883)
    .username("mica")
    .password("mica")
    .connect();

// 订阅主题
client.subscribe("/test", (topic, message) -> {
    System.out.println("收到消息: " + message);
});

// 发布消息
client.publish("/test", "Hello MQTT".getBytes());

3.2 服务端API

// 创建服务端
IMqttServer server = MqttServer.create()
    .port(1883)
    .start();

// 添加消息监听
server.onMessage((clientId, topic, message) -> {
    System.out.println("收到客户端[" + clientId + "]的消息: " + message);
});

4. 项目安装方式

4.1 Maven 安装

在项目的 pom.xml 中添加相应依赖后，执行：

mvn clean install

4.2 快速启动示例

1. 克隆项目仓库：

git clone https://github.com/dromara/mica-mqtt.git

2. 进入示例目录：

cd mica-mqtt/mica-mqtt-example

3. 运行示例：

mvn spring-boot:run

4.3 配置说明

根据项目类型，参考对应模块的 README 文件进行配置：

• Spring Boot 项目：starter/mica-mqtt-*-spring-boot-starter/README.md
• Solon 项目：starter/mica-mqtt-*-solon-plugin/README.md
• JFinal 项目：starter/mica-mqtt-*-jfinal-plugin/README.md

【免费下载链接】mica-mqtt java mqtt 基于 java aio 实现，开源、简单、易用、低延迟、高性能百万级 java mqtt client 组件和 java mqtt broker 服务。降低自研 iot 物联网平台难度。🔝🔝 记得右上角点个star 关注更新！ 项目地址: https://gitcode.com/dromara/mica-mqtt