一、CMake概述
CMake(Cross-Platform Make)是一个跨平台的构建系统生成器，它生成平台的原生构建工具(如Makefile、Visual Studio工程、NinJa文件等），并支持复杂项目、多平台和多编译环境。
核心功能
1、跨平台支持
2、管理复杂项目结构（子模块、依赖）
3、支持现代C++特性
4、集成第三方库
5、自动生成安装包
基本概念
1、CMakeLists.txt：每个目录的配置文件
2、目标（Target）:可执行文件或库
3、变量（Variable）：存储路径、选项、版本号等
4、生成器（Generator）：决定生成哪种构建系统
5、作用域（Scope）：变量和目标在不同的目录或函数中的可见性
二、CMake安装与版本管理
1、linux
sudo apt install cmake # Ubuntu/Debain
2、IOS
brew install cmake # MacOS
3、windows
choco install cmake #Chocolaty
4、检查版本
cmake --version
三、基本结构
1、最小CMakeLists.txt
cmake_minimum_required(VERSION 3.20)
project(MyProject VERSION 1.0 LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED True)
add_executable(MyApp main.cpp)
2、基本命令
| 命令 | 功能 |
|---|---|
| project( |
定义项目名称、语言和版本 |
| cmake_minimum_required(VERSION x.y) | 设置最低 CMake 版本 |
| add_executable( |
添加可执行文件 |
| target_compile_options( |
设置编译选项 |
| target_link_libraries( |
链接库 |
| set( |
设置变量 |
| message( |
输出信息 |
四、变量与作用域
1. 设置变量
set(MY_VAR "Hello")
2.读取变量
message(${MY_VAR})
3.作用域
CACHE:跨目录可见
默认：仅在当前目录可见
PARENT_SCOPE:传递给父目录
eg:
set(MY_VAR "Hello" CACHE STRING "A cached variable")
五、目录与依赖管理
1、添加目录
add_executable(MyApp main.cpp)
add_library(MyLib STATIC lib.cpp)
2、目标属性
PRIVATE：仅当前目标
PUBLIC：当前目标 + 链接目标
INTERFACE：只作用于依赖目标
eg:
target_compile_definitions(MyLib PUBLIC USE_FEATURE_X)
target_include_directories(MyLib PUBLIC include)
target_link_libraries(MyApp PRIVATE MyLib)
六、目录结构与子目录
1.典型大型项目结构
MyProject/
├─ CMakeLists.txt
├─ src/
│ ├─ CMakeLists.txt
│ └─ main.cpp
├─ lib/
│ ├─ CMakeLists.txt
│ └─ mylib.cpp
├─ include/
│ └─ mylib.h
├─ tests/
│ └─ CMakeLists.txt
└─ third_party/
2.顶层 CMakeLists.txt
cmake_minimum_required(VERSION 3.20)
project(MyProject)
add_subdirectory(lib)
add_subdirectory(src)
add_subdirectory(tests)
七、条件编译与选项
1.平台判断
if(WIN32)
message("Windows build")
elseif(UNIX)
message("Linux/Mac build")
endif()
2、选项开关
option(USE_FEATURE_X "Enable Feature X" ON)
if(USE_FEATURE_X)
add_definitions(-DUSE_FEATURE_X)
endif()
八、查找外部依赖
1.find_package
find_package(Boost 1.82 REQUIRED COMPONENTS filesystem)
target_link_libraries(MyApp PRIVATE Boost::filesystem)
2.FetchContent（下载源码）
include(FetchContent)
FetchContent_Declare(
googletest
GIT_REPOSITORY https://github.com/google/googletest.git
GIT_TAG release-1.12.1
)
FetchContent_MakeAvailable(googletest)
九、自定义命令与目标
add_custom_command(
OUTPUT generated.cpp
COMMAND python generate.py
DEPENDS generate.py
)
add_executable(MyApp main.cpp generated.cpp)
add_custom_target：不生成文件，但可执行自定义操作。
十、安装与打包
1.安装文件
install(TARGETS MyApp DESTINATION bin)
install(FILES myconfig.conf DESTINATION etc)
`2.生成包（CPack）
include(CPack)
十一、测试集成
1.启用 CTest
enable_testing()
add_executable(test_app test.cpp)
add_test(NAME MyTest COMMAND test_app)
2.运行测试
ctest --output-on-failure
十二、生成与构建流程
1.生成构建系统
cmake -S . -B build -G "Visual Studio 17 2022"
2. 构建
cmake --build build --config Release -- -j8
十三、CMake 高级特性
1.INTERFACE 库：纯头文件库，无源码
add_library(MyHeaderLib INTERFACE)
target_include_directories(MyHeaderLib INTERFACE include/)
2.导出目标
install(TARGETS MyLib EXPORT MyLibTargets DESTINATION lib)
install(EXPORT MyLibTargets FILE MyLibTargets.cmake NAMESPACE MyLib:: DESTINATION lib/cmake)
3.工具链文件：交叉编译配置
cmake -DCMAKE_TOOLCHAIN_FILE=arm_toolchain.cmake ..
4.生成器表达式
target_compile_definitions(MyApp PRIVATE "$<$CONFIG:Debug:DEBUG_BUILD>")
十四、CMake最佳实践
1.使用 target_* 命令管理目标属性
2.避免全局变量污染
3.使用子目录管理大型项目
4.使用 CACHE 保存可配置选项
5.利用现代 CMake 提供的接口库（INTERFACE/PUBLIC/PRIVATE）
6.保持 CMakeLists.txt 简洁，每个目录只处理自己目标
7.优先使用 find_package 或 FetchContent 处理依赖
8.尽量避免硬编码路径，使用 ${CMAKE_CURRENT_SOURCE_DIR} 等变量