CMake 从入门到精通：完整教程 / 第 1 章：CMake 简介与背景

第 1 章：CMake 简介与背景

1.1 什么是 CMake

CMake（Cross-platform Make）是一个开源的、跨平台的构建系统生成器。它本身并不是构建工具，而是生成特定平台的构建文件（如 Unix Makefile、Ninja 文件、Visual Studio 项目文件等）的元构建系统（meta-build system）。

┌─────────────┐     ┌─────────────┐     ┌─────────────────┐     ┌──────────┐
│ CMakeLists  │ ──> │    CMake    │ ──> │ 构建文件         │ ──> │ 可执行文件│
│    .txt     │     │  (配置阶段)  │     │ (Makefile/Ninja) │     │ / 库文件  │
└─────────────┘     └─────────────┘     └─────────────────┘     └──────────┘
     用户编写          cmake ..             cmake --build .          最终产物

1.2 历史与发展

发展时间线

项目名称由来

CMake = Cross-platform + Make

最初是为 C 语言设计的，但现在已经支持 C++、CUDA、Objective-C、Fortran、Swift 等多种语言。

1.3 设计理念

CMake 的设计遵循以下核心理念：

1.3.1 声明式而非命令式

CMake 鼓励使用声明式的方式来描述构建目标和依赖关系：

# 声明式：描述"是什么"
add_executable(myapp main.cpp utils.cpp)
target_link_libraries(myapp PRIVATE fmt::fmt)
target_include_directories(myapp PRIVATE include)

对比 Makefile 的命令式风格：

# 命令式：描述"怎么做"
myapp: main.o utils.o
	g++ -o myapp main.o utils.o -lfmt -Iinclude

main.o: main.cpp
	g++ -c main.cpp -Iinclude

utils.o: utils.cpp
	g++ -c utils.cpp -Iinclude

1.3.2 目标（Target）为中心

现代 CMake 以 Target 为核心概念。每个目标携带自己的属性（源文件、编译选项、链接依赖、包含目录等），这些属性会自动传递：

# 创建一个库目标
add_library(mylib src/mylib.cpp)
target_include_directories(mylib PUBLIC include/)
target_compile_features(mylib PUBLIC cxx_std_17)

# 创建一个可执行文件目标
add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE mylib)
# myapp 会自动获得 mylib 的 include 目录和 C++17 标准

1.3.3 跨平台抽象

CMake 在不同平台上提供统一的接口：

# 这段代码在 Linux、macOS、Windows 上都能正确工作
if(WIN32)
    target_compile_definitions(myapp PRIVATE PLATFORM_WINDOWS)
elseif(APPLE)
    target_compile_definitions(myapp PRIVATE PLATFORM_MACOS)
elseif(UNIX)
    target_compile_definitions(myapp PRIVATE PLATFORM_LINUX)
endif()

1.4 CMake vs 其他构建系统

1.4.1 对比总表

1.4.2 CMake vs Makefile

Makefile 更适合：内核模块、嵌入式脚本构建等小型或极度定制化场景。

CMake 更适合：跨平台项目、团队协作、需要 IDE 支持的项目。

1.4.3 CMake vs Gradle

Gradle 更适合：Android 开发、Java 为主的项目中包含 C++ 组件。

CMake 更适合：纯 C/C++ 项目、游戏引擎、科学计算库。

1.4.4 CMake vs Meson

1.4.5 CMake vs Bazel

1.5 CMake 的工作流程

CMake 的构建分为两个阶段：

阶段一：配置（Configure）

mkdir build && cd build
cmake ..

此阶段 CMake 执行以下工作：

1. 读取 CMakeLists.txt 文件
2. 检测编译器和平台特性
3. 处理 find_package() 查找依赖
4. 生成缓存文件 CMakeCache.txt
5. 生成构建系统文件（如 Makefile 或 build.ninja）

阶段二：构建（Build）

cmake --build .
# 或直接
make
# 或
ninja

此阶段使用生成的构建文件来编译和链接源代码。

完整流程图

CMakeLists.txt ──┐
                 │  cmake configure
                 ▼
           ┌───────────┐
           │ CMakeCache │   存储用户选项和检测结果
           │    .txt    │
           └─────┬─────┘
                 │
                 ▼
           ┌───────────┐
           │ 构建文件    │   Makefile / build.ninja / .sln
           └─────┬─────┘
                 │  cmake --build
                 ▼
           ┌───────────┐
           │ 目标产物    │   可执行文件 / 库文件
           └───────────┘

1.6 适用场景

✅ 推荐使用 CMake 的场景

⚠️ 可能不太适合的场景

1.7 CMake 的版本演进要点

了解版本特性有助于选择合适的最低版本：

1.8 业务场景：选择构建系统

场景：新启动的跨平台 C++ 项目

假设你是一个 5 人团队，要开发一个跨 Linux、macOS、Windows 的网络服务框架：

需求分析：
├── 需要跨平台？           → 是
├── 使用 C++17？           → 是
├── 依赖第三方库（OpenSSL, Protobuf）？ → 是
├── 团队成员使用不同 IDE？  → 是（VSCode、CLion、Visual Studio）
├── 需要 CI/CD 集成？      → 是
└── 评估结果：              → CMake 是最佳选择 ✅

选择 CMake 的理由：

1. 所有主流 IDE 原生支持
2. find_package 生态覆盖主要 C++ 库
3. vcpkg/Conan 提供丰富的包管理
4. CI 平台（GitHub Actions、GitLab CI）广泛支持

1.9 扩展阅读

• CMake 官方文档
• Professional CMake: A Practical Guide — Craig Scott 著，最好的 CMake 参考书
• Modern CMake — Modern CMake 在线教程
• Effective Modern CMake — 最佳实践总结
• CMake Examples — 实用示例集

下一章：第 2 章 — 安装与环境配置 →