Linux/C++进阶：Makefile 与 CMake 自动化构建详解

三、Makefile 的必要性

不用怀疑，它就是 Linux/Unix 环境下开发的必备技能，系统架构师、项目经理的核心技能，研究开源项目、Linux 内核源码的必需品。

直接答案

1. 自动化重复构建步骤，避免手动输入冗长命令
2. 智能增量编译，只重新编译修改过的文件，极大提升开发效率
3. 管理复杂依赖关系，确保构建的正确性和一致性
4. 统一团队构建流程，保证开发环境一致性

我们不妨可以想象一下——我们现在有一个含有 100 多个文件的项目，如果没有 makefile 我们将要做什么：

• 每个文件都需要预处理 --> 编译 --> 汇编 --> 链接 4 个步骤
• 文件之间有复杂的依赖关系
• 需要链接多个库
• 需要特定的编译选项
• 头文件修改需要触发相关文件重编译

可以说这个文件量的项目手动管理是不可能的！更何况这 100 个文件本身光编译一次就需要不少时间。

再其次我们每个开发者在自己机器上的开发环境都不一样，诸如此类的问题根本说不完。

四、Makefile 的简单入门

准备程序

我们先来准备一下我们的程序：

此时我们要想执行它我们就得在终端进行下述的四种操作：

那么我们 Makefile 的代码块就应该如下：

# Makefile 中的注释是以#开头
# 语法格式——目标：依赖
# 通过依赖生成目标的指令
# 注意：指令前面必须使用同一个 tab 键隔开，不能使用多个空格顶过来
hello:hello.o
g++ hello.o -o hello

hello.o:hello.s
g++ -c hello.s -o hello.o

hello.s:hello.i
g++ -S hello.i -o hello.s

hello.i:hello.cpp
g++ -E hello.cpp -o hello.i

而且我们此处能够再简化下我们的 Makefile 代码：

# Makefile 中的注释是以#开头
# 语法格式——目标：依赖
# 通过依赖生成目标的指令
# 注意：指令前面必须使用同一个 tab 键隔开，不能使用多个空格顶过来
hello:hello.o
g++ hello.o -o hello

hello.o:hello.cpp
g++ -c hello.cpp -o hello.o

实际效果

可以看到我们 makefile 直接帮我们完成了编译步骤，我们只需要运行可执行文件即可。

但这里可能会有人会问？为什么此处最先打印出来的信息是 g++ -c hello.cpp -o hello.o 这一条指令而 g++ hello.o -o hello 发而在后面，没错事实上就是这样。

因为 make 命令内部维护了一个栈结构，正是因为栈是先进后出的，所以就有了这种情况：文件还不存在——入栈，找到文件——出栈。

五、Makefile 的语法规则

规则（Rules）

1.1、规则是 Makefile 的核心，用于定义如何生成目标文件。规则的基本格式如下：

目标（target）: 依赖（prerequisites） 命令（commands）

注意：

• 命令前面必须是一个制表符（tab），不能是空格。虽然有些 make 工具允许用空格，但为了可移植性，应该始终使用制表符。
• 一个规则中，可以无目标依赖，仅仅是实现某种操作
• 一个规则中可以没有命令，仅仅描述依赖关系
• 一个规则中，必须要有一个目标

# 示例：
hello.o:hello.cpp
g++ hello.cpp -o hello.o

1.2、目标详解

1. 默认目标：一个 Makefile 里面可以有多个目标，一般会选择第一个当做默认目标也就是 make 默认执行的目标。
2. 多目标：一个规则中可以有多个目标，多个目标具有相同的生成命令和依赖文件。
3. 多规则目标：多个规则可以是同一目标。
4. 伪目标：其含义并不是一个真正的文件名，可以看做是一个标签。无依赖，相比一般文件，不会重新生成、执行。可以无条件执行，相当于对应的指令。

我们此处的 clean 就是在清理我们的项目，他不会跟我们的目标文件直接产生关联，也就是说目标文件执行时，他是不会动的，如果要用我们需要直接进行 make clean 指定目标。

但如果有人试过你就会发现，不加这个 .PHONY: 直接写个 clean 也是能直接运行的，但为什么此处要加上这个东西呢？那是为了将这个 clean 与同名文件区分开来。什么意思呢，如果我们该目录下有个名为 clean 的文件，那么我们此时再运行 clean 目标对应的指令将会失效。

那么这个时候，我们就需要让这个 clean 变为伪目标，也就是让其变为一种'标签'，这样即使有同名文件，那么我们的 make 也不会将 clean 看作是一个生成文件了。

1.3、目标依赖

