重复定义问题
在2.7 节——前置声明与定义中,我们提到变量或函数标识符只能有一个定义(单一定义规则)。因此,程序中重复定义同一个变量标识符会导致编译错误:
int main()
{
int x; // 这是变量 x 的定义
int x; // 编译错误:重复定义
return 0;
}
同样,多次定义同一个函数的程序也会导致编译错误:
#include <iostream>
int foo() // 这是函数 foo 的定义
{
return 5;
}
int foo() // 编译错误:重复定义
{
return 5;
}
int main()
{
std::cout << foo();
return 0;
}
这些程序很容易修复(删除重复定义),但使用头文件时,很容易出现头文件中的定义被包含多次的情况。当一个头文件 #include 另一个头文件时(这很常见),就可能发生这种问题。
作者注
下面的示例会在头文件中定义一些函数。通常不应该这样做。
这里这样做,是因为利用已经学过的功能来演示这些概念最直观。
请看下面这个学术示例:
square.h:
int getSquareSides()
{
return 4;
}
wave.h:
#include "square.h"
main.cpp:
#include "square.h"
#include "wave.h"
int main()
{
return 0;
}
这个看似无害的程序无法编译!过程如下:首先,main.cpp #include square.h,把函数 getSquareSides 的定义复制到 main.cpp。然后,main.cpp #include wave.h,而 wave.h 又 #include 了 square.h。这样,square.h 的内容(包括函数 getSquareSides 的定义)会被复制到 wave.h,随后又被复制到 main.cpp。
因此,解析所有 #include 后,main.cpp 最终看起来如下:
int getSquareSides() // 来自 square.h
{
return 4;
}
int getSquareSides() // 来自 wave.h(通过 square.h)
{
return 4;
}
int main()
{
return 0;
}
重复定义会导致编译错误。每个文件单独看都没有问题,但 main.cpp 最终把 square.h 的内容包含了两次,于是出现了问题。如果 wave.h 需要 getSquareSides(),而 main.cpp 同时需要 wave.h 和 square.h,该如何解决?
头文件保护
好消息是,可以通过一种称为头文件保护(也称包含保护)的机制避免上述问题。头文件保护是条件编译指令,形式如下:
#ifndef SOME_UNIQUE_NAME_HERE
#define SOME_UNIQUE_NAME_HERE
// 在此处放置声明(以及某些类型的定义)
#endif
包含这个头文件时,预处理器会检查 SOME_UNIQUE_NAME_HERE 是否已经在当前翻译单元中定义过。如果这是第一次包含该头文件,SOME_UNIQUE_NAME_HERE 尚未定义,于是预处理器会 #define 它并包含文件内容。如果同一文件再次包含该头文件,SOME_UNIQUE_NAME_HERE 已在第一次包含时定义,头文件内容就会被忽略(这要归功于 #ifndef)。
所有头文件都应该使用头文件保护。SOME_UNIQUE_NAME_HERE 可以是任意名称,但按照惯例通常使用头文件的完整文件名,全部大写,并用下划线替代空格或标点。例如,square.h 的头文件保护可以写成:
square.h:
#ifndef SQUARE_H
#define SQUARE_H
int getSquareSides()
{
return 4;
}
#endif
就连标准库头文件也使用头文件保护。如果查看 Visual Studio 中的 iostream 头文件,会看到:
#ifndef _IOSTREAM_
#define _IOSTREAM_
// 此处的内容
#endif
进阶读者
大型程序中,可能存在两个来自不同目录、但文件名相同的头文件(例如 directoryA\config.h 和 directoryB\config.h)。如果头文件保护只使用文件名(例如 CONFIG_H),两个文件可能使用相同的保护名称。这样,直接或间接包含这两个 config.h 的文件,就无法获得第二个被包含文件的内容,很可能导致编译错误。
由于保护名称可能冲突,许多开发者建议为头文件保护使用更复杂、更独特的名称。例如可以采用 PROJECT_PATH_FILE_H、FILE_LARGE-RANDOM-NUMBER_H 或 FILE_CREATION-DATE_H 这样的命名约定。
为之前的示例添加头文件保护
回到 square.h 示例,这次使用带头文件保护的 square.h 。为了保持规范,我们也给 wave.h.
square.h
#ifndef SQUARE_H
#define SQUARE_H
int getSquareSides()
{
return 4;
}
#endif
wave.h:
#ifndef WAVE_H
#define WAVE_H
#include "square.h"
#endif
main.cpp:
#include "square.h"
#include "wave.h"
int main()
{
return 0;
}
预处理器解析完所有 #include 指令后,程序会变成这样:
main.cpp:
// 从 main.cpp 包含 Square.h
#ifndef SQUARE_H // 从 main.cpp 包含 square.h
#define SQUARE_H // 在此处定义 SQUARE_H
// 因此会包含这里的全部内容
int getSquareSides()
{
return 4;
}
#endif // SQUARE_H
#ifndef WAVE_H // 从 main.cpp 包含 wave.h
#define WAVE_H
#ifndef SQUARE_H // 从 wave.h 包含 square.h,此前已经定义了 SQUARE_H
#define SQUARE_H // 因此这里的内容都不会再次包含
int getSquareSides()
{
return 4;
}
#endif // SQUARE_H
#endif // WAVE_H
int main()
{
return 0;
}
下面看看它是如何处理的。
首先,预处理器处理 #ifndef SQUARE_H。 SQUARE_H 尚未定义,因此从 #ifndef 到后续 #endif 会被包含进编译过程。这段代码定义了 SQUARE_H,并定义了 getSquareSides 函数。
随后,预处理器再次处理下一个 #ifndef SQUARE_H。这次,SQUARE_H 已经定义(因为前面已经定义过),因此从 #ifndef 到后续 #endif 的内容会被排除,不参与编译。
头文件保护可以防止重复包含:第一次遇到保护宏时,它尚未定义,因此会包含受保护的内容。此后保护宏已经定义,后续再次出现的相同内容就会被排除。
头文件保护并不会阻止同一个头文件分别被包含到不同的源文件中
请注意, 头文件保护的目标是防止代码文件收到同一个受保护头文件的多个副本。按设计,头文件保护不会阻止同一个头文件分别(各一次)包含到不同代码文件中。这也可能引发意外问题。请看:
square.h:
#ifndef SQUARE_H
#define SQUARE_H
int getSquareSides()
{
return 4;
}
int getSquarePerimeter(int sideLength); // getSquarePerimeter 的前置声明
#endif
square.cpp:
#include "square.h" // square.h 在此处包含一次
int getSquarePerimeter(int sideLength)
{
return sideLength * getSquareSides();
}
main.cpp:
#include "square.h" // square.h 在此处也只包含一次
#include <iostream>
int main()
{
std::cout << "a square has " << getSquareSides() << " sides\n";
std::cout << "a square of length 5 has perimeter length " << getSquarePerimeter(5) << '\n';
return 0;
}
请注意, square.h 同时被 main.cpp 和 square.cpp 包含。这意味着 square.h 的内容会分别包含到 square.cpp 和 main.cpp 中一次。
下面详细看看原因。当 square.h 从 square.cpp 中包含时,SQUARE_H 会一直定义到 square.cpp 处理结束。这个宏定义会防止 square.h 第二次包含到 square.cpp(这正是头文件保护的目的)。但是,当 square.cpp 处理结束后,SQUARE_H 不再被视为已定义。因此,当预处理器处理 main.cpp 时,SQUARE_H 起初并未在 main.cpp 中定义。
最终, square.cpp 和 main.cpp 都会获得 getSquareSides 的定义副本。程序可以通过编译,但链接器会报告标识符 getSquareSides 被多次定义!
解决这个问题的最佳方式,是把函数定义放在某个 .cpp 文件中,让头文件只包含前向声明:
square.h:
#ifndef SQUARE_H
#define SQUARE_H
int getSquareSides(); // getSquareSides 的前置声明
int getSquarePerimeter(int sideLength); // getSquarePerimeter 的前置声明
#endif
square.cpp:
#include "square.h"
int getSquareSides() // getSquareSides 的实际定义
{
return 4;
}
int getSquarePerimeter(int sideLength)
{
return sideLength * getSquareSides();
}
main.cpp:
#include "square.h" // square.h 在此处也只包含一次
#include <iostream>
int main()
{
std::cout << "a square has " << getSquareSides() << " sides\n";
std::cout << "a square of length 5 has perimeter length " << getSquarePerimeter(5) << '\n';
return 0;
}
这样编译程序时,函数 getSquareSides 只有一个定义(位于 square.cpp),因此链接器可以正常工作。文件 main.cpp 可以调用这个函数(即使函数定义位于 square.cpp),因为它包含了 square.h,其中有该函数的前向声明(链接器会将 main.cpp 中对 getSquareSides 的调用连接到 square.cpp 中的定义)。
难道不能只避免在头文件中放定义吗?
我们通常建议不要在头文件中包含函数定义。因此你可能会疑惑:既然头文件保护防的是不该做的事,为什么还要使用它?
后面的课程会介绍许多必须把非函数定义放进头文件的情况。例如,C++ 允许你创建自定义类型。这些类型通常定义在头文件中,以便提供给需要使用它们的源文件。如果没有头文件保护,一个源文件可能得到同一个类型定义的多份(完全相同的)副本,编译器会将其标记为错误。
因此,虽然在教程的当前阶段使用头文件保护还不是绝对必要,但我们现在就养成好习惯,避免以后再改掉坏习惯。
#pragma once
现代编译器支持使用 #pragma 预处理器指令实现更简单的头文件保护:
#pragma once
// 在此处编写代码
#pragma once 与头文件保护的目的相同:避免头文件被多次包含。使用传统头文件保护时,需要开发者通过预处理器指令保护头文件; #ifndef、#define 和 #endif)。使用 #pragma once 则是请求编译器保护头文件。具体如何实现属于编译器实现细节。
进阶读者
有一种已知情况会使 #pragma once 通常失效:如果一个头文件被复制到文件系统中的多个位置,而两个副本恰好都被包含,头文件保护仍能去重这些内容相同的头文件,但 #pragma once 不行(因为编译器无法识别它们其实内容相同)。
对于大多数项目,#pragma once 都能正常工作。许多开发者现在更喜欢它,因为它更简单,也不容易出错。许多 IDE 还会在通过 IDE 新建头文件时,自动把 #pragma once 放在文件顶部。
警告
#pragma 指令是为编译器实现者设计的,可用于他们需要的任意目的。因此,编译器支持哪些 pragma 以及这些 pragma 的含义,完全取决于具体实现。除了 #pragma once 外,不要认为某个编译器支持的 pragma 也一定受到其他编译器支持。
由于 C++ 标准没有定义 #pragma once,某些编译器可能不会实现它。因此,一些开发机构(例如 Google)建议使用传统的头文件保护。本教程系列会优先采用头文件保护,因为这是最通用的做法。不过目前 #pragma once 的支持已经非常普遍,如果你希望改用它,在现代 C++ 中通常也是可以接受的。
总结
头文件保护用于确保某个头文件的内容不会被重复复制到同一个文件中,从而避免重复定义。
重复的声明没有问题,但即使头文件只包含声明(没有定义),使用头文件保护仍然是最佳实践。
请注意,头文件保护不会阻止头文件内容分别复制一次到不同的源文件中。这是好事,因为我们经常需要在不同源文件中引用同一个头文件。
测验时间
问题 #1
请为这个头文件添加头文件保护:
add.h:
int add(int x, int y);
显示解答
#ifndef ADD_H
#define ADD_H
int add(int x, int y);
#endif