C++头文件

红太狼 2021-05-12 11:55 643阅读 0赞

通常，在一个C++程序中，只包含两类文件：.cpp文件和.h文件，前者称为源文后者称为头文件，里面放的都是C++代码。

**1、分别编译：**

C+ +语言支持“分别编译”（separate compilation）。也就是说一个程序，可以分成不同的功能分别放在不同的.cpp文件里。.cpp文件里的东西都是相对独立的，在编 译（compile）时不需要与其他文件互通，只需要在编译成目标文件后再与其他的目标文件做一次链接（link）就行了。比如：a.cpp中定义了一个全局函数“void a() \{\}”，在b.cpp中需要调用这个函数。即使这样，a.cpp和b.cpp并不需要相互知道对方的存在，而是可以分别地对它们进行编译， 编译成目标文件之后再链接，整个程序就可以运行了。

1）怎么实现的呢？

b.cpp中，在调用 “void a()”函数之前，先声明一下这个函数“void a();”，就可以了。这是因为编译器在编译b.cpp的时候会生成一个符号表（symbol table），像“void a()”这样的看不到定义的符号，就会被存放在这个表中。再进行链接的时候，编译器就会在别的目标文件中去寻找这个符号的定义。一旦找到了，程序也就可以 顺利地生成了。

注： 一个符号，在整个程序中可以被声明多次，但却要且仅要被定义一次。试想，如果一个符号出现了两种不同的定义，编译器该听谁的？

2）什么是头文件：

所谓的头文件，其实它的内容跟.cpp文件是一样的，都是 C++的源代码。头文件本身不用被编译。通常我们把公用的变量、函数的声明全放进一个头文件中，当某一个.cpp源文件需要它们时，它们就可以通过一个宏命令 “\#include”包含进这个.cpp文件中，该命令是一字不落的替换和照抄。当.cpp文件被编译时，顺带将头文件一起编译了。举一个例子：

![20190817201541284.png][]

math.h中声明了一个方法double f1(double,double)；math.cpp中定义了f1方法，也就是实现了该方法；mathMain.cpp中要调用这个方法，只需要include头文件，声明一下即可，这样整个程序就完成了。从上例可以看出，头文件的作用就是要给外部提供接口使用的。

**注意**：.h文件不用写在编译器的命令之后，但它必须要在编译器找得到的地方。 main.cpp和math.cpp都可以分别通过编译，生成main.o和math.o，然后再把这两个目标文件进行链接，程序就可以运行了。

**2、头文件中写什么：**

**2.1）变量、函数的声明：**

头文件的作用就是被其他的.cpp包含进去的，它们本身并不参与编译，但实际上它们的内容却在多个.cpp文件中得到了编译。通过“定义只能有一次”的规则（否则不知道该用哪个了），我们可以得出，头文件中应该只放变量和函数的声明，而不能放它们的定义。

因为一个头文件的实际上会被引入到多个不同的.cpp中，并且它们都会被编译。放声明当然没事，如果放了定义（即使是相同的），但对于编译器来说也是不合法。所以，只能在头文件中写类似：extern int a;和void f();这些才是声明。如果写int a;或者void f() \{\}这样的句子，那么一旦这个头文件被两个或两个以上的.cpp文件包含的话，编译器会立马报错。

**2.2）const对象的定义：**

可以将const定义的变量写进头文件中，即使它被包含到其他多个.cpp文件中，这个对象也都只在包含它的那个文件中有效，对其他文件来说是不可见的，所以便不会导致多重定义。同时，因为这些.cpp文件中的该对象都是从一个头文件中包含进去的，这样也就保证 了这些.cpp文件中的这个const对象的值是相同的，可谓一举两得。

同理，static对象的定义也可以放进头文件，但是不建议。因为const是不会被修改的，再加上编译期会优化保证内存只有一份。但是static会被修改，就导致编译期无法优化，在内存中保存了多份。所以建议static的定义写在cpp中。

注：static的变量声明就必须定义。

**2.3）头文件中可以写内联函数（inline）的定义：**

因为inline函数是需要编译器在遇到它的地方根据它的定义把它内联展开的，而并非是普通函数那样可以先声明再链接的（内联函数不会链接），所以编译器就需要在编译时看到内联函数的完整定义才行。如果内联函数像普通函数一样只能定义一次的话，这事儿就难办了。因为在一个文件中还好，我可以把内联函数的定义写在最开始，这样可以保证后面使用的时候都可以见到定义；但是，如果我在其他的文件中还使用到了这个函数那怎么办 呢？这几乎没什么太好的解决办法，因此C++规定，内联函数可以在程序中定义多次，只要内联函数在一个.cpp文件中只出现一次，并且在所有的.cpp文件中，这个内联函数的定义是一样的，就能通过编译。那么显然，把内联函数的定义放进一个头文件中是非常明智的做法。

**2.4）头文件中可以写类 （class）的定义：**

