diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..e7440f16355a2efdceb7b3830fbe363aba8357dc --- /dev/null +++ b/README.en.md @@ -0,0 +1,53 @@ +# Lightweight Message Queue Component (zhangrui) + +This is a lightweight message queue component implemented in Java, suitable for scenarios requiring local message buffering. The project includes the core message queue module (mq-core) and a demonstration application (mq-demo). + +## Features + +- Persistent message queue with dual protection: in-memory caching + disk persistence +- Provides REST monitoring APIs and a visualization monitoring page +- Supports message enqueue, dequeue, status querying, and load testing +- Automatic capacity control and automatic persistence mechanism + +## Module Structure + +- **mq-core**: Core message queue functionality module +- **mq-demo**: Demonstration application showcasing how to use the message queue +- **Documentation**: Contains the component usage guide (mq-platform-guide.md) + +## Quick Start + +1. Clone the project +```bash +git clone https://gitee.com/level-23-java/zhangrui.git +``` + +2. Build the project +```bash +mvn clean install +``` + +3. Run the demonstration application +```bash +cd mq-demo +mvn spring-boot:run +``` + +## Usage Instructions + +- Send a message: `POST /api/messages` +- Consume a message: `POST /api/messages/dequeue` +- Check status: `GET /api/messages/status` +- Run load test: `POST /api/messages/load-test` + +Access the visualization monitoring page at `/mq/console` + +## Configuration Options + +Configure in `application.properties`: +- `mq.queue.storagePath`: Path for message persistence storage +- `mq.queue.capacity`: Maximum queue capacity + +## License + +This project is licensed under the Apache 2.0 License. See the LICENSE file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ec2775aee0fb9a66c6cfd9faa6cbf44db2d06e7a --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# 轻量级消息队列组件 (zhangrui) + +这是一个基于Java实现的轻量级消息队列组件,适用于需要本地消息缓冲的场景。项目包含核心消息队列功能模块(mq-core)和演示应用(mq-demo)。 + +## 功能特性 + +- 持久化消息队列,支持内存缓存+磁盘持久化双保障 +- 提供REST监控接口和可视化监控页面 +- 支持消息入队、出队、状态查询和负载测试 +- 自动容量控制和自动持久化机制 + +## 模块结构 + +- **mq-core**: 核心消息队列功能模块 +- **mq-demo**: 演示应用,展示消息队列的使用方式 +- **文档**: 包含组件使用指南(mq-platform-guide.md) + +## 快速开始 + +1. 克隆项目 +```bash +git clone https://gitee.com/level-23-java/zhangrui.git +``` + +2. 构建项目 +```bash +mvn clean install +``` + +3. 运行演示应用 +```bash +cd mq-demo +mvn spring-boot:run +``` + +## 使用说明 + +- 发送消息: `POST /api/messages` +- 消费消息: `POST /api/messages/dequeue` +- 查看状态: `GET /api/messages/status` +- 执行负载测试: `POST /api/messages/load-test` + +可视化监控页面可通过 `/mq/console` 访问 + +## 配置选项 + +在application.properties中可配置: +- `mq.queue.storagePath`: 消息持久化存储路径 +- `mq.queue.capacity`: 队列最大容量 + +## 许可证 + +本项目采用Apache 2.0许可证,详细信息请参阅LICENSE文件。 \ No newline at end of file