CMake了解

CMake 简介

CMake（英文 Cross platform Make 的缩写）它不是构建系统，而是构建系统生成器，属于一个跨平台构建工具，在 Linux 平台生成构建系统 make 的 Makefile 文件，在 Windows 平台生成 Visual Studio 或 MSVC 的工程等。所以具体的构建工作还是需要交给例如 Make，Ninja，MSVC 等这些构建系统去执行。

对于使用 CMake 我们需要学习两部分内容，分别为 CMake 的控制命令 以及 CMakeLists.txt 的编写语法。

CMake 基于平台分为两个版本，命令行 CLI 版本一般用于 Linux 系统中，GUI 图形界面 GUI 版本，图形界面版本易于在 Windows 系统中使用，当然在 Windows 系统中同样也可以使用命令行操作。对于含有图形界面的 CMake 来说图形界面可以替代 CMake 的控制命令。

1. 了解 CMakeLists.txt 文件

该文件用于编写存储待 CMake 去执行的所有 CMake 命令的文件（这类似于 makefile 用于存储待 gcc 去执行的命令）。当 CMake 在某个文件夹下运行时，会寻找该文件，如果找不到则报错，所以我们编写好后文件名称必须命名为 CMakeLists.txt。

2. CMake 两种编译模式

CMake 支持两种构建模式，分别为 in-source build（源码中构建），out-of-source build（源码外构建），下面分别来介绍一下这两种模式。

2.1 in-source build 模式

在源文件目录下构建，产生的二进制文件将与源文件生成在一个文件夹里。想要执行就地构建，只需要在源码文件夹运行命令 cmake .，和之前说过的一样，CMake 只是生成了构建工具需要的文件，具体的目标构建还需要构建工具来做，因此还需要运行 cmake --build 执行构建。

2.2 out-of-source build 模式

单独创建一个比如 build 文件夹，在该文件夹下构建二进制文件，与源代码文件分开。执行源码外构建，需要运行如下命令。

mkdir build; cd ./build
cmake ..
cmake --build

一般使用源码外构建，可以在不同目录下用不同的选项去构建项目，比如 Debug 和 Release 分支。此外如果我们使用 Git 等项目管理工具，例如使用 Git 那么只需要在 .gitignore 忽略文件下加上我们的构建目录即可让 Git 忽略我们的构建目录。

3. CMake 工作阶段

3.1 配置阶段

在这一阶段，CMake 将解析源码树顶层的 CMakeLists.txt，并生成一个 CMakeCache.txt 以存储 cache 变量。

对于 CMake-GUI，该阶段由点击 Configure 触发，对于命令行版本的 CMake，该阶段与生成阶段结合在一起。

CMake 打印消息 Configuring done 以表示配置阶段结束。

3.2 生成阶段

在这一阶段，CMake 将根据 CMakeLists.txt 和 CMakeCache.txt 生成构建系统文件。

在 CMake-GUI 中，该阶段由点击 Generate 触发。

CMake 打印消息 Generating done 以表示生成阶段结束。

3.3 构建阶段

这一阶段由构建系统（例如 Linux 中的 Make，Windows 中的 Visual Studio）负责，在这个阶段中将生成被构建项目的目标可执行文件。

3.4 总结

我们对 CMake 有了粗略了解，我们很容易得出使用 CMake 构建工具管理项目的工作流程。

• 编写待构建项目的源代码文件，比如 C/C++ 程序。

• 编写 CMakeLists.txt 文件。

• 由 CMake 根据 CMakeLists.txt 文件规定的规则生成 Makefile 文件。

• 由构建工具 Make 根据 Makefile 文件，调用 gcc 编译器生成目标可执行文件。

Cmake 并不直接建构出最终的软件，而是产生标准的建构档（如 Unix，Linux 的 Makefile 或 Windows Visual C++ 的 projects），然后再配套一般的建构方式使用。这使得熟悉某个集成开发环境（IDE）的开发者可以用标准的方式建构他的软件。

4. 跨平台特性

对于一个优秀的软件一般都要求其能够做到跨平台运行，所以比如对于同一个 QQ源码需要在多个平台中进行编译，在 Windows 中使用 Visual Studio 编译，MacOS 中使用 Xcode 编译，Linux 中使用 Make+GCC 进行编译。

这时你会发现 QQ 源码需要在不同的平台都搭建一个工程，如果是 Linux 还要修改 Makefile，这还没完呢，如果修改一个编译选项那需要打开每个平台的构建工具进行配置，比如打开 Visual Studio，Xcode，进行配置，所以在构建工具的配置上就需要花费我们不少的精力，工作流如图。

使用 CMake 之后，一切都简单了，我们可以通过 CMake 的 CMakeLists.txt 文件定义好该项目的编译规则，编译选项，等等。然后，选择好构建工具类型，再通过 CMake 生成指定平台构建工具的配置。这样在不同平台下打开各平台的构建工具直接读取 CMake 生成的配置即可，而不必重新的配置，工作流如图。