ZanTCPDemo 项目快速入门教程

1. 项目目录结构及介绍

ZanTCPDemo 是一个基于 Thrift 协议实现的网络通信框架的示例项目。其目录结构如下：

.
├── README.md        # 项目说明文档
├── docker-compose.yml   # Docker Compose 配置文件
├── src               # 源码目录
│   ├── client         # 客户端代码
│   │   └── main.cpp    # 客户端主程序
│   ├── common         # 公共库
│   │   └── zan_common.thrift   # 共享接口定义
│   ├── server         # 服务器代码
│   │   └── main.cpp    # 服务器主程序
│   └── thrift         # Thrift 生成的代码
│       └── ...
└── tools             # 工具脚本
    ├── gen_thrift.sh     # 生成 Thrift 代码的脚本
    └── start.sh           # 启动服务的脚本

• src: 存放源代码，包括客户端和服务端。
• src/thrift: 使用 Thrift 编译生成的服务和客户端代码。
• tools: 包含辅助脚本，用于生成 Thrift 代码和启动服务。

2. 项目的启动文件介绍

2.1 gen_thrift.sh

此脚本用于编译 .thrift 文件并生成 C++ 库。在项目中执行以下命令以更新 Thrift 生成的代码：

$ cd tools
$ ./gen_thrift.sh

2.2 start.sh

start.sh 脚本负责启动服务器。它将编译代码并在本地运行服务器实例。在项目根目录下执行以下命令启动服务器：

$ sh tools/start.sh

3. 项目的配置文件介绍

ZanTCPDemo 示例项目并没有明确的独立配置文件。大多数配置选项是硬编码在源码中的，例如服务器监听的端口等。对于实际应用，可能需要将这些配置提取到外部文件，以便于管理和动态调整。

为了适应不同环境，可以考虑创建一个 JSON 或 YAML 格式的配置文件，然后修改 main.cpp 中的相关部分以从这个文件加载配置。这不属于当前示例项目的内容，但作为最佳实践，您可以自行添加此类功能。

完成上述步骤后，您就可以通过编译源代码并运行服务器来体验 ZanTCPDemo 的基本功能了。如果您在过程中遇到任何问题，欢迎查看项目提供的README或在GitHub上提交问题。