跳转至

CMake

AI 解释

CMake 是一个 跨平台的自动化构建工具，用于管理软件的编译、测试和打包过程。它通过简单的配置文件（CMakeLists.txt）生成标准的构建文件（如 Makefile、Visual Studio 项目等），从而适配不同的编译环境和操作系统

核心特点

  1. 跨平台支持

    • 支持 Windows、Linux、macOS 等操作系统
    • 可生成多种构建系统的文件（如 Makefile、Ninja、Xcode 项目、Visual Studio 解决方案等）

  2. 简洁的配置语法

    • 使用 CMakeLists.txt 文件定义项目结构、依赖和编译规则，语法比直接编写 Makefile 更易读

  3. 模块化与可扩展性

    • 提供内置模块（如查找库 FindPackage）和自定义函数/宏，支持复杂项目管理
    • 可集成第三方工具（如 CTest 测试、CPack 打包）

  4. 依赖管理

    • 自动检测系统环境（如编译器、库路径）
    • 支持导出和导入依赖（通过 find_package 或 FetchContent）

常见应用场景

  • C/C++ 项目：管理多目录、多库的复杂依赖
  • 跨平台开发：同一套配置适配不同操作系统
  • 开源项目：方便用户自行编译（如 LLVM、OpenCV 等均使用 CMake）
  • 现代工具链集成：支持与 Git Submodule、Conan（包管理器）、CUDA 等结合

优势 vs 传统工具

对比项 CMake 直接写 Makefile
跨平台 自动适配不同系统 需手动修改规则
语法 声明式，更简洁 命令式，冗长易错
维护性 适合大型项目 适合小型项目

1 安装

官网下载并安装：Download CMake

将可执行文件所在的目录添加到系统环境变量 PATH

2 在 VS Code 中

VS Code 教程

安装扩展：CMake Tools

img 1
img 2

编译文件步骤：

  1. 选择编译工具
  2. 配置项目
  3. 生成可执行文件
  4. 调试 / 运行可执行文件

3 CMakeLists.txt

CMakeLists.txt 是 CMake 构建系统的配置文件，用于描述如何编译和链接你的项目

主要作用：

  1. 指定项目名称、版本、所需的 CMake 最低版本
  2. 查找和配置依赖库
  3. 添加源码文件、头文件
  4. 设置编译选项、宏定义等
  5. 定义可执行文件、库文件的生成方式
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
cmake_minimum_required(VERSION 3.10)

# 设置项目名称和版本
project(MyProject VERSION 1.0)

# 设置C++标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 添加可执行文件
add_executable(my_app main.cpp src/utility.cpp)

# 包含目录
target_include_directories(my_app PUBLIC include)

# 查找并链接库
find_package(OpenCV REQUIRED)
target_link_libraries(my_app PRIVATE OpenCV::OpenCV)

# 安装目标
install(TARGETS my_app DESTINATION bin)

3.1 语法

每个 CMakeLists.txt 文件必须以以下命令开头：

1
2
cmake_minimum_required(VERSION 3.10)  # 指定CMake最低版本要求
project(MyProject)                    # 定义项目名称

  1. 变量

    1. set(VAR_NAME value)：设置变量
    2. message(STATUS "VAR_NAME = ${VAR_NAME}")：打印变量

  2. add_executable(executable_name source1.cpp source2.cpp)：添加可执行文件

  3. 添加库

    1. add_library(library_name STATIC source1.cpp source2.cpp)：添加静态库
    2. add_library(library_name SHARED source1.cpp source2.cpp)：添加动态库

  4. find_package(package_name CONFIG REQUIRED)：查找包

  5. target_include_directories(target_name PUBLIC ${PROJECT_SOURCE_DIR}/include)：包含目录
  6. target_link_libraries(executable_name library_name)：链接库

7.条件语句

1
2
3
4
5
6
7
if(condition)
    # ...
elseif(condition2)
    # ...
else()
    # ...
endif()

8.循环

1
2
3
foreach(var IN ITEMS item1 item2 item3)
    message(STATUS "var = ${var}")
endforeach()

常用变量：

  1. PROJECT_NAME: 项目名称
  2. PROJECT_SOURCE_DIR: 项目根目录
  3. PROJECT_BINARY_DIR: 构建目录
  4. CMAKE_CURRENT_SOURCE_DIR: 当前处理的 CMakeLists.txt 所在目录
  5. CMAKE_CURRENT_BINARY_DIR: 当前构建目录

