MK
摩柯社区 - 一个极简的技术知识社区
AI 面试

C++中#include与#include "filename.h"的区别

2021-05-085.9k 阅读

一、C++ 中 #include 指令概述

在 C++ 编程中，#include 是一个预处理指令，其主要作用是将指定文件的内容插入到当前源文件中该指令出现的位置。这在模块化编程中极为重要，通过 #include，我们可以复用代码，将常用的函数声明、类型定义等放在头文件中，然后在需要的源文件中引入这些头文件。例如，标准库的使用就依赖于 #include 指令，像 #include <iostream> 引入了输入输出流相关的功能。

二、#include <filename> 形式

（一）查找路径

当使用 #include <filename> 这种形式时，预处理器会在系统指定的标准包含路径中查找指定的头文件。这些标准包含路径通常是编译器安装时设置好的，不同的编译器和操作系统可能有所不同，但一般会包含标准库头文件所在的目录。例如，在 Linux 系统下，GCC 编译器的标准包含路径可能包括 /usr/include 以及编译器安装目录下的相关子目录。在 Windows 系统下，Visual Studio 的标准包含路径会在其安装目录的特定文件夹中。

（二）适用场景

这种形式主要用于包含系统提供的标准头文件，比如 C++ 标准库的头文件，像 <iostream>、<vector>、<algorithm> 等。由于这些头文件是系统标准库的一部分，使用 <> 形式可以确保预处理器在正确的系统路径中查找，避免与用户自定义的头文件混淆。

（三）示例代码

#include <iostream>
#include <vector>

int main() {
    std::vector<int> numbers = {1, 2, 3, 4, 5};
    for (int num : numbers) {
        std::cout << num << " ";
    }
    std::cout << std::endl;
    return 0;
}

在上述代码中，#include <iostream> 引入了输入输出流相关的功能，使得我们可以使用 std::cout 进行输出。#include <vector> 引入了标准库中的向量容器，让我们能够创建和操作动态数组 std::vector。如果这里使用 " " 形式包含这些标准库头文件，预处理器将在当前源文件所在目录等非标准路径查找，大概率找不到这些头文件，从而导致编译错误。

三、#include "filename.h" 形式

（一）查找路径

#include "filename.h" 这种形式下，预处理器首先会在当前源文件所在的目录中查找指定的头文件。如果在当前目录中未找到，预处理器会接着在系统指定的包含路径（与 <> 形式查找标准库头文件的路径类似）中查找。这意味着它的查找顺序是先本地后系统。

（二）适用场景

这种形式适用于包含用户自定义的头文件。用户自定义的头文件通常与当前项目的源文件在同一目录或相关子目录下，使用 " " 形式可以优先在本地查找，符合项目内文件组织和引用的逻辑。例如，在一个较大的项目中，我们可能会将一些自定义的数据结构定义、功能函数声明等放在头文件中，然后在相应的源文件中使用 " " 形式引入。

（三）示例代码

假设我们有一个简单的项目，结构如下：

project/
├── main.cpp
└── utils/
    └── math_utils.h

math_utils.h 文件内容如下：

// math_utils.h
int add(int a, int b) {
    return a + b;
}

main.cpp 文件内容如下：

#include "utils/math_utils.h"
#include <iostream>

int main() {
    int result = add(3, 5);
    std::cout << "The result of addition is: " << result << std::endl;
    return 0;
}

在这个例子中，#include "utils/math_utils.h" 从当前源文件 main.cpp 所在目录的 utils 子目录中找到了自定义的头文件 math_utils.h，使得 main.cpp 能够使用 add 函数。如果这里使用 <> 形式，预处理器不会先在本地目录查找，可能就找不到 math_utils.h 文件，导致编译失败。

四、两者区别的本质

（一）查找策略的本质区别

从本质上来说，<> 和 " " 形式最核心的区别在于头文件的查找策略。<> 形式直接指向系统标准路径，旨在快速准确地找到系统提供的标准头文件，这是因为标准库头文件的位置相对固定且不应该被随意更改或覆盖。而 " " 形式先在本地查找，这是为了方便用户组织和管理自己项目内的头文件。在大型项目中，不同模块可能有各自的头文件，将它们放在与源文件相关的目录结构中，并使用 " " 形式引入，能更好地实现项目的模块化和层次化。

（二）对项目结构和可移植性的影响

使用 <> 包含标准库头文件保证了代码的可移植性。因为无论在何种操作系统和编译器环境下，只要遵循 C++ 标准，标准库头文件的位置和内容都是相对固定的，使用 <> 形式能确保在不同平台上都能正确找到头文件。而对于 " " 形式包含自定义头文件，合理的目录结构和使用方式有助于项目的组织。例如，按照功能模块划分目录，每个模块有自己的头文件和源文件，使用 " " 形式能清晰地体现模块之间的依赖关系。但如果目录结构设计不合理，可能会在跨平台或不同开发环境下出现头文件找不到的问题，影响项目的可移植性。

（三）命名空间和潜在冲突