因为在程序中创建一个类的对象时，编译器只有在这个类的定义完全可见的情况下，才能知道这个类的对象应该如何布局，所以，关于类的定义的要求，跟内联函数是基本一样的。所以把类的定义放进头文件，在使用到这个类的.cpp文件中去包含这个头文件，是一个很好的做法。在这里，值得一提 的是，类的定义中包含着数据成员和函数成员。数据成员是要等到具体的对象被创建时才会被定义（分配空间），但函数成员却是需要在一开始就被定义的，这也就是我们通常所说的类的实现。

一般，我们的做法是把类的定义放在头文件中，而把函数成员的实现代码放在一个.cpp文件中。这是可以的，也是很好的办法。 （外联）

不过，还有另一种办法，直接把函数成员的实现代码也写进类定义里面。在C++的类中，如果函数成员在类的定义体中被定义，那么编译器会视这个函数为内联的。因此，把函数成员的定义写进类定义体，一起放进头文件中，是合法的。

注意：如果把函数成员的定义写在类定义的头文件中，而没有写进类体定义中， 这是不合法的，因为这个函数成员此时就不是内联的了。一旦头文件被两个或两个以上的.cpp文件包含，这个函数成员就被重定义了。

**3、头文件保护：**

所有头文件都应该使用 \#define 来防止头文件被多重包含，命名格式当是：<PROJECT>\_<PATH>\_<FILE>\_H\_

为保证唯一性，头文件的命名应该基于所在项目源代码树的全路径。例：项目foo中的头文件 foo/src/bar/baz.h 可按如下方式保护：

#ifndef FOO_BAR_BAZ_H_
    
    #define FOO_BAR_BAZ_H_
    
    ...
    
    #endif // FOO_BAR_BAZ_H_

3.1）由于在一个系统中会有很多头文件，这些头文件可能会都包含一个公有的头文件，如果没有头文件保护，就会出现错误。举一个例子：

// file1.h
    class file1
    {
    };
    // file2.h
    #include "file1.h"
    class file2
    {
    };
    // file3.h
    #include "file1.h"
    #include "file2.h"
    
    file3.h展开来是这样的：
    // file1.h展开的内容
    class file1
    {
    };
    // file2.h展开的内容
    class file1
    {
    };
    class file2
    {
    };

这时候就会出现重定义了，如果在每个文件加上\#ifndef头文件保护符：

// file1.h
    #ifndef _FILE1_H_
    #define _FILE1_H_
    class file1
    {
    };
    #endif // !_FILE1_H_
    
    // file2.h
    #ifndef _FILE2_H_
    #define _FILE2_H_
    #include "file1.h"
    class file2
    {
    };
    #endif // !_FILE2_H_
    
    // file3.h
    #ifndef _FILE3_H_
    #define _FILE3_H_
    #include "file1.h"
    #include "file2.h"
    #endif // !_FILE3_H_

这时候展开file3.h时，因为\_FILE1\_H\_只会被定义一次，所以就不会出现重定义错误。

**3.2）头文件保护只是防止在同一个.cpp文件中被多次引用：**

头文件中一般是不允许定义变量、函数的（只允许声明）。如果一个头文件中定义了变量、函数，但只被一个带有main得cpp引入、执行是没有问题的。例如：

![20190817202459180.png][]

g++ test.cpp 是可以便宜、连接、执行的。但是如果头文件被两个或以上cpp包含，那么就会报重复定义的错误：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpdXhpYW83MjM4NDY_size_16_color_FFFFFF_t_70][]

g++ test1.cpp test\_main.cpp 编译、连接的时候报如下错误：

![2019081720255463.png][]

这是因为\#ifndef只能在同一个文件中起到保护作用，在连接的时候，出现了test1和test\_main中都出现了test()函数的定义。上述代码，可以编译成功：g++ -S test1.cpp test\_main.cpp

解决方法，可以将common.h中的test()变成内联函数，即：inline void test()

**3.3）\#ifndef 也可以用在cpp文件中：**

这种用法很少，不建议使用。\#ifndef只是放在头文件中，作为头文件的保护。如下面例子，是可以编译、连接成功的：g++ test1.cpp test\_main.cpp

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpdXhpYW83MjM4NDY_size_16_color_FFFFFF_t_70 1][]

定义了宏TEST\_COMMON\_H\_，并且在头文件、test1.cpp中都是用了\#ifndef保护，所以在g++编译、链接的时候不会报重复定会议的错误。

[20190817201541284.png]: /images/20210511/9296874a78e641a1b4c02e5562c4f034.png
[20190817202459180.png]: /images/20210511/0a7af3f6fb15482b8bd31a4a59ecd71c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpdXhpYW83MjM4NDY_size_16_color_FFFFFF_t_70]: /images/20210511/fe99d200bb1847aeaf007b999c1a9e76.png
[2019081720255463.png]: /images/20210511/e1193e4925554285bdcff88dacaeb576.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpdXhpYW83MjM4NDY_size_16_color_FFFFFF_t_70 1]: /images/20210511/88153ea5fd404d0a9d303f0ae0b4f496.png