ProjectsTools

导言

近期刚刚结束CS106L | Standard C++ features and syntax的学习，想借此机会完善一下对C++项目构建的学习，如CMake等构建工具的使用，故立此项。

通过本次项目你会了解到：

    1. C++项目标准化基础
    1. CMake、vcpkg等C++构建工具的基本使用
    1. 多语言配合构建（C++ & Python）

下面是完成此次项目所需的基本条件：

文中的构建平台为Ubuntu22.04

此次项目注重C++项目的标准化以及构建工具（vcpkg、CMake）的使用，代码逻辑部分主体由DeepSeek、ChatGPT等AI大模型完成。

初始化项目

首先使用两个语言的包管理器分别对项目进行初始化：

vcpkg

1
vcpkg new --application

对生成的vcpkg.json进行配置：

1
2
3
4
5
6
7
8
9
10
11
12
{
    "name": "three-body-simulator",
    "version-string": "0.1.0",
    "dependencies": [
        {
            "name": "python3",
            "version>=": "3.12.9"
        },
        "pybind11"
    ],
    "builtin-baseline": "a337f5fe100f83026072765ea63a8776f984f6fd"
}

注意所有键值对的内容只能包含小写字母，否则后续构建时会报错。

uv

1
uv init

将项目信息写入pyproject.toml

1
2
3
4
5
6
7
8
9
10
11
12
13
[project]
name = "3BodySimulator"
version = "0.1.0"
description = "The visualization simulation of three-body motion implemented using C++ & Python."
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
    "matplotlib>=3.8.0",
    "ninja>=1.11.1",
    "numpy>=1.26.0",
    "pybind11>=2.11.1",
    "pygame>=2.6.1",
]

随后去除无用的生成配置即可。

随后对项目结构初始化：

项目结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.
├── build.sh              # build shell script
├── CMakeLists.txt        # CMake build config(outer)
├── CMakePresets.json     # vcpkg CMake toolchain config(public)
├── CMakeUserPresets.json # vcpkg CMake toolchain config(private)
├── LICENSE
├── pyproject.toml        # Python project config
├── python                # Python script folder
│   ├── dynamic.py
│   ├── example.json      # example input json data
│   ├── pyonly.py
│   └── visualize.py
├── README.md
├── requirements.txt      # Python dependencies
├── src                   # C++ source folder
│   ├── CMakeLists.txt    # CMake build config(inner)
│   ├── three_body.cpp
│   └── three_body.h
├── uv.lock
├── vcpkg-configuration.json
└── vcpkg.json            # vcpkg dependencies config

代码实现

这部分并不是我们本次项目的重点，故使用了大语言模型（chatGPT）负责该部分的实现与完善。绝对不是我想偷懒😋

其中采用的技术栈在项目的README中有详细的总结。后续会视情况完善对这一部分的学习和解构。

在实现的代码源文件中，我们使用C++作为底层物理引擎的构建语言，使用Python作为主程序语言并负责可视化与用户交互。二者的源文件分别位于项目根目录的src和python文件夹下。

项目构建

接下来进入本项目的重点。

创建本次项目的主要目的是为学习CMake和vcpkg的基本使用，故将项目构建配置的部分视为重点。

本项目使用CMake & vcpkg工具链进行C++的构建，使用uv进行Python的依赖与项目管理，可遵循『获取依赖→配置→编译→虚拟环境运行』的流程对项目进行构建与测试运行：

获取依赖

类似Python的pip，vcpkg是一个相对简单易用的cpp包管理工具（虽然但是各种配置还是让人用的很难受🙃，毕竟C++的生态就这样），在该项目中，我们将使用它相对容易地获取项目所需的相关依赖。

安装就不再赘述，详情参考官方文档，注意记住自己安装的路径，以便后续工具链的配置。

  • 编辑依赖列表

在本项目中，我们选择使用C++配合Python完成模拟实现。chatGPT给出的实现思路是使用cpp实现天体运动的底层物理引擎，构建输出一个Python可直接调用的共享库（.so/.pyd），然后由Python在可视化实现中直接调用。

因此，在C++模块的实现中，我们需要使用pybind11联系二者。

pybind11是一个轻量级的库，用于将C++代码绑定到Python中，使得Python能够调用cpp的高性能代码。

为了引入pybind11，我们就需要通过配置vcpkg.json的依赖列表使得后续运行构建时能够导入它。

在初始化项目的过程中，我们已经对vcpkg.json进行了配置。是的，那就是所谓的依赖列表。根据官方文档的描述，也可通过port命令添加依赖：

1
vcpkg add port pybind11

构建配置

这是该项目中最为重要的一步，主要的工作简单来说就是配置CMakeLists.txt。

由于我们使用了第三方工具vcpkg作为包管理工具，合理配置这二者之间的工具链关系就尤为关键。

我们配置的思路是，在项目的根目录和用于存放C++模块的src中分别创建一个CMakeLists.txt。前者用于配置CMake在构建过程中与vcpkg的工具链参数；后者则专门用于配置cpp模块的构建逻辑。

由此便有了以下配置：

CMakeLists.txt:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 项目基本参数
cmake_minimum_required(VERSION 3.20)
project(3BodySimulator LANGUAGES CXX)

# 使用 vcpkg 的 Toolchain
if(NOT DEFINED CMAKE_TOOLCHAIN_FILE)
  set(
    CMAKE_TOOLCHAIN_FILE "~/vcpkg/scripts/buildsystems/vcpkg.cmake"
    DPython3_EXECUTABLE=$(which python)
    DCMAKE_BUILD_TYPE=Release
    CACHE STRING ""
  )
endif()

