【C++】 预编译头文件

许多初学 VC 的朋友也许都为那么一个问题困扰过：

    为什么所有的 cpp 都必须 #include "stdafx.h"

    也许请教了别的高手之后，他们会告诉你，这是预编译头，必须包含。可是，这到底
是为什么呢？预编译头有什么用呢？

    这得从头文件的编译原理讲起。其实头文件并不神秘，它的全部作用，就是把自己的
所有内容直接“粘贴”到相应的 #include 语句处。如果不相信的话，不妨做个实验，将
一个 cpp 中的所有 #include 语句删掉，并将它包含的文件粘贴到相应的位置，你会发
现，文件的编译和运行都完全没有受到影响。其实，编译器在编译你的程序的时候，所做
的第一件事，也就是展开所有的 #include 语句和 #define 语句。

    头文件的出现，固然给书写程序带来了很大方便。可是到了 Windows 时代后，慢慢
就呈现出一些问题了。几乎所有的 Windows 程序都必须包含 windows.h，而那个文件却
硕大无比，将它展开后往所有文件中一粘贴，编译的时候立刻慢得像只蜗牛。

    到了 MFC 时代后，情况更为恶劣了。毕竟 C 风格的 Windows 头文件里面包含的还
仅仅是函数定义和宏，编译难度不算太大，而 MFC 库里面的头文件可都是类声明啊！更
何况，一个最简单的工程，都会生成大量的类，需要用到大量的函数。如果工程稍微复杂
一些，编译难度可想而知！

    但是，人们惊奇地发现，虽然用到的头文件又多又杂，但是在一个工程中，总有那么
一堆头文件，是几乎所有 cpp 都必须包含的。那么，可不可以把这些头文件提取出来，
只编译一编，然后所有其它 cpp 就都能使用呢？没错，这就是预编译头的思想都由来！

    实践证明，使用了预编译头技术后，编译速度大大提高了。可以到你的工程目录下的
Debug 或 Release 目录中看一看，里面有一个体积极为硕大的 .pch 文件，那就是传说
中的“编译之后的预编译头”。

    使用了预编译头技术后，虽然带来了极大地方便，但也造成了一个问题：由于它假定
预编译头中包含过的头文件会在所有 cpp 中使用，因此它在编译你的 cpp 的时候，就会
将预编译头中已经编译完的部分加载到内存中。如果它突然发现你的 cpp 居然没有包含
预编译头，它就会很郁闷，因为它不知道该如何将已编译完的部分从内存中请出去，整个
编译过程就会失败。

    因此，如果你使用了预编译头技术，就必须在所有的 cpp 中包含预编译头。MFC 工
程中为你建立了一个默认的预编译头 stdafx.h，如果你愿意，也可以在自己的工程中使
用其它文件名作为你的预编译头，如果你觉得有必要。
 

 

预编译头文件的使用  
关键字：预编译，/Yu，/Yc，/Yx
本文介绍VC6的预编译功能的使用，由于预编译详细使用比较的复杂，这里只介绍几个最重要的预编译指令: /Yu, /Yc,/Yx,/Fp。其它的详细资料可以参考:
      MSDN->Visual Studio D6.0Document -> Visual C++6.0 Document
         ->VC++ Programmer Guider ->Compiler and Linker
         ->Details->Creating Precompiled Header files