1. 文件时间戳：make 每次运行都会根据时间戳来判断目标依赖是否要进行更新：

   • 所有文件都更改过，则对所有文件进行编译，生成可执行程序
   • 在上次 make 之后修改过的 cpp 文件，会被重新编译
   • 在上次 make 只写修改过的头文件，依赖该头文件的目标依赖也会重新编译

2. 模式匹配：

   • % ——> 通配符匹配
   • $@ ——> 目标
   • $^ ——> 依赖
   • $< ——> 第一个依赖
   • * ——> 普通通配符

注意：%是 Makefile 中的规则通配符，*是普通通配符。

下面用一张图带大家练习练习：

可以看到我们右上角的 Makefile 文件，我敢肯定初学者看到这个图片时肯定会觉得看起来非常难受的，事实确实是这种写法的可读性很差，但我们的耦合性就大大增强了，也就是当我们想改上面的东西，那么我就只用对目标与目标依赖进行更改，而不用对命令进行更改。

那有人可能会问：我真的懒得不行，那这不 main.o swap.o 两个目标依赖不我还得手改吗，那这俩能不能也做成个什么通用的标志，让我再轻松一下，有的兄弟有的，就是我们后面要讲的变量。

1.4、命令

1. 命令的组成：由 shell 命令组成，以 tab 键开头
2. 命令的执行：每条命令，make 会开一个进程。每条命令执行完，make 会检测这个命令的返回码。如果返回成功，则继续执行后面的命令；如果返回失败，则 make 会终止当前执行的规则并退出。
3. 并发执行命令：make -j4 ----->表示开辟 4 个线程执行。time make ----->执行 make 时，显示当前时间。

变量（Variables）

2.1、变量基础

1. 变量定义：变量名 = 变量值
2. 变量的赋值：
   • 追加赋值：+= --->在原有的基础上追加相关内容
   • 条件赋值：?= --->如果之前没有值，则为变量赋值，如果之前有值，则不进行赋值
3. 变量的使用：$(变量名)或者${变量名}（通常前者我们用的多些）

2.2、变量的分类

1. 立即展开变量：使用 := 操作符进行赋值。在解析阶段直接赋值常量字符串。
2. 延迟展开变量：使用 = 操作符进行赋值。将最后一次赋值的结果给变量名使用。
3. 注意事项：一般在目标、目标依赖中使用立即展开赋值；在命令中一般使用延迟展开赋值变量。

2.3、变量的外部传递

我们可以通过命令行给变量进行赋值操作。

条件判断（Conditional Directives）

3.1、关键字

• ifeq、else、endif
• ifneq、else、endif

其实不难看出，上下两对刚好相反，上面意为是否相等，那么下面就意为是否不相等。

3.2、使用

ifeq (要判断的量，判断的值)
    Makefile 语句
else
    Makefile 语句
endif

注意：

• 条件语句从 ifeq 开始执行，括号与关键字自减使用空格隔开
• 括号里面挨着括号处，不允许加空格
• ifeq 后的空格也是一定要有的

CMake

一、什么是 CMake

直接答案

CMake 是一个跨平台的安装编译工具，可以使用简单的语句来描述所有平台的安装（编译过程）。它可以使用几行或者几十行的代码来完成非常冗长的 Makefile 代码。

简单来说，CMake 就像一个'翻译官'：

• 你用 CMake 的'语言'写一份菜谱（CMakeLists.txt）
• CMake 根据客人（Windows/Mac/Linux）的口味，翻译成具体食谱（Makefile/VS Project/Xcode Project）
• 客人按自己的食谱做菜（构建项目）

二、为什么要使用 CMake？

直接答案

光使用 Makefile 在实际开发中会遇到很多问题，例如下：

当时开发者的痛苦：

• 项目要在 Windows、Linux、macOS 上都能构建
• Windows 开发者：我需要 Visual Studio 的.sln 文件
• Linux 开发者：我需要 Makefile
• macOS 开发者：我需要 Xcode 的.xcodeproj

那么我们现在有两种解决方案的提供：

• 解决方案 1：维护三套构建配置 ❌
• 解决方案 2：写一个工具，生成所有平台的构建文件 ✅

三、CMake 的语法规则

1. 基本语法：指令（参数 1 参数 2 ...）
   • 参数使用括号括起来
   • 参数之间使用空格或分号隔开
2. 注意：指令是大小写无关的，但是参数和变量是大小写相关的。

# 定义一个变量名叫 HELLO 变量的值为 hello.cpp
set(HELLO hello.cpp)
# 通过 main.cpp 和 hello.cpp 编译生成 hello 可执行程序
add_executable(hello main.cpp hello.cpp)
# 作用同上
ADD_EXECUTABLE(hello main.cpp ${HELLO})

