C++ 頭檔的包含順序研究

一． 《Google C++ 程式設計風格指南》裡的觀點

公司在推行編碼規範，領導提議基本上使用《Google C++ 程式設計風格指南》。其中《Google C++ 程式設計風格指南》對於頭檔的包含順序是這樣的：

Names and Order of Includes
link ▽Use standard order for readability and to avoid hidden dependencies:C library, C++ library, other libraries’ .h, your project’s .h.
All of a project’s header files should belisted as descendants of the project’s source directory without use of UNIXdirectory shortcuts . 
(the current directory) or .. (the parent directory). Forexample, google-awesome-project/src/base/logging.h should be included as
#include “base/logging.h”
In dir/foo.cc or dir/foo_test.cc, whosemain purpose is to implement or test the stuff in dir2/foo2.h, order yourincludes as follows:
dir2/foo2.h (preferred location — seedetails below).
C system files.
C++ system files.
Other libraries’ .h files.
Your project’s .h files.
The preferred ordering reduces hiddendependencies. We want every header file to be compilable on its own. 
Theeasiest way to achieve this is to make sure that every one of them is the first.h file #included in some .cc.
dir/foo.cc and dir2/foo2.h are often in thesame directory (e.g. base/basictypes_test.cc and base/basictypes.h), but can bein different directories too.
Within each section it is nice to order theincludes alphabetically.
For example, the includes ingoogle-awesome-project/src/foo/internal/fooserver.cc might look like this:
#include "foo/public/fooserver.h"  // Preferred location.
#include <sys/types.h>
#include <unistd.h>
#include <hash_map>
#include <vector>
#include "base/basictypes.h"
#include"base/commandlineflags.h"
#include "foo/public/bar.h"

在這裡我談一下我對上面的理解（如不當，還請諸位同學指正）：

1.      為了加強可讀性和避免隱含依賴，應使用下面的順序：C標準函式庫、C++標準函式庫、其它函式庫的頭檔、你自己工程的頭檔。不過這裡最先包含的是首選的頭文件，即例如a.cpp文件中應該優先包含a.h。首選的頭檔是為了減少隱藏依賴，同時確保頭檔和實作檔案是相符的。具體的例子是：如果你有一個cc檔案（linux平台的cpp檔案後綴為cc）是google-awesome-project/src/foo/internal/fooserver.cc，那麼它所包含的頭檔的順序如下：

#include <sys/types.h>  
#include <unistd.h>  
  
#include <hash_map>  
#include <vector>  
  
#include "base/basictypes.h"  
#include "base/commandlineflags.h"  
#include "foo/public/bar.h"

2. 在包含頭檔時應該加上頭檔所在工程的資料夾名，即假如你有這樣一個工程base，裡面有一個logging.h，那麼外部包含這個頭檔應該這樣寫：

#include “base/logging.h”，而不是#include “logging.h”

我們看到的是這裡《Google C++ 程式設計風格指南》倡導的原則背後隱藏的目的是：

1 . 為了減少隱藏依賴，同時頭文件和其實現文件匹配，應該先包含其首選項（即其對應的頭文件）。

2. 除了首選項外，遵循的是從一般到特殊的原則。不過我覺得《Google C++ 程式設計風格指南》的順序：C標準函式庫、C++標準函式庫、其它函式庫的頭檔、你自己工程的頭檔中漏了最前面的一項：作業系統層級的頭文件，例如上面的範例sys/types.h估計不能歸入C標準函式庫，而是Linux作業系統提供的SDK吧。因此我覺得更準確的說法應該是：OS SDK .h , C標準函式庫、C++標準函式庫、其它函式庫的頭檔、你自己工程的頭檔。

3.之所以要將頭檔所在的工程目錄列出，作用應該是命名空間是一樣的，就是為了區分不小心造成的檔案重名。

二． 《C++程式設計思想》中的不同觀點

與《Google C++ 程式設計風格指南》不同的是，《C++程式設計思想》倡導一種不同的規則。 《C++程式設計思想》P432提到：

頭檔被包含的順序是從「最特殊到最一般」。這就是，在本地目錄的任何頭文件首先被包含。然後是我們自己的所有「工具」頭文件，接著是第三方函式庫頭文件，接著是標準C++庫頭檔和C庫頭檔。

要了解原因：可以看JohnLakos在《Large ScaleC++ Softwre Design》(註：其中文譯名為《大規模C++程式設計》)中的一段話：

保證.h檔案的組成部分不被它自身解析（parse）,這可以避免潛在的使用錯誤。因為被自身解析缺乏明確提供的聲明或定義。在.c檔的第一行包含.h 檔案能確保所有對於構件的物理介面重要的內部資訊區塊都在.h中（如果的確是缺少了某些資訊區塊，一旦編譯這個.c檔時就可以發現這個問題）。

