33 使用 CMake 进行项目构建

在 C++ 开发中，CMake 是一种广泛使用的构建系统生成器，它能够生成针对不同平台和编译器的构建脚本。学习 CMake 是 C++ 开发者的重要技能之一，因为它可以帮助管理项目的编译和构建过程。

CMake 基础

CMake 的安装

在使用 CMake 之前，首先需要确保已在系统上安装了它。可以通过以下命令检查 CMake 是否已安装：

cmake --version

如果尚未安装，可以前往 CMake 官网 下载并安装，或者使用包管理器安装：

• 在 Ubuntu 上：

  sudo apt-get install cmake

• 在 macOS 上（使用 Homebrew）：

  brew install cmake

CMake 列表文件

CMake 使用 CMakeLists.txt 文件来定义项目的构建配置。每个 CMake 项目至少需要一个 CMakeLists.txt 文件，通常在项目的根目录下。

创建一个简单的项目

以下是一个创建简单 C++ 项目的示例步骤。

1. 文件结构

假设我们的项目结构如下：

MyProject/
├── CMakeLists.txt
└── main.cpp

2. 编写 CMakeLists.txt

在 MyProject 目录中创建 CMakeLists.txt 文件，并填入以下内容：

# 定义最低的 CMake 版本
cmake_minimum_required(VERSION 3.10)

# 定义项目名称和版本
project(MyProject VERSION 1.0)

# 添加可执行文件
add_executable(MyProject main.cpp)

3. 编写 main.cpp

在同一目录中创建 main.cpp 文件，并填入以下简单的 C++ 代码：

#include <iostream>

int main() {
    std::cout << "Hello, CMake!" << std::endl;
    return 0;
}

构建项目

1. 创建构建目录

为了保持项目整洁，通常会在项目根目录下创建一个单独的构建目录：

mkdir build
cd build

2. 运行 CMake

在构建目录中，运行 cmake 命令来生成构建文件：

cmake ..

这将读取上级目录的 CMakeLists.txt 文件，并生成相应的构建系统文件。

3. 编译项目

一旦 CMake 完成生成构建文件后，可以使用 make 命令编译项目：

make

编译完成后，将生成一个名为 MyProject 的可执行文件。

4. 运行可执行文件

使用以下命令运行生成的可执行文件：

./MyProject

你应该会看到如下输出：

Hello, CMake!

CMake 的其他功能

添加库

如果项目变得复杂，需要拆分成多个源文件或模块，可以使用 add_library 添加库。

例如，假设我们修改项目结构如下：

MyProject/
├── CMakeLists.txt
├── main.cpp
└── mylib/
    ├── CMakeLists.txt
    └── mylib.cpp

在 mylib 目录中，创建 CMakeLists.txt：

# mylib/CMakeLists.txt
add_library(mylib mylib.cpp)

在根目录的 CMakeLists.txt 中添加对库的引用：

# 根 CMakeLists.txt
add_subdirectory(mylib)
add_executable(MyProject main.cpp)
target_link_libraries(MyProject PRIVATE mylib)

使用 find_package

在使用第三方库时，可以使用 find_package。例如，如果你的项目依赖于 Boost 库：

find_package(Boost 1.70 REQUIRED)
target_link_libraries(MyProject PRIVATE Boost::Boost)

小结

CMake 是一个强大的构建工具，可以简化 C++ 项目的构建配置。掌握 CMake 的基本用法，可以帮助你更有效地管理和构建 C++ 项目。通过 CMakeLists.txt 文件，你可以轻松地添加源文件、库、以及管理项目依赖。

接下来，你可以深入学习更多 CMake 的高级功能，例如并行构建、自定义构建步骤、以及跨平台构建等，这将对你的 C++ 开发生涯非常有帮助。