# 把 src 子目录加入构建
add_subdirectory(src)

src/CMakeLists.txt:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 查找 pybind11（由 vcpkg 安装并集成）
find_package(pybind11 CONFIG REQUIRED)

# 源文件列表
pybind11_add_module(three_body
  three_body.cpp
)

# 设置头文件路径
target_include_directories(three_body
  PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}
)

# 设置 C++17 标准
target_compile_features(three_body PUBLIC cxx_std_17)

# 把生成的共享库 (.so/.pyd) 放到 ../python 目录
set_target_properties(three_body PROPERTIES
  LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/python
  OUTPUT_NAME "three_body"    # 忽略 ABI tag，统一输出 three_body.so
  PREFIX ""                   # 无前缀
  SUFFIX ".so"                # 强制后缀 .so
)

正常情况下，按照以上构建配置，只需执行如下命令即可进行C++模块的构建生成与编译：

1
2
3
4
# 配置生成
cmake --preset=vcpkg
# 编译生成.so
cmake --build build/

如果不出意外的话，cmake会在python路径下生成一个名为three_body的.so共享库（为了方便调用，故将共享库生成到与py脚本相同的目录下）。事实上，到这里，我们的项目就可以直接通过python命令直接运行了（当然，前提是你的Python依赖没有问题）。

uv：世界，遗忘我…🙃

uvPython虚拟环境配置

虽然完成了C++模块的构建工作基本就意味着项目能够跑起来了，但Python混乱的环境依赖问题在某些时候是出了名的让人头痛。为了避免这一情况，我们需要创建一个虚拟环境来运行我们的项目，为此，我们选择了uv作为该项目的Python包管理器。

uv是一个由Rust编写的高性能Python包管理工具，其安装速度比传统工具要快上不少，同时还支持并行安装。

更重要的是，它提供了一种十分便捷和强大的项目依赖管理与虚拟环境管理方式。

在初始化项目的过程中，我们已经使用其进行了项目信息的初始化配置，接下来，我们将继续使用它轻松地配置和运行我们的项目：

  • 创建Python虚拟环境并激活
1
2
uv venv .venv         # 默认为系统 Python3.12
source .venv/bin/activate
  • 在虚拟环境中安装依赖
1
uv pip install -r requirements.txt

安装好依赖后，我们就可以在虚拟环境中完美地运行我们的项目了：

1
uv run python/dynaminc.py

自动化构建脚本

说了这么一堆，有人可能要问了：这么多的构建命令，还挺麻烦的，而且如果不小心搞乱了不就完犊子了？难道就没有方便的构建方式吗？

有的兄弟，有的。

事实上，我们上面讲解的构建顺序本身就有点问题：

如果观察仔细的话，应该会注意到，前文中根目录下的CMakeLists.txt中在配置工具链时指定了一个名为DPython3_EXECUTABLE的参数，这个参数的功能是显式指定运行Python脚本的Python解释器，作用是强制保持运行环境的Python版本一致性。如果你在系统上使用与uv配置中Python版本不一致的解释器，且没有在构建C++模块前创建并激活Python虚拟环境，那么你在尝试运行项目时就会得到类似下面的报错信息：

1
2
3
4
Traceback (most recent call last):
  File "/home/virtualguard/projects/researching/cpp-engine/3BodySimulator/python/visualize.py", line 11, in <module>
    from three_body import Body, step
ImportError: Python version mismatch: module was compiled for Python 3.10, but the interpreter version is incompatible: 3.12.9 (main, Feb 12 2025, 14:50:50) [Clang 19.1.6 ].

对于这个问题，我们就需要通过强制规范构建顺序来保证项目自始至终是在我们创建的虚拟环境中构建并运行的，以确保项目环境的一致性；结合前面提到的“方便地构建方法”，我们就可以将众多的构建命令依序整合到一个bash脚本中，也就是所谓的自动化构建脚本：

build.sh:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#!/bin/bash
set -e

#———————————————
# 1. 清理旧构建
#———————————————
echo "清理旧构建文件..."
rm -rf build python/three_body* .venv/ vcpkg_installed/ vcpkg/

#———————————————
# 2. 创建并激活 uv 虚拟环境（Python 3.12）
#———————————————
echo "创建并激活 Python 3.12 虚拟环境..."
uv venv .venv         # 默认为系统 Python3.12
source .venv/bin/activate

# 安装 Python 可视化脚本依赖
uv pip install -r requirements.txt

#———————————————
# 3. 用 venv 中的 Python 配置 & 编译 C++ 扩展
#———————————————
echo "配置 CMake（指向 venv 中的 python）..."
# cmake -B build \
#   -DCMAKE_TOOLCHAIN_FILE=~/vcpkg/scripts/buildsystems/vcpkg.cmake \
#   -DPython3_EXECUTABLE=$(which python) \
#   -DCMAKE_BUILD_TYPE=Release

cmake --preset=vcpkg

echo "开始编译 C++ 扩展..."
cmake --build build

#———————————————
# 4. 检查生成结果
#———————————————
echo "生成的 Python 模块："
ls -l python/ | grep three_body

#———————————————
# 5. 运行可视化脚本
#———————————————
echo "执行 uv run python/visualize.py 启动三体模拟..."
echo "执行 uv run python/dynamic.py 启动动态模拟..."

首先为脚本添加运行权限：

1
chmod +x build.sh

随后就可以直接通过脚本进行自动化构建了：

1
./build.sh

此时由于项目环境独立于系统全局的Python环境，构建运行均基于这个虚拟环境，确保了环境的一致性，也就不会出现像上面的环境冲突问题了。

说些什么吧！

giscus