QMQ 开源项目使用教程
1. 项目的目录结构及介绍
QMQ 项目的目录结构如下:
qmq/
├── clients
├── docs
├── qmq-api
├── qmq-backup
├── qmq-client
├── qmq-common
├── qmq-delay-server
├── qmq-demo
├── qmq-deploy
├── qmq-dist
├── qmq-gateway
├── qmq-metaserver
├── qmq-metrics-prometheus
├── qmq-remoting
├── qmq-server-common
├── qmq-server
├── qmq-store
├── qmq-sync
├── qmq-tools
├── qmq-watchdog
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── pom.xml
目录介绍
clients
: 客户端相关代码。docs
: 文档目录。qmq-api
: API 接口定义。qmq-backup
: 消息备份相关代码。qmq-client
: 客户端实现。qmq-common
: 通用工具和配置。qmq-delay-server
: 延迟消息服务。qmq-demo
: 示例代码。qmq-deploy
: 部署相关脚本和配置。qmq-dist
: 分发包。qmq-gateway
: 网关服务。qmq-metaserver
: 元数据服务。qmq-metrics-prometheus
: Prometheus 监控指标。qmq-remoting
: 远程调用模块。qmq-server-common
: 服务端通用模块。qmq-server
: 核心服务端代码。qmq-store
: 存储模块。qmq-sync
: 同步模块。qmq-tools
: 工具集。qmq-watchdog
: 监控和告警。.gitignore
: Git 忽略文件配置。LICENSE
: 开源许可证。Makefile
: 构建脚本。README.md
: 项目介绍文档。pom.xml
: Maven 项目配置文件。
2. 项目的启动文件介绍
QMQ 项目的启动文件主要位于 qmq-server
目录下。以下是主要的启动文件:
qmq-server/src/main/java/com/qunar/corp/qmq/server/Bootstrap.java
: 服务端启动类。
启动类介绍
Bootstrap.java
是 QMQ 服务端的入口类,负责初始化和启动整个服务端程序。它包含了服务端的配置加载、组件初始化和启动等逻辑。
3. 项目的配置文件介绍
QMQ 项目的配置文件主要位于 qmq-server
和 qmq-client
目录下。以下是主要的配置文件:
qmq-server/src/main/resources/application.properties
: 服务端配置文件。qmq-client/src/main/resources/qmq-client.properties
: 客户端配置文件。
配置文件介绍
application.properties
该文件包含了服务端的各种配置项,如端口号、存储路径、监控配置等。以下是一些常见的配置项:
server.port=8080
qmq.store.path=/path/to/store
qmq.monitor.enable=true
qmq-client.properties
该文件包含了客户端的各种配置项,如服务端地址、连接超时时间等。以下是一些常见的配置项:
qmq.server.address=localhost:8080
qmq.connection.timeout=3000
通过以上配置文件,可以灵活地调整 QMQ 的运行参数,以适应不同的部署环境和需求。