预编译头的概念： 
所谓的预编译头就是把一个工程中的那一部分代码,预先编译好放在一个文件里(通常是以.pch为扩展名的)，这个文件就称为预编译头文件这些预先编译好的代码可以是任何的C/C++代码--------甚至是inline的函数，但是必须是稳定的，在工程开发的过程中不会被经常改变。如果这些代码被修改，则需要重新编译生成预编译头文件。注意生成预编译头文件是很耗时间的。同时你得注意预编译头文件通常很大，通常有6-7M大。注意及时清理那些没有用的预编译头文件。
也许你会问：现在的编译器都有Time stamp的功能，编译器在编译整个工程的时候，它只会编译那些经过修改的文件，而不会去编译那些从上次编译过，到现在没有被修改过的文件。那么为什么还要预编译头文件呢？答案在这里，我们知道编译器是以文件为单位编译的，一个文件经过修改后，会重新编译整个文件，当然在这个文件里包含的所有头文件中的东西（.eg Macro, Preprocessor ）都要重新处理一遍。VC的预编译头文件保存的正是这部分信息。以避免每次都要重新处理这些头文件。
预编译头的作用：
方法一：手动方法 
根据上文介绍，预编译头文件的作用当然就是提高便宜速度了，有了它你没有必要每次都编译那些不需要经常改变的代码。编译性能当然就提高了。
预编译头的使用：
     要使用预编译头，我们必须指定一个头文件，这个头文件包含我们不会经常改变的代码和其他的头文件，然后我们用这个头文件来生成一个预编译头文件（.pch文件）
 想必大家都知道 StdAfx.h这个文件。很多人都认为这是VC提供的一个“系统级别”的，编译器带的一个头文件。其实不是的，这个文件可以是任何名字的。我们来考察一个典型的由AppWizard生成的MFC Dialog Based　程序的预编译头文件。（因为AppWizard会为我们指定好如何使用预编译头文件，默认的是StdAfx.h，这是VC起的名字）。我们会发现这个头文件里包含了以下的头文件：
#include <afxwin.h>         // MFC core and standard components
#include <afxext.h>         // MFC extensions
#include <afxdisp.h>        // MFC Automation classes
#include <afxdtctl.h>             // MFC support for Internet Explorer 4 Common Controls
#include <afxcmn.h>     
这些正是使用MFC的必须包含的头文件，当然我们不太可能在我们的工程中修改这些头文件的，所以说他们是稳定的。
那么我们如何指定它来生成预编译头文件。我们知道一个头文件是不能编译的。所以我们还需要一个cpp文件来生成.pch 文件。这个文件默认的就是StdAfx.cpp。在这个文件里只有一句代码就是：#include “Stdafx.h”。原因是理所当然的，我们仅仅是要它能够编译而已―――也就是说，要的只是它的.cpp的扩展名。我们可以用/Yc编译开关来指定StdAfx.cpp来生成一个.pch文件，通过/Fp编译开关来指定生成的pch文件的名字。打开project ->Setting->C/C++ 对话框。把Category指向Precompiled Header。在左边的树形视图里选择整个工程　（如图）
（图１）
在图中我们的Project Options(右下角的那个白的地方)可以看到 /Fp “debug/PCH.pch”，这就是指定生成的.pch文件的名字，默认的通常是　<工程名>.pch（我的示例工程名就是PCH）。
然后，在左边的树形视图里选择StdAfx.cpp.如图：(图２)
这时原来的Project Option变成了 Source File Option（原来是工程，现在是一个文件，当然变了）。在这里我们可以看到 /Yc开关，/Yc的作用就是指定这个文件来创建一个Pch文件。/Yc后面的文件名是那个包含了稳定代码的头文件，一个工程里只能有一个文件的可以有YC开关。VC就根据这个选项把 StdAfx.cpp编译成一个Obj文件和一个PCH文件。
   然后我们再选择一个其它的文件来看看，如图：
在这里，Precomplier 选择了 Use ………一项，头文件是我们指定创建PCH 文件的stdafx.h
文件。事实上，这里是使用工程里的设置，（如图1）/Yu”stdafx.h”。
   这样，我们就设置好了预编译头文件。也就是说，我们可以使用预编译头功能了。以下是注意事项：
1):如果使用了/Yu，就是说使用了预编译，我们在每个.cpp文件的最开头，我强调一遍是最开头，包含 你指定产生pch文件的.h文件（默认是stdafx.h）不然就会有问题。如果你没有包含这个文件，就告诉你Unexpected file end. 如果你不是在最开头包含的，你自己试以下就知道了，绝对有很惊人的效果…..
2）如果你把pch文件不小心丢了，根据以上的分析，你只要让编译器生成一个pch文件就可以了。也就是说把 stdafx.cpp（即指定/Yc的那个cpp文件）从新编译一遍就可以了。当然你可以傻傻的 Rebuild all。简单一点就是选择那个cpp文件，按一下Ctrl + F7就可以了。
方法二。自动使用 
很简单只要指定/YX就可以了。或者在上图中选择Automatic………就可以了。注意的事情是如果你指定了/Yc /Yu的话，/Yx是会被忽略的。前者的优先级别高一些。