作用域：

  1. PRIVATE：仅用于当前目标的构建，不会传播给链接此目标的其他目标
  2. INTERFACE：不用于当前目标的构建，仅传播给链接此目标的其他目标
  3. PUBLIC：既用于当前目标的构建，也传播给链接此目标的其他目标

3.2 多目录项目结构

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
project_root/
├── CMakeLists.txt
├── src/
│   ├── CMakeLists.txt
│   └── ... (源文件)
├── include/
│   └── ... (头文件)
└── tests/
    ├── CMakeLists.txt
    └── ... (测试文件)
根目录的 CMakeLists.txt
1
2
3
4
5
6
cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 添加子目录
add_subdirectory(src)
add_subdirectory(tests)
src/CMakeLists.txt
1
2
3
# 添加库
add_library(my_library STATIC source1.cpp source2.cpp)
target_include_directories(my_library PUBLIC ../include)
tests/CMakeLists.txt
1
2
3
4
5
6
7
# 添加测试可执行文件
add_executable(test_my_library test1.cpp test2.cpp)
target_link_libraries(test_my_library my_library gtest_main)

# 添加测试
enable_testing()
add_test(NAME my_test COMMAND test_my_library)

3.2.1 示例

详见 vcpkg 4.1.1

4 CMakePresets.json

CMakePresets.json 是 CMake 3.19 及以上版本引入的一个配置文件，用于集中管理和简化 CMake 项目的构建配置

主要作用：

  1. 统一构建参数：集中定义编译器、构建类型、工具链、缓存变量等参数，避免每次手动输入
  2. 多平台支持：可以为不同平台、不同开发环境预设多套构建方案
  3. 团队协作：团队成员可以共享同一套构建预设，保证构建环境一致

4.1 示例

当使用 debug 模式时，构建到 build-debug 文件夹中；当使用 release 模式时，构建到 build-release 文件夹中

使用 CMake + MinGW + vcpkg + Ninja

Ninja 文档

CMakePresets.json
 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
45
46
47
48
49
50
51
52
53
54
55
{
  "version": 3,
  "configurePresets": [
    {
      "name": "mingw-debug-ninja",  // 配置名称
      "displayName": "MinGW Ninja Debug",  // 配置显示的名称
      "binaryDir": "${sourceDir}/build-debug-mingw-ninja",  // 指定 build 文件夹
      "generator": "Ninja",  // 指定生成器为 Ninja
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug",  // debug 模式
        "CMAKE_C_COMPILER": "gcc",
        "CMAKE_CXX_COMPILER": "g++",
        "CMAKE_MAKE_PROGRAM": "ninja",
        // 指定工具链文件
        "CMAKE_TOOLCHAIN_FILE": "G:/vcpkg/scripts/buildsystems/vcpkg.cmake",
        // 指定目标平台和编译方式，使用 MinGW
        "VCPKG_TARGET_TRIPLET": "x64-mingw-dynamic"
      },
      "environment": {
        // 指定 MinGW 和 Ninja 的路径
        // Ninja 已经添加到了系统环境变量中，因此为 $penv{PATH}
        // 如果 MinGW 也添加到了系统环境变量中，可以直接写成
        // "PATH": "$penv{PATH}"
        "PATH": "C:/Program Files/mingw64/bin;$penv{PATH}"
      }
    },
    {
      "name": "mingw-release-ninja",
      "displayName": "MinGW Ninja Release",
      "binaryDir": "${sourceDir}/build-release-mingw-ninja",
      "generator": "Ninja",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release",  // release 模式
        "CMAKE_C_COMPILER": "gcc",
        "CMAKE_CXX_COMPILER": "g++",
        "CMAKE_MAKE_PROGRAM": "ninja",
        "CMAKE_TOOLCHAIN_FILE": "G:/vcpkg/scripts/buildsystems/vcpkg.cmake",
        "VCPKG_TARGET_TRIPLET": "x64-mingw-dynamic"
      },
      "environment": {
        "PATH": "C:/Program Files/mingw64/bin;$penv{PATH}"
      }
    }
  ],
  "buildPresets": [
    {
      "name": "debug-mingw",  // 生成显示的名称
      "configurePreset": "mingw-debug-ninja"  // 对应的配置名称
    },
    {
      "name": "release-mingw",
      "configurePreset": "mingw-release-ninja"
    }
  ]
}

评论区

欢迎在评论区指出文档错误，为文档提供宝贵意见，或写下你的疑问