EasyTshark 项目启动与配置教程

EasyTshark 项目启动与配置教程

EasyTshark EasyTshark是一个基于tshark的网络数据包分析工具，提供实时抓包和离线分析功能，支持数据包的SQLite存储和XML/JSON格式转换 项目地址: https://gitcode.com/gh_mirrors/ea/EasyTshark

1. 项目目录结构及介绍

EasyTshark 项目是一个网络数据包捕获与分析工具，其目录结构如下：

.
├── CMakeLists.txt           # CMake构建配置文件
├── .clang-format            # 代码格式化规范
├── LICENSE                 # MIT许可证文件
├── run.sh                  # 构建和测试的脚本
├── .vscode/                # VSCode配置文件
│   └── c_cpp_properties.json # C/C++扩展配置
├── include/                # 头文件目录
│   ├── tsharkDataType.hpp   # 数据类型定义
│   ├── tsharkManager.hpp    # 数据包管理器接口
│   └── utils.hpp           # 工具函数接口
├── src/                    # 源文件目录
│   ├── main.cpp            # 主程序入口
│   ├── tsharkManager.cpp    # 数据包管理器实现
│   └── utils.cpp           # 工具函数实现
├── tests/                  # 单元测试目录
│   ├── CMakeLists.txt       # 测试构建配置
│   ├── test_tsharkManager.cpp # 数据包管理器测试
│   ├── test_data_conversion.cpp # 数据转换测试
│   ├── test_error_handling.cpp # 错误处理测试
│   ├── test_performance.cpp # 性能测试
│   ├── test_offline_analysis.cpp # 离线分析测试
│   └── test_utils.cpp      # 工具函数测试
├── data/                   # 数据输出目录
│   ├── packets.xml         # XML格式的数据包
│   └── packets.json        # JSON格式的数据包
└── logs/                   # 日志目录

每个目录和文件的功能如上所述，项目主要分为源代码、测试代码、数据输出和日志记录等部分。

2. 项目的启动文件介绍

项目的启动主要是通过 run.sh 脚本实现的。该脚本提供了以下功能：

• 清理构建目录并编译项目
• 运行单元测试
• 忽略测试失败
• 选择是否清理构建目录
• 选择是否运行测试
• 选择是否启用严格测试模式
• 运行特定测试
• 查看帮助信息

例如，运行以下命令将编译项目并执行所有单元测试：

./run.sh

若要跳过测试执行，可以使用以下命令：

./run.sh --no-test

更多使用方法请参考 run.sh 脚本中的帮助信息。

3. 项目的配置文件介绍

项目的配置主要通过 CMakeLists.txt 文件进行。这是一个 CMake 的构建配置文件，用于配置编译选项、指定依赖库、设置编译过程等。

以下是一些主要的配置选项：

• cmake_minimum_required(VERSION 3.10+)：指定所需的最小 CMake 版本。
• project(EasyTshark)：设置项目的名称。
• set(CMAKE_CXX_STANDARD 11)：设置 C++ 的标准版本为 C++11。
• include_directories(${PROJECT_SOURCE_DIR}/include)：包含头文件目录。
• add_executable(EasyTshark src/main.cpp src/tsharkManager.cpp src/utils.cpp)：添加可执行文件 target。
• target_link_libraries(EasyTshark sqlite3 loguru rapidjson rapidxml ip2region)：链接所需的库。

在 CMakeLists.txt 文件中还可以找到单元测试的配置，以及用于生成测试报告的设置。

通过正确配置 CMakeLists.txt 文件，可以确保项目能够顺利编译和运行。

EasyTshark EasyTshark是一个基于tshark的网络数据包分析工具，提供实时抓包和离线分析功能，支持数据包的SQLite存储和XML/JSON格式转换 项目地址: https://gitcode.com/gh_mirrors/ea/EasyTshark