diff --git a/README.md b/README.md index acfec66d18e3801a2f50b8bee16c47a86515e5ec..20466058a68265d71e6efdc98958ccdfb9d4e917 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,76 @@ +# MQTT 项目说明 -# 项目说明 - MQTT集成SpringBoot,mqtt相比于http,它的协议开销比较小,属于轻量级协议,适用于消息分散的场景 -# 应用场景 - 移动互联网(MI)、物联网(IoT) -# 快速开始 - 1.下载安装mqtt服务端 +## 项目结构 - win: https://mosquitto.org/download/ +本项目包含两个主要模块: - 2.更改配置文件中mqtt服务地址、账号密码 +- `mqtt-consumer`: 实现了 MQTT 消息的消费逻辑。 +- `mqtt-provider`: 提供了 MQTT 消息的发布功能和 REST 接口。 +## 应用场景 + +该项目适用于需要通过 MQTT 协议进行消息通信的场景,包括但不限于: + +- 物联网设备间的消息传递 +- 实时数据推送 +- 分布式系统中的事件通知 + +## 快速开始 + +### 环境要求 + +- Java 8 或更高版本 +- Maven +- MQTT Broker(例如 Mosquitto) + +### 安装步骤 + +1. 克隆项目到本地: + ```bash + git clone + cd + ``` + +2. 构建项目: + ```bash + mvn clean install + ``` + +3. 配置 MQTT 参数: + - 修改 `mqtt-consumer/src/main/resources/application.yml` 中的 MQTT 消费者配置。 + - 修改 `mqtt-provider/src/main/resources/application.yml` 中的 MQTT 提供者配置。 + +4. 运行应用: + - 启动消费者: + ```bash + cd mqtt-consumer + mvn spring-boot:run + ``` + - 启动提供者: + ```bash + cd mqtt-provider + mvn spring-boot:run + ``` + +### 使用示例 + +- 发送 MQTT 消息: + 使用 HTTP 请求发送消息至 MQTT Broker: + ```bash + GET /mqtt/send?message=HelloWorld + ``` + +- 消费 MQTT 消息: + 消费者会自动订阅指定主题并处理接收到的消息。 + +### 配置参数 + +- MQTT Broker 地址、用户名、密码等参数在各自的 `application.yml` 文件中配置。 +- 消费者 ID、主题、QoS 等参数也在配置文件中设置。 + +### 注意事项 + +- 确保 MQTT Broker 正常运行并且可以从应用程序访问。 +- 根据实际需求调整线程池大小和其他性能相关参数。 + +以上是项目的简要说明和快速入门指南。更多详细信息请参考源代码和配置文件。 \ No newline at end of file