DXUT(The DirectX Utility Library)是初学DirectX的一个好用的框架, 今天照着Sample里的EmptyProject建了一个工程, 引用了DXUT的代码, 并将设置-->C/C++-->Precompiled设置为Use Precompiled Header(/UC), DXUT.h, 发现怎么也编译不过去. 搞了半天才发现DXUT.cpp文件没有设置成Create Precompiled Header(/YC).:(

下面随便介绍一下预编译头文件的原理:

在DXUT.cpp里include一次DXUT.h，生成一次pch，pdb文件，其他地方实际上直接用这个编译的结果，从而减少编译时间，提高编译效率。一般，我们把常用的不变的库头文件放里面，如，atlbase.h，atlcore.h，windows.h等，通常的com里import进来的dll，tlb也放这个里面，这样，它能做到，只编译一次，其他地方直接用编译出的结果。

如果预编译头文件被正确使用时，它确实大大提高我们编程的效率（你工作中，有多少时间是在等编译完成？很多吧，这个时候一般都很无聊，无奈，浪费时间）。但是他太容易用错了. 下面是几种常见的错误用法.

1) 在预编译头文件里include自己的头文件(当然, 如果你的头文件不经常变化, 也可以)

原因:自己的头文件一般会经常变, 便利后导致预编译的东东重新编译, 降低了编译速度.

2) 在其他的头文件里也include 预编译头文件

假设你的其他头文件也include了预编译头文件, 如果别人引用你的这个头文件又没有设置成预编译头文件, 那引用你头文件的这个人就煎熬了.

原因：由于你用到的.h文件里include了预编译头文件，他在他本身的project里，vs能够判断的出他是预编译头，也能找的到需要的pch，pdb文件。所以对写这个.h文件的人没影响。但是你作为他的客户，你工作在你的project下，你include了他的h头文件，而这时vs判断不出他的头文件里include的stdafx是预编译头文件，做普通文件编。那可想而知，他的stdafx里如果有import外面大型的库（如inventor的tlb，非常慢，我们犯了这个错），那编译速度简直是煎熬。最要命的是，以后你做任何简单的修改都要重编，这和预编译解决的问题恰好相反了。

下面给出一个使用预编译头文件的操作步骤, 享受一下预编译头文件给我们带来的编译速度的提升:

1) 添加一个stdafx.h文件(名字随便取, 这里用了VS默认提供的名称), 在这个.h文件里include要使用的头文件(一般是外部的库, 自己写的不常变的头文件也可以加进来)

2) 添加一个stdafx.cpp文件, 并include "stdafx.h"

3)项目属性-->c/c++-->Precompiled设置为Use Precompiled Header, stdafx.h

4)stdafx.cpp属性-->c/c++->Precompiled设置为Create Precompiled Header, stdafx.h

done!

最近从VC6.0过渡到VS2008，还有一些东西正在摸索阶段，于是有些以前没有注意到问题就逐渐显示，我打算抓住一个是一个，把所有的厘清的感悟或是新增的知识写下来，希望给没有注意到这类问题的朋友抛砖引玉吧。
   首先，就是预编译头文件。
1.概念
   所谓的预编译头文件，其实我们很熟悉的，这里的头文件（Microsoft Visual C++中）一般的说就是我们常见的stdafx.h。这个名字是微软默认的，名字还可以改，内容更加可以改。这个就是待编译的头文件，但是，我们知道，头文件是不能被编译的，因此，我们就可以用一个stdafx.cpp，这个文件中一开始可以没有内容，但必须加一句“include<stdafx.h>”,然后compile（ctrl+F7）一下就可以出现一个（.pch）文件，这个就是我们常说的预编译头文件。
    为什么需要预编译头文件呢？原因很简单，这个其实这么做的目的就是减少编译时间。因为，如果不是这么做的话，在编译的时候，假如一个头文件被很多的文件使用，那就费时了，因为得一次又一次地进行编译。而有了预编译头文件的话，我们把出现频率很高的那部分东西（通常是一些系统的头文件或者是一些自己设定的但是不常变动的头文件）已经编译好了，就像一个通用零件一样，已经搞好了，用到的时候就直接装就行。这样就可以利用编译好的成果，从而能非常有效地节约编译的时间了。
