背景

对于C语言来说，头文件的设计体现了大部分的系统设计。 不合理的头文件布局是编译时间过长的根因，不合理的头文件实际上不合理的设计。

术语定义：

依赖：本文档特指编译依赖。

若aa.h包含了bb.h，则称作aa依赖bb。依赖关系会进行传导，如aa.h包含bb.h，而bb.h又包含了cc.h，则aa通过bb依赖了cc。依赖将导致编译时间的上升。虽然依赖是不可避免的，也是必须的，但是不良的设计会导致整个系统的依赖关系无比复杂，使得任意一个文件的修改都要重新编译整个系统，导致编译时间巨幅上升。

在一个设计良好的系统中， 修改一个文件，只需要重新编译数个，甚至是一个文件。某产品曾经做过一个实验，把所有函数的实现通过工具注释掉，其编译时间只减少了不到10%，究其原因，在于AA包含BB， BB包含CC， CC包含DD，最终几乎每一个源文件都包含了项目组所有的头文件，从而导致绝大部分编译时间都花在解析头文件上。

某产品更有一个“优秀实践”，用于将.c文件通过工具合并成一个比较大的.c文件，从而大幅度提高编译效率。其根本原因还是在于通过合并.c文件减少了头文件解析次数。但是，这样的“优秀实践”是对合理划分.c文件的一种破坏。

大部分产品修改一处代码，都得需要编译整个工程，对于TDD之类的实践，要求对于模块级别的编译时间控制在秒级，即使使用分布式编译也难以实现，最终仍然需要合理的划分头文件、以及头文件之间的包含关系， 从根本上降低编译时间。

《google C++ Style Guide》 1.2 头文件依赖 章节也给出了类似的阐述：
若包含了头文件aa.h，则就引入了新的依赖： 一旦aa.h被修改，任何直接和间接包含aa.h代码都会被重新编译。如果aa.h又包含了其他头文件如bb.h，那么bb.h的任何改变都将导致所有包含了aa.h的代码被重新编译，在敏捷开发方式下，代码会被频繁构建，漫长的编译时间将极大的阻碍频繁构建。因此，我们倾向于减少包含头文件，尤其是在头文件中包含头文件，以控制改动代码后的编译时间。

合理的头文件划分体现了系统设计的思想，但是从编程规范的角度看，仍然有一些通用的方法，用来合理规划头文件。本节介绍的一些方法，对于合理规划头文件会有一定的帮助。

[原则]

1、头文件中适合放置接口的声明，不适合放置实现。

说明： 头文件是模块（Module）或单元（Unit）的对外接口。

• 头文件中应放置对外部的声明，如对外提供的函数声明、宏定义、类型定义等。
• 内部使用的函数（相当于类的私有方法）声明不应放在头文件中。
• 内部使用的宏、枚举、结构定义不应放入头文件中。
• 变量定义不应放在头文件中，应放在.c文件中。
• 变量的声明尽量不要放在头文件中，亦即尽量不要使用全局变量作为接口。
  变量是模块或单元的内部实现细节，不应通过在头文件中声明的方式直接暴露给外部，应通过函数接口的方式进行对外暴露。 即使必须使用全局变量，也只应当在.c中定义全局变量，在.h中仅声明变量为全局的。

延伸阅读材料： 《C语言接口与实现》 （David R. Hanson 著 傅蓉 周鹏 张昆琪 权威 译 机械工业出版社 2004年1月） （英文版： “C Interfaces and Implementations”）

2、头文件应当职责单一。

说明：头文件过于复杂，依赖过于复杂是导致编译时间过长的主要原因。 很多现有代码中头文件过大，职责过多， 再加上循环依赖的问题，可能导致为了在.c中使用一个宏，而包含十几个头文件。

示例： 如下是某平台定义WORD类型的头文件：

#include <VXWORKS.H>
#include <KERNELLIB.H>
#include <SEMLIB.H>
#include <INTLIB.H>
#include <TASKLIB.H>
#include <MSGQLIB.H>
#include <STDARG.H>
#include <FIOLIB.H>
#include <STDIO.H>
#include <STDLIB.H>
#include <CTYPE.H>
#include <STRING.H>
#include <ERRNOLIB.H>
#include <TIMERS.H>
#include <MEMLIB.H>
#include <TIME.H>
#include <WDLIB.H>
#include <SYSLIB.H>
#include <TASKHOOKLIB.H>
#include <REBOOTLIB.H>

…
typedef unsigned short WORD;
…

这个头文件不但定义了基本数据类型WORD，还包含了stdio.h syslib.h等等不常用的头文件。如果工程中有10000个源文件，而其中100个源文件使用了stdio.h的printf，由于上述头文件的职责过于庞大，而WORD又是每一个文件必须包含的，从而导致stdio.h/syslib.h等可能被不必要的展开了9900次，大大增加了工程的编译时间。