当使用 <> 包含标准库头文件时，标准库通常会使用特定的命名空间（如 std）来避免命名冲突。由于标准库头文件在系统路径中，其命名空间的设计已经经过了精心规划，与用户自定义的代码在命名空间上一般不会产生直接冲突。然而，当使用 " " 包含自定义头文件时，如果在自定义头文件中没有合理使用命名空间，或者命名不规范，就容易与项目中的其他代码产生命名冲突。例如，在一个项目中，如果两个不同模块的自定义头文件都定义了一个名为 print 的函数且没有使用命名空间区分，在引入这两个头文件的源文件中就会出现命名冲突。

五、实际项目中的应用建议

（一）遵循规范

在实际项目中，一定要严格遵循使用 <> 包含标准库头文件，使用 " " 包含自定义头文件的规范。这不仅有助于代码的可读性和可维护性，也能避免因头文件查找错误或命名冲突带来的问题。例如，团队协作开发项目时，如果成员不遵循这个规范，可能会导致部分成员在编译代码时出现找不到头文件的错误，影响开发进度。

（二）合理组织头文件目录

对于自定义头文件，要合理组织其目录结构。可以按照功能模块划分目录，比如在一个游戏开发项目中，可以将图形渲染相关的头文件放在 rendering 目录下，将游戏逻辑相关的头文件放在 game_logic 目录下。这样在使用 #include "filename.h" 时，路径清晰，也便于管理和维护。同时，在不同模块的头文件中要合理使用命名空间，避免命名冲突。

（三）考虑可移植性

在编写跨平台项目时，对于自定义头文件的路径和包含方式要特别注意。尽量避免使用依赖于特定操作系统或编译器的目录结构。例如，在 Windows 系统下使用反斜杠 \ 作为路径分隔符，而在 Linux 系统下使用正斜杠 /，为了保证可移植性，可以使用编译器提供的宏来处理路径分隔符，或者统一使用相对路径。另外，对于可能在不同平台上有差异的头文件内容，可以使用条件编译（如 #ifdef、#ifndef 等）来处理。

六、特殊情况及处理

（一）嵌套包含

在项目中可能会出现头文件嵌套包含的情况。例如，a.h 包含了 b.h，而 c.cpp 同时包含了 a.h 和 b.h。这种情况下，如果不做处理，可能会导致重复定义的错误。为了避免这种情况，可以在头文件中使用头文件保护符（#ifndef、#define、#endif）或者 #pragma once。例如：

// a.h
#ifndef A_H
#define A_H
// a.h 的内容
#include "b.h"
#endif

// b.h
#ifndef B_H
#define B_H
// b.h 的内容
#endif

#pragma once 则更为简洁，只需要在头文件开头加上 #pragma once 即可，它的作用也是确保头文件只被包含一次。不过需要注意的是，#pragma once 不是 C++ 标准的一部分，某些较老的编译器可能不支持，而头文件保护符是标准的做法，具有更好的兼容性。

（二）自定义查找路径

在一些特殊情况下，可能需要让预处理器在自定义的路径中查找头文件。不同的编译器有不同的方式来指定自定义查找路径。例如，在 GCC 编译器中，可以使用 -I 选项。假设我们有一个自定义的头文件目录 my_headers，可以这样编译代码：

g++ -I my_headers main.cpp -o main

这样预处理器在查找头文件时，除了默认的当前目录和系统标准路径外，还会在 my_headers 目录中查找。在 Visual Studio 中，可以通过项目属性 -> C/C++ -> 常规 -> 附加包含目录来指定自定义的查找路径。

（三）与预编译头文件的关系

预编译头文件（PCH）是一种提高编译速度的技术。在使用预编译头文件时，#include 的行为可能会受到一定影响。通常，预编译头文件会包含一些常用的头文件，如标准库头文件等。在源文件中，如果使用了预编译头文件，应该将需要预编译的 #include 指令放在预编译头文件相关指令之前。例如，在 Visual Studio 中，如果使用了预编译头文件 pch.h，代码应该如下编写：

// pch.h
#include <iostream>
#include <vector>
// pch.cpp
#include "pch.h"
// main.cpp
#include "pch.h"
int main() {
    std::vector<int> numbers = {1, 2, 3};
    for (int num : numbers) {
        std::cout << num << " ";
    }
    std::cout << std::endl;
    return 0;
}

这样可以利用预编译头文件的优势，减少编译时间。如果在 main.cpp 中先包含了其他自定义头文件，然后再包含 pch.h，可能无法充分发挥预编译头文件的作用。

七、总结两者区别及对编程的影响

综上所述，#include <filename> 和 #include "filename.h" 的区别主要体现在头文件查找路径上，前者直接在系统标准路径查找，适用于标准库头文件；后者先在本地查找，适用于自定义头文件。这种区别对代码的可移植性、项目结构组织以及命名空间管理都有重要影响。在实际编程中，遵循正确的使用规范，合理组织头文件和目录结构，能提高代码的质量和开发效率，减少潜在的错误。无论是小型项目还是大型工程，准确理解和运用这两种 #include 形式都是 C++ 编程的重要基础。同时，对于嵌套包含、自定义查找路径以及预编译头文件等相关特殊情况的处理，也能进一步优化项目的编译和运行过程。