构建系统 (CMake) 教程
1. 引言
在现代软件开发中，构建系统是不可或缺的一部分。它们帮助我们自动化编译、链接和测试过程，从而提高开发效率。CMake 是一个跨平台的构建系统生成器，广泛用于 C++ 项目中。本教程将带你从基础到进阶，掌握 CMake 的使用。
2. CMake 简介
2.1 什么是 CMake？
CMake 是一个开源的、跨平台的构建系统生成器。它通过读取一个名为 CMakeLists.txt 的配置文件，生成适合不同平台的构建文件（如 Makefile、Visual Studio 项目文件等）。
2.2 为什么使用 CMake？
- 跨平台：CMake 支持多种操作系统（如 Windows、Linux、macOS）和编译器（如 GCC、Clang、MSVC）。
- 灵活性：CMake 允许你定义复杂的构建过程，包括依赖管理、测试和安装。
- 可扩展性：CMake 支持自定义命令和模块，方便扩展功能。
3. 安装 CMake
3.1 下载和安装
你可以从 CMake 官方网站 下载适合你操作系统的安装包。安装过程非常简单，按照提示操作即可。
3.2 验证安装
安装完成后，打开终端或命令提示符，输入以下命令验证 CMake 是否安装成功：
cmake --version
如果安装成功，你会看到 CMake 的版本信息。
4. 创建第一个 CMake 项目
4.1 项目结构
首先，创建一个简单的项目结构：
my_project/
├── CMakeLists.txt
└── main.cpp
4.2 编写 main.cpp
在 main.cpp 中编写一个简单的 C++ 程序：
#include <iostream>
int main() {
std::cout << "Hello, CMake!" << std::endl;
return 0;
}
4.3 编写 CMakeLists.txt
在 CMakeLists.txt 中编写以下内容：
cmake_minimum_required(VERSION 3.10)
# 设置项目名称和语言
project(MyProject LANGUAGES CXX)
# 添加可执行文件
add_executable(my_project main.cpp)
4.4 生成构建文件
在终端中进入 my_project 目录，执行以下命令生成构建文件：
cmake -S . -B build
这会在 build 目录下生成构建文件。
4.5 编译项目
进入 build 目录，执行以下命令编译项目：
cmake --build .
编译完成后，你会在 build 目录下看到生成的可执行文件 my_project。
4.6 运行程序
在终端中运行生成的可执行文件：
./my_project
你应该会看到输出：
Hello, CMake!
5. CMake 基础
5.1 基本命令
cmake_minimum_required(VERSION X.Y)：指定 CMake 的最低版本要求。project(ProjectName LANGUAGES CXX)：定义项目名称和使用的语言。add_executable(TargetName source1.cpp source2.cpp)：添加一个可执行文件目标。add_library(TargetName [STATIC|SHARED|MODULE] source1.cpp source2.cpp)：添加一个库目标。
5.2 变量和宏
CMake 支持变量和宏，用于配置构建过程。
set(MY_VARIABLE "Hello, CMake")
message(STATUS "Variable: ${MY_VARIABLE}")
5.3 条件语句
CMake 支持条件语句，用于根据不同条件执行不同的构建步骤。
if(UNIX)
message(STATUS "Building on Unix")
elseif(WIN32)
message(STATUS "Building on Windows")
endif()
6. 实践练习
6.1 练习 1：添加库
- 创建一个新的目录
my_library，并在其中创建library.cpp和library.h。 - 在
library.cpp中实现一个简单的函数，如void print_message()。 - 在
CMakeLists.txt中添加库目标，并将库链接到可执行文件。
6.2 练习 2：多目录项目
- 创建一个多目录项目，包含
src和include目录。 - 在
src目录中编写源文件，在include目录中编写头文件。 - 在
CMakeLists.txt中配置多目录项目的构建。
7. 进阶主题
7.1 依赖管理
CMake 支持外部依赖管理，如使用 find_package 命令查找系统中的库。
find_package(Boost REQUIRED COMPONENTS filesystem)
include_directories(${Boost_INCLUDE_DIRS})
target_link_libraries(my_project Boost::filesystem)
7.2 测试框架
CMake 支持集成测试框架，如 Google Test。
enable_testing()
find_package(GTest REQUIRED)
add_executable(my_test test.cpp)
target_link_libraries(my_test GTest::GTest GTest::Main)
add_test(NAME MyTest COMMAND my_test)
7.3 安装和打包
CMake 支持生成安装包和打包文件。
install(TARGETS my_project DESTINATION bin)
install(FILES my_header.h DESTINATION include)
8. 总结
CMake 是一个强大且灵活的构建系统生成器，适用于各种规模的 C++ 项目。通过本教程，你已经掌握了 CMake 的基础知识和进阶用法。希望你能将这些知识应用到实际项目中，提高开发效率。
9. 参考资料
通过不断实践和学习，你将能够熟练使用 CMake 构建复杂的 C++ 项目。祝你编程愉快！