2.VS2008中的预编译头文件
    打开VS2008，File->New->Project,建立一个Win32 console application，选择next，在Application Settings中的Additional options:中的Precompiled header默认勾选，点Finish，就可建立一个带预编译头文件的Win32控制台程序了。可以看到Solution explorer中有stdafx.h和stdafx.cpp，这两个东西就是用来生成预编译头文件的，也是微软默认的。
    此时compile，会发现是不能成功的，错误是 fatal error C1083: Cannot open precompiled header file: 'Debug\×××.pch': No such file or directory。意思就是没有.pch文件。如上面所说，其实编译的过程是利用预先编译好的预编译头文件来减少编译的工作量，那么既然没有这个预编译头文件，那怎么编译呢？我们可以在Solution explorer，右击工程，单击property，在右边的框中选择Configuration Properties->C/C++->Preprocessor,看到在右边的Create/Use Precompoled Header中默认的是Use Precompiled Header(/Yu),也就是说现在还没有建立.pch呢，就开始用了，显然不适合，那就改喽，单击之，选择Create Precompoled Header（/Yc），便可以了。编译之，可以看到在Debug文件夹中多了个.pch，也就是说这个预编译头文件搞定了。
    再回到Create/Use Precompoled Header那页中，看到Create/Use Precompoled Header下面，Create/Use PCH Through File中是Stdafx.h，这里还是上面说的，一会编译器就默认用这个制作预编译头文件，制作完成的头问价放哪里呢，下面一个项是Precompoled Header File就是指示生成的.pch的地址的，其默认的地址是$(IntDir)\$(TargetName).pch（这里的$表示当前工程文件夹，$(IntDir)表示当前文件夹的Debug文件夹，下拉点edit可以看到类似IntDir\Outir之类的地址目录），生成在Debug目录下，名称是（工程名）.pch。这里，可以改下，自己edit下，把$(TargetName).pch改为PPP.pch，编译一下，可以看到Debug下出现了一个PPP.pch，这个是新的预编译头文件，系统会自动的为你添加进去，以后自动用它进行的编译的。但是，有一点，就是刚才的那个预编译头文件并没有消失，还挺大的呢，得几个M，也就是说，原来的头文件没有用了，但是并没有覆盖掉，那么这就提醒我们要及时清理没有用的头文件了。
    再有就是既然已经Create了个预编译头文件了，那么以后就不要总是Create了，我们就要把Create/Use Precompoled Header中的改回Use Precompiled Header(/Yu),然后就可以节约编译时间了。
3.什么情况下使用预编译头文件
    前面也有所提及，这里我自己系统地总结下：
    1）一些大型程序用这个比较好，但是一些小型的不点行的程序还是不要用预编译头文件的好，因为Create一个预编译头文件本身也是要时间的。
    2）预编译头文件中一般只放系统头文件。比如说你使用MFC，很多的头文件就必须要来回地用，这时，不要你操心，系统就会默认地给你弄个预编译头文件，来成倍地节约编译时间。
    3）自己编的一些很常用的基本固定不变的头文件。其实，我倾向于这么做，就是我们自己搞一个预编译头文件，用自己的名字，然后可以把系统的Stdafx.h包含进去。注意这么做的话，千万要用自己的另外定义的名字。如果你在Stdafx.h里面包含自己的头文件，结果会把下家（看程序的人）迷糊了，因为我们习惯上在自己编的头文件中以“另可错杀一百，不可放过一个”的原则来包含预编译头文件，假如别人来使用这个头文件，那他可惨了，编译器会把这个当普通文件编的，那可不是节约时间了，那是在浪费时间。