3. 变量使用：${}进行取值，但是在 if 控制语句中，是直接使用变量名的。

if(HELLO) 是正确的
if(${HELLO}) 是不正确的

4. 语句不以分号结束。

四、重要的指令

1> cmake_minimum_required

指定 CMake 的最小版本支持，一般作为第一条 cmake 指令。

# CMake 设置最小支持版本为 2.8
cmake_minimum_required(VERSION 2.8)

2> project

定义工程的名称，并可以指定工程支持的语言。

# 指定工程的名称为 HELLOWORLD
project(HELLOWORLD CXX)
# 表示工程名为 HELLOWORLD 使用的语言为 C++

3> set

显式定义变量。

# 定义变量 SRC 其值为 sayhello.cpp hello.cpp
set(SRC sayhello.cpp hello.cpp)

4> add_executable

通过依赖生成可执行程。

# 编译 main.cpp 生成 main 的可执行程序
add_executable(main main.cpp)

5> include_directories

向工程添加多个特定的头文件搜索路径吗，类似于 g++ 编译指令中的 -I。

# 将/usr/lib/mylibfolder 和 ./include 添加到工程路径中
include_directories(/usr/lib/mylibfolder ./include)

6> link_directories

向工程中添加多个特定的库文件搜索路径，类似于 g++ 编译指令的 -L 选项。

# 将将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径中
link_directories(/usr/lib/mylibfolder ./lib)

7> add_library

生成库文件（包括动态库和静态库）。

# 通过 SRC 变量中的文件，生成动态库
# 该语句生成的是动态库
add_library(hello SHARED ${SRC})
# 该语句生成的是静态库
add_library(hello STATIC ${SRC})

8> add_compile_options

添加编译参数。

# 添加编译参数：-Wall -std=c++11
add_compile_options(-Wall -std=c++11)

9> target_link_libraries

为 target 添加需要链接的共享库，类似于 g++ 编译中的 -l 指令。

# 将 hello 动态库文件链接到可执行程序 main 中
target_link_libraries(main hello)

五、CMake 常用变量

1> CMAKE_C_FLAGS

gcc 编译选项的值。

2> CMAKE_CXX_FLAGS

g++ 编译选项的值。

# 在 CMAKE_CXX_FLAGS 编译选项后追加 -std=c++11
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")

3> CMAKE_BUILD_TYPE

编译类型（Debug、Release）。

# 设定编译类型为 Debug，调试时需要选择该模式
set(CMAKE_BUILD_TYPE Debug)
# 设定编译类型为 Release，发布需要选择该模式
set(CMAKE_BUILD_TYPE Release)

六、CMake 编译工程与代码实战

目录结构

CMake 目录结构：项目主目录中会放一个 CMakeLists.txt 的文本文档，后期使用 cmake 指令时，依赖的就是该文档。

1. 包含源文件的子文件夹中包含 CMakeLists.txt 文件时，主目录的 CMakeLists.txt 要通过 add_subdirectory 添加子目录。
2. 包含源文件的子文件夹中不包含 CMakeLists.txt 文件时，子目录编译规则，体现在主目录中的 CMakeLists.txt。

两种构建方式

1> 内部构建

不推荐使用。

内部构建会在主目录下，产生一大堆中间文件，这些中间文件并不是我们最终所需要的，和工程源文件放在一起时，会显得比较杂乱无章。

## 内部构建
# 1、在当前目录下，编译主目录中的 CMakeLists.txt 文件生成 Makefile 文件
cmake .
# . 表示当前路径
# 2、执行 make 命令，生成目标文件
make

2> 外部构建

推荐使用。

将编译输出的文件与源文件放到不同的目录下，进行编译，此时，编译生成的中间文件，不会跟工程源文件进行混淆。

## 外部构建步骤
# 1、在当前目录下，创建一个 build 文件，用于存储生成中间文件
mkdir build
# 2、进入 build 文件夹内
cd build
# 3、编译上一级目录中的 CMakeLists.txt，生成 Makefile 文件以及其他文件
cmake ..
# ..表示上一级目录
# 4、执行 make 命令，生成可执行程序
make

代码实战

同一目录下的文件编译

不废话，直接上图，保证看的明明白白的。

分文件编译

依旧直接上图，此处用的代码与我们刚 makefile 演示的 swap 一样。但值得一提的是，多文件编译更依赖于我们的 CMake/Makefile，因为在 vscode 多文件编译时，我们的头文件是无法直接被读取的，必须要在同一目录下才能读取到，但这样就与我们多文件编译冲突了。

结语

那么关于 Makefile 与 CMake 的讲解就到这里了。