72 C++的预编译头文件

本节会讲 C++的precompiled header（预编译头文件），首先讨论这是什么，为什么你应该使用它。然后进入 VS 和 gcc、g++，了解如何在现实世界中设置它们并通过一个简单例子看看实际的好处。

1. 什么是预编译头文件

预编译的头文件实际上是让你抓取一堆头文件，并将它们转换成编译器可以使用的格式，而不必一遍又一遍地读取这些头文件。举个例子，每次在 C++文件中#include <vector>的时候，它需要读取整个 Vector 头文件并编译它，而且 Vector 还包含一堆其它的包含文件，这些文件也一样需要读取，预处理器必须把这些复制到这个 Vector 文件，这就有 10w+行代码了，它们需要被解析并以某种形式标记并编译，在你想要编译 main 文件之前，因为你的 main 文件包含 Vector 文件的话，Vector 必须复制并粘贴到 main 文件中，然后所有代码每次都需要被解析和编译。重点是每次你对 C++文件进行修改，哪怕只是加了个空格，整个文件都要重新编译，所以 Vector 文件必须被复制并粘贴到你的 C++文件中，从头开始重新解析并编译。不仅如此，你的项目中有多个文件它们又都包含了 Vector，你不得不持续一遍遍地解析同样的代码，这需要大量时间。

所以你可以用一个叫做预编译头文件的东西来代替，它的作用是接受一堆你告诉它要接收的头文件（基本上是一堆代码）它只编译一次，以二进制格式存储，这对编译器来说比单纯的文本处理要快得多。这样就不需要解析整个 Vector 文件，每次它只需要看预编译的头文件，which 此时已经是非常快速且容易使用的、对编译器来说很容易使用的二进制格式。这意味着它会大幅加快编译时间，特别是你的项目越来越大，你会有越来越多的 C++文件。越来越多的头文件，诸如此类，你可以在预编译头文件中添加更多内容，你也有更多使用了共同头文件的源文件需要编译，它会指数级地加速，好的多得多。

所以如果你关心编译时间，你一定要使用预编译头文件。

不过，还有些你不应该用预编译头文件做的事：到目前为止提到的预编译头文件，其本质还是头文件，which 包含了一堆其它头文件。因此你可能会想把项目中所有的东西都放在预编译头文件中，如果这样做的话是不是构建速度飞快。

是这样，但是如果你把东西放到预编译头文件中，而这些东西会发生变化，在实际的项目中我们在处理项目所以它很有可能会变化，显然必须重新构建预编译的头文件，而这要花费时间，这也可能会导致编译速度变慢。所以不要把会频繁更改的文件放入预编译头文件中。

尽管预编译头文件很有用，而且把你自己的项目文件当进去也没问题，比如把一个不会需要修改的 Log.h 文件放进去就很好，因为这个文件很常用，也方便使用，你不需要再手动地将 Log 包含到项目中的每个 C++文件中。但只要这个 Log 会修改，就不适合放入预编译头文件中，否则每次都要重新编译。

预编译头文件真正有用的是外部依赖，本质上它主要用于不是你写的那些代码，比如 STL、Windows api 等，如果你要#include <windows.h>，which is a 巨大的的头文件，包含了非常多的其它头文件，你不回去修改 windows.h 或者 STL，所以它没有理由不被你放在预编译头文件中，因为它们的代码可能比你的实际项目代码多很多倍，每个 C++文件每次都要编译它们可想是一件多么恐怖的事情，你可能永远也不会去修改它们。因此直接把它们放入到预编译头文件中就不用管了。

2. 依赖关系

PCH（就是预编译头文件）实际上做的事是把所有东西都塞进来，它可能会隐藏现在实际正在使用的东西，会影响可读性。比如只有个别文件需要使用一个窗口库 GLFW，那就没必要把所有的依赖项都放在 PCH 中，如果你只看一个单独的 cpp 文件你并不知道它需要什么依赖，再把它导入其它文件时就不好理解它依赖的东西了。但如果你通过实际的include包含它们就很清晰了，可以看到每个文件需要什么文件。但是如果你只包含 PCH，然后 PCH 中放很多包含文件，就会比较麻烦了。

所以不要把所有依赖都放在 PCH 中，因为包含实际的依赖会更容易阅读。应该放进 PCH 的东西是像 STL 这样的，因为 string、vectors、std::cout 是许多地方都要用到的，你不希望每次都编译它们，而 GLFW 可能就只需要编译一次。

3. 案例

对于 Visual Studio

我们需要创建一个包含头文件的 cpp 文件，然后编辑它的属性（并且把第二行的值清空）：

然后到整个项目下，选择项目属性，指定为 Use 并且指定文件名（注意要选择全平台）：

然后 build 整个项目，可以去 Tools 的设置里面修改，让 VS 显示 build 耗时：

不使用 PCH 的 build 耗时和后续构建耗时：

使用 PCH 后的 build 耗时和后续构建耗时：

可以看到用 pch 的构建速度快很多。

对于 g++

Windows 用户可以用 Cygwin 模拟 Unix 环境，或直接使用 Windows 的计时功能：

Measure-Command { g++ -std=c++11 Main.cpp }

创建预编译文件：

g++ -std=c++11 pch.h

生成了这个 pch.h.gch 文件，是个多达 100MB 的文件

删掉 a.exe，相当于 clean build，再计时：

可以发现快了六倍左右。

总结

希望这些例子可以带来些启发。回顾一下为什么要用预编译头文件：加速编译时间，也使实际编写代码更加方便，因为你不需要再一遍遍地包含常用的头文件。除非是非常小的 sandbox 项目，每个项目都应该使用 PCH，不过你在里面放什么就是另一个故事了。