ifndef是什么，如何使用？

引言

使用HbuilderX uni-ui模板创建的uni-app项目，main.js文件中看到有如下的注释：

// #ifndef VUE3

......

// #endif

// #ifdef VUE3

......

// #endif 

相信很多没有uini-app项目开发经验的朋友，初次接触uni-app项目，可能都不清楚这是纯注释还是有其他用途，其实这是预处理方面的知识，在uni-app官方教程里也有关于这方面的阐述，主要是为了解决跨端兼容问题而引入的条件编译 uni-app组成和跨端原理 | uni-app官网。以下整理的资料，为大家做个铺路引导。

PS：建议熟悉vue但对uini-app不甚了解的新手，通读一下uni-app教程，这将对开发uni-app项目，大有裨益。其实，这不是建议啦，是必须要做的，虽然uni-app 是一个使用 Vue.js 开发所有前端应用的框架，语法基于vue，但是uni-app也要很多自己的规范与语法特性以及扩展组件等，所以不全面了解，也是无法顺利搞懂的

背景

uni-app 已将常用的组件、JS API 封装到框架中，开发者按照 uni-app 规范开发即可保证多平台兼容，大部分业务均可直接满足。

但每个平台有自己的一些特性，因此会存在一些无法跨平台的情况。

• 大量写 if else，会造成代码执行性能低下和管理混乱。
• 编译到不同的工程后二次修改，会让后续升级变的很麻烦。

在 C 语言中，通过 #ifdef、#ifndef 的方式，为 windows、mac 等不同 os 编译不同的代码。 uni-app 参考这个思路，为 uni-app 提供了条件编译手段，在一个工程里优雅的完成了平台个性化实现。

简介

ifndef 是 if not define 的缩写，一种宏定义。它是预处理功能中三种（宏定义，文件包含和条件编译）中的第三种，——条件编译。

定义

其使用方式是：

#define X // 定义一个宏...#endif​
// c语言在对程序进行编译时，会先根据预处理命令进行预处理，C语言编译系统包括预处理，编译和链接等部分。#ifndef X  // 先测试是否被宏定义过#define X 程序段1 // 如果X没有被宏定义过，定义X，并编译程序段1#else程序段2 // 如果X已经定义过了则编译程序段2 的语句，忽视程序段1。#endif

作用

条件指示符#ifndef的最主要目的是防止头文件的重复包含和编译。

了解：条件编译当然也可以用条件语句来实现。 但是用条件语句将会对整个源程序进行编译，生成的目标代码程序很长，而采用条件编译，则根据条件只编译其中的的程序段1或程序段2，生成的目标程序较短。如果条件选择的程序段很长，采用条件编译的方法是十分必要的。

内容

#ifndef 标识1 // 判断"标识1"是否定义，如果被定义则返回假，如果没有被定义则返回真。

/**********************************/

语句1 #ifndef 标识1

语句2 #define 标识1

语句3 #endif

语句4 ……

语句5 ……

该段代码意思是：如果标识1没有被定义，则重定义标识1，即执行语句2、语句3；如果标识1已经被定义，则直接跳过语句2、语句3，直接执行语句4、语句5、……

/***********************************/

备注：#ifndef 和 #endif 要一起使用，不能存在丢失，如果丢失#endif，可能会报错。

需要注意的是，#ifndef起到的效果是防止一个源文件两次包含同一个头文件，而不是防止两个源文件包含同一个头文件。网上很多资料对这一细节的描述都是错误的。事实上，防止同一头文件被两个不同的源文件包含这种要求本身就是不合理的，头文件存在的价值就是被不同的源文件包含。

假如你有一个C源文件，它包含了多个头文件，比如头文件A和头文件B，而头文件B又包含了头文件A，则最终的效果是，该源文件包含了两次头文件A。如果你在头文件A里定义了结构体或者类类型(这是最常见的情况)，那么问题来了，编译时会报大量的重复定义错误。

例如，要编写头文件test.h

在头文件开头写上两行：

#ifndef _TEST_H

#define _TEST_H  // 一般是文件名的大写 头文件结尾写上一行:

#endif

这样一个工程文件里同时包含两个test.h时，就不会出现重定义的错误了。

分析：

当第一次包含test.h时，由于没有定义_TEST_H，条件为真，这样就会包含(执行)#ifndef _TEST_H和

#endif之间的代码，当第二次包含test.h时前面一次已经定义了_TEST_H，条件为假，#ifndef _TEST_H和

#endif之间的代码也就不会再次被包含，这样就避免了重定义了.

还是把头文件的内容都放在 #ifndef 和 #endif 中吧。不管你的头文件会不会被多个文件引用，你都要加上这个。一般格式是这样的:

#ifndef <标识>

#define <标识>

......

......

#endif

<标识>在理论上来说可以是自由命名的，但每个头文件的这个"标识"都应该是唯一的。标识的命名规则一般是头文件名全大写，前面加下划线，并把文件名中的"."也变成下划线，如：stdio.h

#ifndef _STDIO_H

#define _STDIO_H

......

#endif

---

参考资料

跨端兼容 | uni-app官网

ifndef 的使用方法_ifndef的用法

#ifndef#define#endif的用法整理