第4章:CMake入门:CMakeLists.txt基础语法、目标(Target)概念、变量与缓存

说实话,很多C++开发者对CMake的第一印象就是「又丑又难用」。我当年刚接触时也这么想——一堆大写字母、奇怪的语法,看着就头疼。但干了大项目之后才发现,CMake其实是个被低估的好工具。今天咱们就把它掰开揉碎了讲清楚。

4.1 CMakeLists.txt:项目的「身份证」

每个CMake项目,根目录下必须有一个 CMakeLists.txt。这文件就是项目的入口,CMake读它才知道你要干啥。

最基本的写法长这样:

cmake_minimum_required(VERSION 3.16)
project(MyProject VERSION 1.0.0 LANGUAGES CXX)

add_executable(my_app main.cpp utils.cpp)

三行代码,干了三件事:

  • cmake_minimum_required:指定CMake最低版本。我习惯写3.16以上,因为很多新特性(比如 PRIVATE/INTERFACE 属性)从这版本开始稳定。
  • project:定义项目名、版本号、语言。这里 CXX 就是C++,别写成 C 了,我见过有人踩这个坑。
  • add_executable:告诉CMake「我要生成一个可执行文件,叫my_app,源文件是main.cpp和utils.cpp」。
小技巧: 我习惯把 cmake_minimum_required 写在第一行,而且版本号尽量写高一点。低版本CMake有些语法不支持,编译报错时排查起来很痛苦。

4.2 目标(Target)——CMake的核心抽象

你想想看,一个大型项目里有多少东西?可执行文件、静态库、动态库、头文件路径、编译选项……如果全用全局变量管理,迟早乱成一锅粥。

CMake的解决方案就是「目标(Target)」。每个目标就是一个编译单元,它有自己的属性:源文件、依赖库、编译选项、链接选项等等。

常见的三种目标:

命令 生成产物 典型用途
add_executable 可执行文件 主程序、测试工具
add_library 静态库/动态库 模块、组件、第三方封装
add_custom_target 自定义目标 代码生成、文档构建

举个例子,假设我们要构建一个库和一个可执行文件:

add_library(my_lib STATIC core.cpp algorithm.cpp)
add_executable(my_app main.cpp)
target_link_libraries(my_app PRIVATE my_lib)

这里 my_lib 和 my_app 都是目标。target_link_libraries 把库链接到可执行文件上。PRIVATE 表示这个依赖关系只在 my_app 内部可见,不会传播给其他目标。

重点: 用目标来管理依赖,而不是用全局变量。这是CMake从「脚本工具」进化到「构建系统」的关键一步。我在重构一个遗留项目时,把所有 include_directories 替换成 target_include_directories,编译时间直接降了30%。

4.3 变量与缓存:CMake的「记忆系统」

CMake里变量分两种:普通变量和缓存变量。普通变量只在当前 CMakeLists.txt 和它 include 的文件里有效。缓存变量则会被写入 CMakeCache.txt,跨构建持久化。

定义变量很简单:

set(MY_SOURCES main.cpp utils.cpp)
set(MY_OPTIONS -Wall -Wextra)

add_executable(my_app ${MY_SOURCES})
target_compile_options(my_app PRIVATE ${MY_OPTIONS})

用 ${} 引用变量。注意,变量名大小写敏感,我习惯全大写加下划线,一眼就能看出是变量。

缓存变量通常用于用户可配置的选项:

set(MY_BUILD_TESTS ON CACHE BOOL "是否构建测试")
if(MY_BUILD_TESTS)
    add_subdirectory(tests)
endif()

这里 CACHE BOOL 表示这是一个布尔类型的缓存变量。用户可以通过 cmake -DMY_BUILD_TESTS=OFF 来关闭测试构建。

避坑指南: 我曾经在项目里用 set(CMAKE_CXX_FLAGS "-O2") 直接覆盖了默认的编译选项,结果导致调试信息丢失,排查了一整天。正确的做法是用 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O2") 追加,或者用 target_compile_options 针对特定目标设置。

4.4 常用变量一览

CMake内置了很多变量,记住几个常用的就够了:

变量名 含义 典型值
CMAKE_SOURCE_DIR 顶层源码目录 /home/user/project
CMAKE_BINARY_DIR 构建目录 /home/user/project/build
CMAKE_CURRENT_SOURCE_DIR 当前处理的源码目录 /home/user/project/src
PROJECT_NAME 项目名 MyProject
PROJECT_VERSION 项目版本 1.0.0

嗯,这里要注意:CMAKE_SOURCE_DIR 和 CMAKE_BINARY_DIR 是全局的,而 CMAKE_CURRENT_SOURCE_DIR 会随着 add_subdirectory 变化。如果你在子目录里想引用顶层目录,用 CMAKE_SOURCE_DIR 更稳妥。

4.5 实战:一个简单的项目结构

说了这么多,咱们来拼一个完整的例子。假设项目结构如下:

my_project/
├── CMakeLists.txt
├── src/
│   ├── CMakeLists.txt
│   ├── main.cpp
│   └── core.cpp
└── include/
    └── core.h

顶层 CMakeLists.txt:

cmake_minimum_required(VERSION 3.16)
project(MyApp VERSION 1.0.0 LANGUAGES CXX)

add_subdirectory(src)

src/CMakeLists.txt:

add_executable(my_app main.cpp core.cpp)
target_include_directories(my_app PRIVATE ${CMAKE_SOURCE_DIR}/include)
target_compile_options(my_app PRIVATE -Wall -Wextra)

这样,main.cpp 和 core.cpp 都能找到 include/ 下的头文件。而且编译选项只对 my_app 生效,不会污染其他目标。

个人习惯: 我通常把每个子目录的 CMakeLists.txt 写得尽量短,只负责本目录的目标。顶层文件只做全局配置和 add_subdirectory。这样项目大了之后,每个模块的构建逻辑都独立,维护起来很清爽。

4.6 小结

这一章咱们把CMake的三大基础概念过了一遍:

  • CMakeLists.txt 是项目的入口,三行代码就能跑起来
  • 目标(Target) 是CMake的核心抽象,用它管理依赖比全局变量靠谱得多
  • 变量与缓存 让构建配置灵活可配,记住 set 和 ${} 的用法

下一章咱们会深入 target_* 系列命令,看看怎么精细控制每个目标的编译、链接和传递依赖。到时候你会发现,CMake其实挺优雅的。