17、头文件守卫：#ifndef/#define/#endif，防止重复包含。
说到头文件守卫，我脑子里立刻浮现出刚入行时的一个场景。那时候我写了一个项目，大概有十几个源文件，头文件互相包含来包含去。编译的时候，报了一堆“redefinition of struct”的错误。我当时就懵了，明明每个结构体只定义了一次啊？
后来老工程师走过来，看了一眼我的代码，叹了口气说：“小伙子，你缺了头文件守卫。” 嗯，从那以后，我再也没犯过这个错。
为什么需要头文件守卫？
说白了，C语言的编译器在处理 #include 时，就是简单地把头文件内容复制粘贴到源文件中。如果你不小心让同一个头文件被包含了两次，里面的结构体定义、宏定义、函数声明就会重复出现。
编译器看到重复的定义，它可不会帮你智能去重。它会直接报错，告诉你“这个东西已经定义过了”。
你想想看，一个大型项目里，头文件互相包含的情况太常见了。比如：
a.h里定义了结构体Studentb.h里用到了Student，所以#include "a.h"c.h里同时用到了a.h和b.h- 结果
c.h编译时，a.h被包含了两次
这就是典型的“重复包含”问题。头文件守卫就是用来解决这个问题的。
头文件守卫的标准写法
我个人习惯用这种三件套：#ifndef、#define、#endif。看个例子：
// student.h
#ifndef STUDENT_H
#define STUDENT_H
typedef struct {
char name[50];
int age;
float score;
} Student;
void printStudent(Student* s);
#endif // STUDENT_H这段代码的逻辑其实很简单：
- 第一次包含
student.h时，STUDENT_H这个宏还没定义，所以#ifndef条件成立，进入定义区 - 第一件事就是
#define STUDENT_H，把这个宏标记上 - 然后才是真正的头文件内容——结构体定义、函数声明等
- 最后用
#endif结束条件编译块
如果第二次再包含这个头文件呢？STUDENT_H 已经定义过了，#ifndef 条件不成立，编译器直接跳到 #endif，整个头文件内容被跳过。完美避免了重复定义。
核心要点：头文件守卫的宏名（比如上面的 STUDENT_H）必须唯一。通常用头文件名的大写形式，把点号换成下划线。
另一种写法：#pragma once
有些编译器支持 #pragma once，效果和头文件守卫一样。写法更简洁：
// student.h
#pragma once
typedef struct {
char name[50];
int age;
float score;
} Student;
void printStudent(Student* s);就一行，搞定。但我个人建议，除非你确定项目只在特定编译器上编译，否则还是用传统的 #ifndef/#define/#endif 更稳妥。为什么？因为 #pragma once 不是C语言标准，有些老编译器不支持。
注意：我曾经在一个嵌入式项目里用了 #pragma once，结果客户要求换编译器，那个编译器不认识这个指令，直接忽略掉了。结果头文件重复包含的问题又冒出来了。从那以后，我坚持用标准写法。
头文件守卫的常见误区
我见过不少新手犯这种错误，这里列几个典型的：
- 宏名重复：两个不同的头文件用了同一个守卫宏名。比如
config.h和common.h都用了#ifndef CONFIG_H。结果第二个头文件的内容直接被跳过了。 - 忘记写 #endif：头文件守卫只有
#ifndef和#define，没有#endif。编译器会报错，说缺少条件编译结束符。 - 守卫宏名和普通宏冲突：有人喜欢用
_DEBUG、_VERSION这种名字做守卫，结果和项目里的其他宏冲突了。
我的建议：守卫宏名统一用 头文件名大写_下划线_H 的格式。比如 gpio_driver.h 就用 GPIO_DRIVER_H。这样一看就知道是哪个头文件的守卫，不容易重复。
头文件守卫的完整流程
我画了一张图，帮你理解头文件守卫的整个工作流程：
从图上可以看得很清楚：头文件守卫就像一个“安检门”。第一次来的人（头文件），安检门没记录，放行并登记。第二次再来，安检门一看记录已经有了，直接拦下不让进。
实际项目中的最佳实践
我在团队里推行过一套头文件规范，这里分享给你：
| 规范项 | 说明 | 示例 |
|---|---|---|
| 守卫宏命名 | 头文件名全大写，点号变下划线，末尾加 _H | UART_DRIVER_H |
| 守卫位置 | 必须是头文件的第一行有效代码 | 注释可以写在守卫之前 |
| #endif 注释 | 在 #endif 后面加注释，标明守卫宏名 | #endif // UART_DRIVER_H |
| 禁止嵌套包含 | 不要在头文件里写 #include 其他头文件 | 尽量在 .c 文件里包含 |
重要提醒：头文件守卫只防重复包含，不防循环包含。如果 a.h 包含 b.h，b.h 又包含 a.h，守卫也救不了你。这种循环依赖必须在设计层面解决。
嗯，关于头文件守卫，核心内容就这些了。说白了就是三行预处理指令，但少了它，你的项目编译就会出大问题。我建议你从现在开始，写每个头文件都养成加守卫的习惯。等成了肌肉记忆，你就再也不会被“重复定义”的错误困扰了。
公众号:蓝海资料掘金营，微信deep3321