在 linux 下使用 CMake 构建应用程序
级别：初级
王程明 (wangchengming.jlu@gmail.com), 硕士研究生, 吉林大学计算机科学与技术学院
2009 年 2 月 05 日
本文介绍了一个跨平台的自动化构建系统 CMake 在 linux 上的使用方法。 CMake 是一个比
automake 更加容易使用的工具，能够使程序员从复杂的编译连接过程中解脱出来。文中通过一些例子介
绍使用 CMake 处理多源文件目录的方法、查找并使用其他开发包的方法以及生成 debug 版和 release
版程序的方法。
### 在Linux下使用CMake构建应用程序
#### 一、引言
随着软件开发的日益复杂化，构建自动化工具成为提高开发效率的关键因素之一。在众多自动化构建工具中，CMake因其跨平台特性、易用性及灵活性而在开源社区中广受欢迎。本文旨在介绍如何在Linux环境下使用CMake构建应用程序，并通过实例演示CMake的基本使用方法。
#### 二、CMake概述
CMake是一个开源的、跨平台的构建系统，它通过读取一个名为`CMakeLists.txt`的文本文件来生成构建脚本（如Unix Makefiles或Visual Studio解决方案）。CMakeLists.txt文件描述了项目的结构和构建逻辑，使得开发者能够在不同的平台上进行一致的构建操作。
#### 三、CMake基本使用流程
在Linux平台下使用CMake的一般步骤包括：
1. **编写CMakeLists.txt**：定义项目的结构、依赖关系等。
2. **生成构建文件**：通过`cmake`或`ccmake`命令根据`CMakeLists.txt`生成构建文件。
3. **编译**：利用生成的构建文件（通常是Makefile）执行实际的编译工作。
#### 四、CMakeLists.txt详解
CMakeLists.txt文件是CMake的核心，通过它来控制整个构建过程。以下是一些常用命令及其含义：
- **PROJECT(项目名)**：定义项目名称。
- **CMAKE_MINIMUM_REQUIRED(版本)**：指定CMake最低版本要求。
- **AUX_SOURCE_DIRECTORY(目录 变量名)**：获取指定目录下的所有源文件，并将文件名存储到变量中。
- **ADD_EXECUTABLE(目标名 源文件列表)**：基于提供的源文件创建一个可执行文件。
- **ADD_SUBDIRECTORY(子目录)**：递归地处理子目录，便于管理多目录结构。
- **TARGET_LINK_LIBRARIES(目标名 库列表)**：为指定的目标链接外部库。
#### 五、示例：构建简单的C++程序
为了更好地理解CMake的工作原理，我们来看一个具体的示例。假设有一个简单的C++程序，包含一个`main.cpp`文件。
##### 1. `main.cpp`文件内容
```cpp
#include<iostream>
int main() {
std::cout << "Hello World!" << std::endl;
return 0;
}
```
##### 2. `CMakeLists.txt`文件内容
```cmake
PROJECT(main)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
AUX_SOURCE_DIRECTORY(. DIR_SRCS)
ADD_EXECUTABLE(main ${DIR_SRCS})
```
- 第一行定义了项目名为`main`。
- 第二行指定CMake版本至少为2.6。
- 第三行通过`AUX_SOURCE_DIRECTORY`命令获取当前目录下的所有源文件，并存储到变量`DIR_SRCS`中。
- 第四行创建一个名为`main`的可执行文件，其源文件列表为`DIR_SRCS`。
##### 3. 生成Makefile并编译
执行`cmake .`或`ccmake .`命令生成Makefile，然后使用`make`命令编译程序。
#### 六、处理多源文件目录
当项目包含多个源文件目录时，可以通过以下方式处理：
##### 1. 目录结构
假设目录结构如下：
```
step2/
CMakeLists.txt
src/
CMakeLists.txt
test.cpp
```
##### 2. 主目录中的`CMakeLists.txt`文件
```cmake
PROJECT(main)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
ADD_SUBDIRECTORY(src)
AUX_SOURCE_DIRECTORY(. DIR_SRCS)
ADD_EXECUTABLE(main ${DIR_SRCS})
TARGET_LINK_LIBRARIES(main Test)
```
- 第三行使用`ADD_SUBDIRECTORY`命令添加子目录`src`。
- 第六行使用`TARGET_LINK_LIBRARIES`指令将`main`可执行文件与名为`Test`的库进行链接。
##### 3. 子目录`src`中的`CMakeLists.txt`文件
```cmake
ADD_LIBRARY(Test SHARED test.cpp)
```
- 创建一个共享库`Test`，源文件为`test.cpp`。
#### 七、总结
通过本文的学习，我们可以了解到CMake作为一种强大的构建工具，在Linux环境下构建应用程序时的优势和基本用法。无论是简单的单文件程序还是复杂的多模块项目，CMake都能够提供灵活而高效的构建方案。此外，CMake还支持多种构建类型（如Debug和Release），这使得开发者能够轻松地切换构建模式，满足不同的测试和发布需求。
