【编程好习惯】精确包含头文件

原文地址:http://yunli.blog.51cto.com/831344/275313/

请注意这里用的是“精确”而不是“正确”，之所以不说正确，那是因为如果头文件没有被正确地包含的话，编译器是不会生成最终的目标代码的。那用精确一词想表达除正确之外的什么意思呢？包含两层意思。

第一层意思是，只包含必需的头文件。图1是一个简单的示例程序，先让我们假设这个文件只有foo()一个函数的实现，在foo()函数中也只有简单的一行打印语句。我们知道printf()函数的原型声明来源于标准库的stdio.h头文件，foo.c文件中除了包含stdio.h外还包含了另外一个多余的头文件 —— time.h，从实现的角度来看没有问题。但是当一个项目很大的时候，这种类似的行为会突显出编译效率低下这一问题。当foo.c文件在被编译时，第一步要做的是预处理，预处理的最终结果可以看作是将stdio.h和time.h中的内容全部放到foo.c文件中，当然，如果stdio.h和time.h中又包含其它的头文件的话，它们也都全部会被放入到最终的foo.c文件中，图2示例了采用GCC的-E选项所获得的最终预处理完的文件final.c，从图中可以看出，本来是7行的文件变成了1419行，这意味着什么？意味着如果多包含头文件则编译所花费的时间将更长。因为，编译器在最终分析final.c文件中的词法和语法时，它必须从头到尾一行一行的处理。千万别小看对于每一个文件多出来的那么一点点时间，当一个项目有几十万行代码时，所多出来的时间就不可小视了。往往当这种现象成为了一个不可忽视的问题时，要消除它所需付出的努力已经很大了，甚至是项目组不可承受的。另外，这种纠正行为大多是“体力劳动”。

foo.c
#include <stdio.h>
#include <time.h>

void foo ()
{
   printf ("Just for an example!\n");
}

图1

yunli.blog.51cto.com~
$ gcc -E foo.c >final.c

yunli.blog.51cto.com~
$ vi final.c
1414 # 3 "foo.c" 2
1415
1416 void foo ()
1417 {
1418     printf ("Just for a test!\n");
1419 }
:set nu

图2

第二层意思就是，尽可能不要在头文件中包含其它的头文件，取而代之的是尽量在.c源文件中包含它们。对于图3和图4两种实现方式，光从foo()函数的角度来说是一模一样的，只是对于stdio.h头文件的包含一个是放在foo.h中的，而另一个则是放在foo.c中的。大部分情形下设计一个模块的目的是需要供其它的模块使用，而其它的模块在需要使用foo()函数时通常需要包含foo.h头文件。采用图3的实现方式将造成包含foo.h头文件则会导致间接地包含stdio.h，进而出现前面所讲的编译速度下降这一问题，而图4的实现就不存在这一问题。想想，printf()函数只是在foo()函数的实现中需要被使用，而完全可以不让foo.h头文件知道这一信息，所以跟本就没有必要在foo.h头文件中包含stdio.h。

foo.h
#include <stdio.h>

void foo ();
foo.c
#include “foo.h”

void foo ()
{
   printf ("Just for an example!\n");
}

图3

foo.h
void foo ();
foo.c
#include <stdio.h>
#include “foo.h”

void foo ()
{
   printf ("Just for an example!\n");
}

图3

   相信不少读者有这种类似的项目经验，即为了包含头文件省事，在项目进展的过程中定义一个包罗万象的公共头文件，然后让其它的源程序文件只需包含这一个头文件就行了，从而省去在创建一个新源程序时考虑哪些要包含、哪些不用包含这一过程。看完这则编程好习惯后，相信读者会明白那并不是一种好的实践。