3、头文件应向稳定的方向包含。

说明： 头文件的包含关系是一种依赖，一般来说，应当让不稳定的模块依赖稳定的模块，从而当不稳定的模块发生变化时，不会影响（编译）稳定的模块。

就产品来说，建议依赖的方向： 产品依赖于平台，平台依赖于标准库。 某产品线平台的代码中已经包含了产品的头文件，导致平台无法单独编译、发布和测试， 是一个非常糟糕的反例。

除了不稳定的模块依赖于稳定的模块外，更好的方式是两个模块共同依赖于接口，这样任何一个模块的内部实现更改都不需要重新编译另外一个模块。在这里，我们假设接口本身是最稳定的。

延伸阅读材料： 编者推荐开发人员使用“依赖倒置”原则，即由使用者制定接口，服务提供者实现接口，更具体的描述可以参见《敏捷软件开发：原则、模式与实践》 （Robert C.Martin 著 邓辉 译 清华大学出版社2003年9月） 的第二部分“敏捷设计”章节。

[8个规则]

1、每一个.c文件应有一个同名.h文件，用于声明需要对外公开的接口。

说明： 如果一个.c文件不需要对外公布任何接口，则其就不应当存在，除非它是程序的入口，如main函数所在的文件。

现有某些产品中，习惯一个.c文件对应两个头文件，一个用于存放对外公开的接口，一个用于存放内部需要用到的定义、声明等，以控制.c文件的代码行数。编者不提倡这种风格。这种风格的根源在于源文件过大，应首先考虑拆分.c文件，使之不至于太大。另外，一旦把私有定义、声明放到独立的头文件中，就无法从技术上避免别人include它，难以保证这些定义最后真的只是私有的。

本规则反过来并不一定成立。有些特别简单的头文件，如命令ID定义头文件，不需要有对应的.c存在。
示例：对于如下场景，如在一个.c中存在函数调用关系：

void foo()
{
    bar();
}
void bar()
{
    Do something;
}

必须在foo之前声明bar，否则会导致编译错误。
这一类的函数声明，应当在.c的头部声明，并声明为static的，如下：

static void bar();
void foo()
{
    bar();
}
void bar()
{
    Do something;
}

2、禁止头文件循环依赖

说明： 头文件循环依赖，指aa.h包含bb.h， bb.h包含cc.h， cc.h包含aa.h之类导致任何一个头文件修改，都导致所有包含了aa.h/bb.h/cc.h的代码全部重新编译一遍。而如果是单向依赖，如aa.h包含bb.h， bb.h包含cc.h，而cc.h不包含任何头文件，则修改aa.h不会导致包含了bb.h/cc.h的源代码重新编译。

3、.c/.h文件禁止包含用不到的头文件

说明： 很多系统中头文件包含关系复杂，开发人员为了省事起见，可能不会去一一钻研，直接包含一切想到的头文件，甚至有些产品干脆发布了一个god.h，其中包含了所有头文件，然后发布给各个项目组使用，这种只图一时省事的做法，导致整个系统的编译时间进一步恶化，并对后来人的维护造成了巨大的麻烦。

4、头文件应当自包含

说明： 简单的说，自包含就是任意一个头文件均可独立编译。 如果一个文件包含某个头文件，还要包含另外一个头文件才能工作的话，就会增加交流障碍，给这个头文件的用户增添不必要的负担。

示例：
如果a.h不是自包含的，需要包含b.h才能编译，会带来的危害：每个使用a.h头文件的.c文件，为了让引入的a.h的内容编译通过，都要包含额外的头文件b.h。额外的头文件b.h必须在a.h之前进行包含，这在包含顺序上产生了依赖。

注意：该规则需要与“.c/.h文件禁止包含用不到的头文件”规则一起使用，不能为了让a.h自包含，而在a.h中包含不必要的头文件。 a.h要刚刚可以自包含，不能在a.h中多包含任何满足自包含之外的其他头文件。

5、总是编写内部 #include 保护符（ #define 保护 ）

说明：多次包含一个头文件可以通过认真的设计来避免。如果不能做到这一点，就需要采取阻止头文件内容被包含多于一次的机制。

通常的手段是为每个文件配置一个宏，当头文件第一次被包含时就定义这个宏，并在头文件被再次包含时使用它以排除文件内容。

所有头文件都应当使用#define 防止头文件被多重包含，命名格式为FILENAME_H，为了保证唯一性，更好的命名是PROJECTNAME_PATH_FILENAME_H。

注：没有在宏最前面加上“_“，即使用 FILENAME_H 代替 _FILENAME_H_ ，是因为一般以”_“和”__“开头的标识符为系统保留或者标准库使用，在有些静态检查工具中，若全局可见的标识符以”_“开头会给出告警。

