【产出】 > 用 CMake 管理一个 C++ 项目:写出最小的 CMakeLists.txt,指定 C++ 标准,在独立的构建目录里编译,再把代码拆成库并链接,最后用配置头文件把版本号传进代码。
【版本】 > 按 CMake 官方教程(CMake 4.1 版第 1 步)编写,示例代码适用于 CMake 3.10 及以上。
一、为什么用 CMake
直接写 g++ main.cpp -o app 对一个文件没问题,文件一多、要跨平台、要接第三方库时就很难维护。CMake 不直接编译,它根据 CMakeLists.txt 生成对应平台的构建文件(Linux 的 Makefile / Ninja、Windows 的 Visual Studio 工程),再由它们完成编译。
二、最小的 CMakeLists.txt
项目结构:
Tutorial/
├── CMakeLists.txt
└── tutorial.cxx
CMakeLists.txt(官方教程原文):
cmake_minimum_required(VERSION 3.10)
project(Tutorial)
add_executable(Tutorial tutorial.cxx)
| 命令 | 作用 |
|---|---|
cmake_minimum_required | 声明需要的最低 CMake 版本,必须放在第一行 |
project | 项目名 |
add_executable | 用哪些源文件生成哪个可执行文件 |
三、指定 C++ 标准
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)
官方要求这两行放在 add_executable() 之前。REQUIRED 表示编译器不支持这个标准时直接报错,而不是悄悄降级。现在的新项目一般写 17 或 20。
四、在独立目录里构建
不要在源码目录里直接运行 cmake,生成的文件会和源码混在一起。官方教程的做法:
mkdir Step1_build
cd Step1_build
cmake ../Step1 # 配置:生成构建文件
cmake --build . # 编译
CMake 3.13 以后也可以不切换目录,直接在源码根目录执行:
cmake -S . -B build
cmake --build build
【提示】 > Visual Studio 这类多配置生成器,生成的程序在
build/Debug/或build/Release/下面。官方教程里运行前会多一步cd Debug。要编 Release 版用cmake --build build --config Release。
改了源码或 CMakeLists.txt 之后,只要在构建目录里再执行一次 cmake --build .,CMake 会自动判断要不要重新配置。
五、把版本号传进代码
CMakeLists.txt 里给项目加上版本:
project(Tutorial VERSION 1.0)
configure_file(TutorialConfig.h.in TutorialConfig.h)
新建模板文件 TutorialConfig.h.in:
#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@
#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@
CMake 配置时会把 @...@ 替换成实际版本号,在构建目录里生成 TutorialConfig.h。所以要把构建目录加进头文件搜索路径(放在 add_executable 之后):
target_include_directories(Tutorial PUBLIC
"${PROJECT_BINARY_DIR}"
)
代码里 #include "TutorialConfig.h" 之后就能用这两个宏打印版本号。
六、拆成库并链接
代码多了以后,把功能模块拆成库:
Tutorial/
├── CMakeLists.txt
├── tutorial.cxx
└── MathFunctions/
├── CMakeLists.txt
├── MathFunctions.h
└── mysqrt.cxx
MathFunctions/CMakeLists.txt:
add_library(MathFunctions mysqrt.cxx)
target_include_directories(MathFunctions PUBLIC
"${CMAKE_CURRENT_SOURCE_DIR}")
顶层 CMakeLists.txt 里加入子目录并链接:
add_subdirectory(MathFunctions)
target_link_libraries(Tutorial PUBLIC MathFunctions)
库自己声明的 PUBLIC 头文件目录,会随着 target_link_libraries 自动传给使用它的目标,顶层不需要再写一遍。这种"以目标为中心"的写法是现代 CMake 的推荐方式。
【注意】 > 尽量不要用全局的
include_directories()、link_libraries()、直接改CMAKE_CXX_FLAGS。它们对所有目标生效,项目大了以后很难追查某个参数是从哪来的。优先用target_*系列命令。
七、常用命令速查
| 想做什么 | 命令 |
|---|---|
| 配置 + 生成 | cmake -S . -B build |
| 编译 | cmake --build build |
| 并行编译 | cmake --build build -j 8 |
| 指定 Release | cmake -S . -B build -DCMAKE_BUILD_TYPE=Release(单配置生成器) |
| 使用 Ninja | cmake -S . -B build -G Ninja |
| 清空重来 | 删掉整个 build/ 目录 |
参考资料
- CMake 官方教程(4.1 版)第 1 步:https://cmake.org/cmake/help/v4.1/guide/tutorial/A%20Basic%20Starting%20Point.html
- CMake 官方文档:https://cmake.org/cmake/help/latest/
评价 (0)