源文件头文件那些事
|
14
|
0
|
C++

1465 字
|
7 分钟

源文件头文件那些事

不知道是否很多人也和我有一样的疑惑，哪怕写了这么久的C\C++代码，但是仍然会对某个需要引用的头文件到底应该放到头文件还是源文件停顿，如果是源文件需要用到的函数放到哪里；如果是头文件类声明某个成员需要外部定义类型又放到哪里；所用到的某个定义又要放到哪里

那么就跟随我一起解开这些影响不大但是又事关代码规范的小秘密吧

外部头文件引用

同名头，源文件关系

在 C/C++ 项目中，xxx.h 和 xxx.cpp 通常代表同一个模块。他们在编译阶段被编译成一个xxx.o模块，然后被链接

  • 头文件是向外部声明的接口，告诉外部模块本模块提供了什么样的功能（函数声明、类定义、宏等） 它只需要包含使用到给模块所必须的最小信息
  • 源文件是对于头文件接口的具体实现，包含具体的代码

源文件需要的头文件是否全放在同名头文件中？

假设你有 xxx.cpp，它内部实现用到了 <vector>、"bar.h"、"utils.h"。 如果你把这些都写进 xxx.h，然后让 main.cpp 只 #include "xxx.h"，会有以下严重问题：

1. 编译时间爆炸 (Compilation Time)

  • 现状：如果有 100 个文件都 #include "xxx.h"，而 xxx.h 里又包含了 10 个其他大header。
  • 后果：编译器需要预处理这 100 * 10 = 1000 次包含关系。哪怕 main.cpp 根本用不到 <vector>，它也要被迫解析 <vector> 的所有内容。项目越大，编译越慢。

2. 不必要的依赖耦合 (Coupling)

  • 现状：main.cpp 只需要调用 xxx 的函数。
  • 后果：因为 xxx.h 包含了 bar.h，main.cpp 实际上也隐式依赖了 bar.h。如果 bar.h 改了，main.cpp 可能被迫重新编译。这违反了“高内聚、低耦合”的原则。

3. 命名空间污染与冲突 (Namespace Pollution)

  • 现状：utils.h 里可能定义了一个宏 #define MAX 100。
  • 后果：main.cpp 包含 xxx.h 后，也引入了这个宏。如果 main.cpp 里自己也想定义 MAX，就会发生冲突报错。头文件应该尽量“干净”，只暴露必要的接口。

4. 泄露实现细节 (Implementation Details)

  • 现状：xxx.cpp 内部决定用 std::list 还是 std::vector 是它的自由。
  • 后果：如果你把 <vector> 放进 xxx.h，就等于告诉所有使用者：“我内部用了 vector”。如果你哪天想改成 list，你就得改 xxx.h，导致所有包含 xxx.h 的文件都要重新编译。好的设计应该隐藏实现细节。

综上所述：头文件著需要包含声明所需要的最小集合即可，源文件包含实现所需要的头文件

类成员需要外部类型

有时候一个类声明放在头文件，其中某个成员变量或函数可能需要其他外部文件的定义类型，那么如果在头文件包含了该头文件，那么源文件需要包含否？

这里涉及一个C++的核心优化技巧：前向声明

类成员是对象实例

如果类成员是一个具体的对象（不是指针或引用），编译器必须知道该类型的完整大小才能为类分配内存。所以必须在头文件包含

在技术层面上源文件不需要再次包含，但是写上也没错，如果有一天你重构 MyClass.h，把std::string换成了 const char*，从而删掉了 #include <string>，那么如果你的.cpp里其他地方用到了 std::string 的功能，编译就会突然报错。显式包含可以让 .cpp 文件独立于.h的内部实现细节。

类成员是指针或引用

如果类成员是指针或引用，编译器只需要知道该类型存在即可，不需要知道它的大小。这时候不应该在头文件中包含该头文件。这时候就可以使用前向声明：

// MyClass.h
class OtherClass; // 【前向声明】告诉编译器有个叫 OtherClass 的类就行

class MyClass {
public:
    void doSomething();
private:
    OtherClass* ptr; // 指针，编译器知道指针大小固定，不需要 OtherClass 完整定义
};
// MyClass.cpp
#include "MyClass.h"
#include "OtherClass.h" // 【必须】因为实现函数时可能需要调用 OtherClass 的方法

void MyClass::doSomething() {
    ptr->someMethod(); // 这里需要知道 OtherClass 的具体内容
}
  • 关系：
    • 头文件：只写 class OtherClass;，不 #include "OtherClass.h"。
    • 源文件：必须 #include "OtherClass.h"，因为实现逻辑里用到了它。
  • 好处：OtherClass.h 的修改不会导致包含 MyClass.h 的其他文件重新编译。这是 C++ 减少编译依赖最重要的手段。

并且这类操作对于结构体也是同样适用，在 C++ 中，struct 和 class 在编译器眼里几乎是同一种东西（唯一的区别是默认访问权限：struct 默认 public，class 默认 private）。因此，前向声明的规则对结构体完全适用。

并且结构体也有构造和析构函数，struct 和 class 几乎完全等价，都可以拥有构造函数、析构函数、成员函数、虚函数、静态成员、操作符重载等所有类特性。

宏定义放置

根据宏的”作用域需求”

宏的使用范围应该放哪里原因
多个源文件都需要头文件 (.h)保证一致性，避免重复定义
仅当前源文件内部使用源文件 (.cpp/.c)减少依赖，避免污染全局命名空间
配置开关/条件编译专门的配置头文件集中管理，便于维护
上一篇
下一篇