定义包含保护符时，应该遵守如下规则：
1）保护符使用唯一名称；
2）不要在受保护部分的前后放置代码或者注释。

示例：假定VOS工程的 timer 模块的 timer.h ，其目录为 VOS/include/timer/timer.h ,应按如下方式保护：

#ifndef VOS_INCLUDE_TIMER_TIMER_H
#define VOS_INCLUDE_TIMER_TIMER_H
...
#endif

也可以使用如下简单方式保护:

#ifndef TIMER_H
#define TIMER_H
...
#endif

例外情况：头文件的版权声明部分以及头文件的整体注释部分（如阐述此头文件的开发背景、使用注意事项等）可以放在保护符(#ifndef XX_H)前面。

6、禁止在头文件中定义变量

说明： 在头文件中定义变量，将会由于头文件被其他.c文件包含而导致变量重复定义。

7、只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量

说明：若a.c使用了b.c定义的foo()函数，则应当在b.h中声明extern int foo(int input)；并在a.c中通过#include <b.h>来使用foo。禁止通过在a.c中直接写extern int foo(int input);来使用foo，后面这种写法容易在foo改变时可能导致声明和定义不一致。

8、禁止在extern “C”中包含头文件。

说明：在extern “C”中包含头文件， 会导致extern “C”嵌套， Visual Studio对extern “C”嵌套层次有限制，嵌套层次太多会编译错误。

在extern “C”中包含头文件，可能会导致被包含头文件的原有意图遭到破坏。例如，存在a.h和b.h两个头文件：

使用C++预处理器展开b.h，将会得到

extern "C" {
    void foo(int);
    void b();
}

按照a.h作者的本意，函数foo是一个C++自由函数，其链接规范为”C++”。但在b.h中，由于#include “a.h”被放到了extern “C” { }的内部，函数foo的链接规范被不正确地更改了。

示例： 错误的使用方式：

extern “C”
{
    #include “xxx.h”
    ...
}

正确的使用方式：

#include “xxx.h”
extern “C”
{
    ...
}

[4条建议]

1、一个模块通常包含多个.c文件，建议放在同一个目录下，目录名即为模块名。

为方便外部使用者，建议每一个模块提供一个.h，文件名为目录名。

说明：需要注意的是，这个.h并不是简单的包含所有内部的.h，它是为了模块使用者的方便，对外整体提供的模块接口。

以Google test（简称GTest）为例， GTest作为一个整体对外提供C++单元测试框架，其1.5版本的gtest工程下有6个源文件和12个头文件。但是它对外只提供一个gtest.h，只要包含gtest.h即可使用GTest提供的所有对外提供的功能，使用者不必关系GTest内部各个文件的关系，即使以后GTest的内部实现改变了，比如把一个源文件c拆成两个源文件，使用者也不必关心，甚至如果对外功能不变，连重新编译都不需要。

对于有些模块，其内部功能相对松散，可能并不一定需要提供这个.h，而是直接提供各个子模块或者.c的头文件。

比如产品普遍使用的VOS，作为一个大模块，其内部有很多子模块，他们之间的关系相对比较松散，就不适合提供一个vos.h。而VOS的子模块，如Memory（仅作举例说明，与实际情况可能有所出入），其内部实现高度内聚，虽然其内部实现可能有多个.c和.h，但是对外只需要提供一个Memory.h声明接口。

2、如果一个模块包含多个子模块，则建议每一个子模块提供一个对外的.h，文件名为子模块名

说明：降低接口使用者的编写难度。

3、头文件不要使用非习惯用法的扩展名，如.inc

说明：目前很多产品中使用了.inc作为头文件扩展名，这不符合c语言的习惯用法。在使用.inc作为头文件扩展名的产品，习惯上用于标识此头文件为私有头文件。但是从产品的实际代码来看，这一条并没有被遵守，一个.inc文件被多个.c包含比比皆是。本规范不提倡将私有定义单独放在头文件中，具体见 规则1.1。

除此之外，使用.inc还导致source insight、 Visual stduio等IDE工具无法识别其为头文件，导致很多功能不可用，如“跳转到变量定义处”。虽然可以通过配置，强迫IDE识别.inc为头文件，但是有些软件无法配置，如Visual Assist只能识别.h而无法通过配置识别.inc。

4、同一产品统一包含头文件排列方式

说明：常见的包含头文件排列方式： 功能块排序、文件名升序、稳定度排序。
示例1：
以升序方式排列头文件可以避免头文件被重复包含，如：

#include <a.h>
#include <b.h>
#include <c/d.h>
#include <c/e.h>
#include <f.h>

示例2：
以稳定度排序， 建议将不稳定的头文件放在前面，如把产品的头文件放在平台的头文件前面，如下：

#include <product.h>
#include <platform.h>

相对来说， product.h修改的较为频繁，如果有错误，不必编译platform.h就可以发现product.h的错
误，可以部分减少编译时间。