如果包含頭文件的順序是“從最特殊到最一般”，如果我們的頭文件不被它自己解析。我們將馬上找到它，防止麻煩事情發生。

三．我的試驗

到底哪一種包含順序好呢？我使用VS 2005編一個控制台測試工程TestInc，裡面有幾個檔案。

MyMath.h的程式碼如下：

#pragma once  
double acos(double Num);
MyMath.cpp的代码如下：
double acos(double Num)  
{  
    return 1.0;  
}

TestInc.cpp的程式碼如下：

#include "TestInc.h"  
#include <stdio.h>  
#include <math.h>  
  
int _tmain(int argc, _TCHAR* argv[])  
{  
    double a = acos(0.5);  
    return 0;  
}

為：

1>c:program filesmicrosoft visualstudio 8vcincludemath.h(107) : error C2732: 链接规范与“acos”的早期规范冲突
1>       c:program filesmicrosoft visual studio 8vcincludemath.h(107) : 参见“acos”的声明

則編譯通過了。在調試運行時main函數調用還是C標準庫的函數acos，看來函數調用的順序是按頭文件的包含順序來的，即我自定義的acos函數被覆蓋了(如果TestInc.h裡包含了內聯函數，則優先調用的是內聯函數)。

從這個小實驗中我得出以下結論：《Google C++ 程式設計風格指南》和《C++程式設計思想》所倡導的包含頭檔的順序各有優點，《Google C++ 程式設計風格指南》應該能大量程式設計風格指南》所倡導的包含頭檔的順序各有優點，《Google C++ 程式設計風格指南》應該能大量程式設計風格指南減少隱藏的頭檔依賴，而《C++程式設計思想》很容易讓你清楚知道你所定義的介面是否和系統函式庫及第三方函式庫發生衝突。

四．頭檔包含中的預編譯功能

在Visual Studio環境下開發我們發現幾乎每個cpp文件都要包含stdafx.h這個文件，而且要把它放在最前面的位置，否則就會出錯。這是為什麼呢？

原来Visual Studio采用一种预编译的机制。要了解预编译机制，先介绍一下预编译头。所谓的预编译头就是把一个工程中的那一部分代码，预先编译好放在一个文件里（通常是以.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 <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。然后，在左边的树形视图里选择 StdAfx.cpp，这时原来的Project Option变成了 Source File Option（原来是工程，现在是一个文件，当然变了）。在这里我们可以看到 /Yc开关，/Yc的作用就是指定这个文件来创建一个Pch文件。/Yc后面的文件名是那个包含了稳定代码的头文件，一个工程里只能有一个文件的可以有 YC开关。VC就根据这个选项把 StdAfx.cpp编译成一个Obj文件和一个PCH文件。

这样，我们就设置好了预编译头文件。也就是说，我们可以使用预编译头功能了。以下是注意事项：

1）如果使用了/Yu，就是说使用了预编译，我们在每个.cpp文件的最开头，包含你指定产生pch文件的.h文件（默认是stdafx.h）不然就会有问题。如果你没有包含这个文件，就告诉你Unexpected file end.

2）如果你把pch文件不小心丢了，根据以上的分析，你只要让编译器生成一个pch文件就可以了。也就是说把stdafx.cpp（即指定/Yc的那个cpp文件）重新编译一遍就可以了。

那么在Linux平台下有没有这种预编译机制呢？如果有，它是怎么实现的呢？Linux平台下GCC编译器也实现了预编译机制的。这里以开源IDE CodeBlocks（CodeBlocks内置了GCC编译器）的工程为例来说明Linux平台的实现：

使用CodeBlocks建一个C++工程，然后新建一个my_pch.h，输入如下代码：

/*************************************************************** 
 * Name:      my_pch.h 
 * Purpose:   Header to create Pre-Compiled Header (PCH) 
 * Author:     () 
 * Created:   2010-10-26 
 * Copyright:  () 
 * License: 
 * 使用方法: 项目构建选项-->其他选项-->填入下面两行 
 -Winvalid-pch 
 -include my_pch.h 
 **************************************************************/  
  
#ifndef MY_PCH_H_INCLUDED  
#define MY_PCH_H_INCLUDED  
  
// put here all your rarely-changing header files  
  
#include <iostream>  
#include <string>  
  
#endif

然后在项目构建选项–>其他选项–>填入下面两行

-Winvalid-pch
-include my_pch.h

就可以启用预编译文件头。

然后 main.cpp 就可以不用 include 头文件了，直接这样就可以编译了

int main()  
{   
using namespace std;  
    cout << "Hello world!" << endl;  
    return 0;  
}

即使在上面的代码写上下面一行，其实是不起作用的：

#include <iostream>

以上就是C++ 头文件的包含顺序研究的内容，更多相关内容请关注PHP中文网（www.php.cn）！