文章目录

  • 1.头文件的作用
  • 2.头文件的用法
  • 2.1 头文件的内容
  • 2.2 使用系统提供的头文件
  • 2.3 避免头文件被重复包含
  • 参考文献



示例代码编译运行环境:Windows 64bits+VS2017+Debug+Win32。


头文件是 C/C++ 程序不可或缺的组成部分,我们需要了解头文件的作用和相关规范。

1.头文件的作用

C/C++ 编译采用分离编译模式。在一个项目中,有多个源文件存在,但是它们总会有一些相同的内容,比如用户自定义类型、全局变量、全局函数的声明等。将这些内容抽取出来放到头文件中,提供给各个源文件包含,就可以避免相同内容的重复书写,提高编程效率和代码安全性。所以,设立头文件的主要目的是:提供全局变量、全局函数的声明或公用数据类型的定义,从而实现分离编译和代码复用。

概括地说,头文件有如下三个作用:

(1)加强类型检查,提高类型安全性。
使用头文件,可有效地保证自定义类型的一致性。虽然,在语法上,同一个数据类型(如一个 class)在不同的源文件中书写多次是允许的,程序员认为他们是同一个自定义类型,但是,由于数据类型不具有外部连接特性,编译器并不关心该类型的多个版本之间是否一致,这样有可能会导致逻辑错误的发生。考察如下程序。

//source1.cpp
#include <iostream>

class A {
private:
	char num;
public:
	A();
	void show();
};

void A::show(){ std::cout<<num<<std::endl;}

void see(A& a){a.show();}
//end source1.cpp

//source2.cpp
#include <iostream>

class A {
private:
	int num;
public:
	A(){num=5;};
	void show();
};

void see(A& a);

int main() {
	A a;
	see(a);
}
//end source2.cpp

这个程序能够顺利通过编译并正确的运行,在构成项目的两个源文件中,对class A的定义出现了一点小小的不一致。两个源文件中,成员变量num一个是char类型,一个是int类型,这就导致输出了一个特殊的字符。

如果将 class A 的定义放到一个头文件中,用到class A的源文件都包含这个头文件,可以绝对保证数据类型的一致性和安全性。

(2)减少公用代码的重复书写,提高编程效率。
程序开发过程中,对某些数据类型或者接口进行修改是在所难免的,使用头文件,只需要修改头文件中的内容,就可以保证修改在所有源文件中生效,从而避免了繁琐易错的重复修改。

(3)提供保密和代码重用的手段。
头文件也是 C++ 代码重用机制中不可缺少的一种手段,在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制库即可。用户只需要按照头文件的接口声明来调用库函数,而不必关心接口的具体实现,编译器会从库中连接相应的实现代码。

2.头文件的用法

2.1 头文件的内容

头文件包含的是多个源文件的公用内容,因此,全局函数原型声明、全局变量声明、自定义宏和类型等应该放在头文件中。规范的头文件允许被多个源文件包含而不会引发编译错误,所以全局变量的定义、外部变量的定义、全局函数的定义、在类体之外的类成员函数的定义等只能出现一次的内容不应该放在头文件中。

2.2 使用系统提供的头文件

C 语言提供的头文件都是以 .h 结尾的,如标准库头文件 stdio.h 等。C++ 语言最初的目的是成为一个“更好的 C”,所以 C++ 沿用了 C 头文件的命名习惯,将头文件后面加上 .h 标志。随着 C++ 语言的发展,C++ 加入了全新的标准库,为了避免与 C 发生冲突,C++ 引入了名字空间来避免名称冲突,也去掉了头文件的 .h 后缀。于是,在一段时间里,很多头文件有两个版本,一个以 .h 结尾,而另一则不是,如iostream.h(位于全局名字空间)和 iostream(位于名字空间 std)。程序员编写程序也有不同的选择,很多 C++ 源程序以这样的语句开始:

#include <iostream.h>

而另一些,则以这样的两条语句开始:

#include <iostream>
using namespace std;

这种现象有些混乱,于是 C++ 标准委员会规定,旧 C 头文件(如 stdio.h)和 C++ 中新的 C 头文件(如 cstdio)继续使用,但是旧的 C++ 头文件(如 iostream.h)已被废弃,一律采用 C++ 新标准规定的头文件(如 iostream)。另外,在包含系统头文件的时候,应该使用尖括号(<>)而不是双引号(“”)。

例如应该这样包含头文件 iostream:

#include <iostream>

而不是这样:

#include “iostream”

双引号””用来包含自定义的头文件,用它来包含系统头文件是一种不良的编程习惯。原因是编译器遇到双引号包裹的头文件默认为用户自定义头文件,从项目目录下查找,查找不到才会到系统目录中查找,如果存在与系统头文件同名的用户自定义头文件,则会出现不符合预期的错误。

2.3 避免头文件被重复包含

C++ 中,如全局变量的定义、全局函数的定义等在项目中只能出现一次。有的可以出现多次,但在一个源文件中只能出现一次,如class的定义等,还有的在一个源文件中可以出现多次,如函数声明等。由于事先无法无法确定头文件的内容,应该避免在一个源文件中对同一头文件包含多次,以免引起重定义错误。考察如下程序。

// header1.h
class A {
	int num;
public:
	A();
	void show();
};
// end header1.h

// header2.h
#include “header1.h”
class B {
	A a;
public:
    void disp();
};
// end header2.h

// main.cpp
#include <iostream>
#include “header1.h”
#include “header2.h”
A::A() {
    num=5;
}
void A::show(){std::cout<<num<<std::endl;}
int main() {
	A a;
	a.show();
}
// end main.cpp

这个程序无法通过编译,原因是 class A 在源文件 main.cpp 中被定义了两次,这是由于头文件 header2.h 包含了 header.1,在源文件 main.cpp 包含了 header2.h,也包含了 header1.h,这就导致 header1.h 在main.cpp 中被包含了两次,也就造成了 class A 重复定义。

一个头文件被别的源文件重复包含是经常发生的,如何避免某个头文件被重复包含呢?利用条件编译轻松解决。在头文件的开始加入:

#ifndef HEADER_NAME
#define HEADER_NAME

在头文件的结尾加上:

#endif

HEADER_NAME 可以为任意内容,只要能够唯一标识当前头文件即可,建议使用头文件的名称。将这些条件编译预处理指令加入上面的示例程序中的两个头文件,问题即可解决。此外,也可以使用#paragma once预处理指令来实现,但这种方法并非所有编译器都支持,考虑到代码的可移植性,建议使用条件编译预处理指令。

阅读以上示例代码,需要注意以下几点:

(1)条件编译指令#ifndef HEADER_NAME#endif的意思是:如果条件编译标志 HEADER_NAME 没有定义的话,则编译#ifndef#endif之间的程序段,否则就忽略它。头文件 header1.h 只要被包含一次,条件编译标志宏 HEADER_NAME 就会被定义,这样就不会被再次包含。

(2)iostream 是标准库中的头文件,所以被包含时使用尖括号 <>,而 header1.h 和 header2.h 是用户自定义的头文件,被包含时使用双引号。