TBMQ 开源项目教程

1. 项目的目录结构及介绍

TBMQ 项目的目录结构如下：

tbmq/
├── application/
│   ├── common/
│   ├── dao/
│   ├── docker/
│   ├── img/
│   ├── k8s/
│   ├── msa/
│   ├── packaging/
│   │   └── java/
│   └── ui-ngx/
├── .gitignore
├── LICENSE
├── README.md
├── license-header-template.txt
├── pom.xml
├── pull_request_template.md
└── security.md

目录结构介绍

• application/: 包含项目的核心代码和模块。

  • common/: 公共代码库，包含项目中通用的工具类和函数。
  • dao/: 数据访问对象（DAO）层，负责与数据库交互。
  • docker/: Docker 相关文件，用于容器化部署。
  • img/: 项目中使用的图片资源。
  • k8s/: Kubernetes 相关配置文件，用于 Kubernetes 部署。
  • msa/: 微服务架构相关代码。
  • packaging/: 打包相关文件，包含 Java 打包配置。
  • ui-ngx/: 前端代码，使用 Angular 框架。

• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。

• LICENSE: 项目许可证文件，采用 Apache 2.0 许可证。

• README.md: 项目介绍文件，包含项目的基本信息和使用说明。

• license-header-template.txt: 许可证头模板文件，用于代码文件的许可证声明。

• pom.xml: Maven 项目配置文件，定义项目的依赖和构建配置。

• pull_request_template.md: Pull Request 模板文件，用于规范代码提交。

• security.md: 安全相关文档，包含项目的安全策略和注意事项。

2. 项目的启动文件介绍

TBMQ 项目的启动文件主要位于 application/ 目录下。以下是主要的启动文件及其功能介绍：

• application/Application.java: 这是项目的入口文件，负责启动整个应用程序。它包含了主类的定义和初始化代码。

• application/config/ApplicationConfig.java: 应用程序的配置文件，定义了各种配置项，如数据库连接、日志配置等。

• application/server/Server.java: 服务器启动文件，负责启动 MQTT 服务器并监听客户端连接。

3. 项目的配置文件介绍

TBMQ 项目的配置文件主要位于 application/config/ 目录下。以下是主要的配置文件及其功能介绍：

• application.properties: 这是项目的主要配置文件，包含了各种配置项，如数据库连接信息、服务器端口、日志级别等。

• logback.xml: 日志配置文件，定义了日志的输出格式、级别和存储位置。

• docker-compose.yml: Docker 配置文件，定义了 Docker 容器的启动配置，包括服务依赖、网络配置等。

• kubernetes.yaml: Kubernetes 配置文件，定义了 Kubernetes 部署的相关配置，如 Pod 配置、服务配置等。

通过以上配置文件，用户可以根据自己的需求对 TBMQ 项目进行定制化配置，以满足不同的应用场景。