c++如何防止頭文件重復(fù)引入

這篇文章將為大家詳細講解有關(guān)c++如何防止頭文件重復(fù)引入，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

C 語言中如何使用宏定義（#ifndef / #define / #endif）來有效避免頭文件被重復(fù) #include，此方式在 C++ 多文件編程中也很常用。

舉個例子，如下是一個 C++ 項目，其內(nèi)部含有 school.h 和 student.h 這 2 個頭文件以及 main.cpp 源文件，其各自包含的代碼為：

//student.h

class Student {

    //......

};

//school.h

#include "student.h"

class School {

    //......

private:

    Student stu[50];

};

//main.cpp

#include "student.h"

#include "school.h"

int main() {

    //......

    return 0;

}

運行此項目會發(fā)現(xiàn)，編譯器報“Student 類型重定義”錯誤。這是因為在 school.h 文件中已經(jīng) #include 了一次 "student.h"，而在 main.cpp 主程序又同時 #include 了 "school.h" 和 "student.h"，即 Student 類的定義被引入了 2 次，C++不允許同一個類被重復(fù)定義。

有小伙伴可能想到，既然 School.h 文件中已經(jīng)引入了 Student 類，那去掉 main.cpp 主程序引入的 student.h 文件不就可以了嗎？這樣確實可以避免重復(fù)引入 Student 類，但此方式并不適用于所有“重復(fù)引入”的場景。

C++ 多文件編程中，處理“多次 #include 導(dǎo)致重復(fù)引入”問題的方式有以下 3 種。

————————

1) 使用宏定義避免重復(fù)引入

在實際多文件開發(fā)中，我們往往使用如下的宏定義來避免發(fā)生重復(fù)引入：

#ifndef _NAME_H

#define _NAME_H

//頭文件內(nèi)容

#endif

其中，_NAME_H 是宏的名稱。需要注意的是，這里設(shè)置的宏名必須是獨一無二的，不要和項目中其他宏的名稱相同。

當程序中第一次 #include 該文件時，由于 _NAME_H 尚未定義，所以會定義 _NAME_H 并執(zhí)行“頭文件內(nèi)容”部分的代碼；當發(fā)生多次 #include 時，因為前面已經(jīng)定義了 _NAME_H，所以不會再重復(fù)執(zhí)行“頭文件內(nèi)容”部分的代碼。

也就是說，我們可以將前面項目中的 student.h 文件做如下修改：

#ifndef _STUDENT_H

#define _STUDENT_H

class Student {

    //......

};

#endif

雖然該項目 main.cpp 文件中仍 #include 了 2 次 "student.h"，但鑒于 _STUDENT_H 宏只能定義一次，所以 Student 類也僅會定義一次。再次執(zhí)行該項目會發(fā)現(xiàn)，其可以正常執(zhí)行。

2) 使用#pragma once避免重復(fù)引入

除了前面第一種最常用的方式之外，還可以使用 #pragma one 指令，將其附加到指定文件的最開頭位置，則該文件就只會被 #include 一次。

我們知道，#ifndef 是通過定義獨一無二的宏來避免重復(fù)引入的，這意味著每次引入頭文件都要進行識別，所以效率不高。但考慮到 C 和 C++ 都支持宏定義，所以項目中使用 #ifndef 規(guī)避可能出現(xiàn)的“頭文件重復(fù)引入”問題，不會影響項目的可移植性。

和 ifndef 相比，#pragma once 不涉及宏定義，當編譯器遇到它時就會立刻知道當前文件只引入一次，所以效率很高。

但值得一提的是，并不是每個版本的編譯器都能識別 #pragma once 指令，一些較老版本的編譯器就不支持該指令（執(zhí)行時會發(fā)出警告，但編譯會繼續(xù)進行），即 #pragma once 指令的兼容性不是很好。

目前，幾乎所有常見的編譯器都支持 #pragma once 指令，甚至于 Visual Studio 2017 新建頭文件時就會自帶該指令?？梢赃@么說，在 C/C++ 中，#pragma once 是一個非標準但卻逐漸被很多編譯器支持的指令。

除此之外，#pragma once 只能作用于某個具體的文件，而無法向 #ifndef 那樣僅作用于指定的一段代碼。

這里仍以前面的 "student.h" 文件為例，將其內(nèi)容修改為：

#pragma once

class Student {

    //......

};

3) 使用_Pragma操作符

C99 標準中新增加了一個和 #pragma 指令類似的 _Pragma 操作符，其可以看做是 #pragma 的增強版，不僅可以實現(xiàn) #pragma 所有的功能，更重要的是，_Pragma 還能和宏搭配使用。

有關(guān) _Pragma 操作符更多的功能和用法，本節(jié)不做詳細講解，這里僅介紹如何用 _Pragma 操作符避免頭文件重復(fù)引入。

當處理頭文件重復(fù)引入問題時，可以將如下語句添加到相應(yīng)文件的開頭：

_Pragma("once")

比如，將該語句添加到前面項目中 student.h 文件中的開頭位置，再次執(zhí)行項目，其可以正常執(zhí)行。

事實上，無論是 C 語言還是 C++，為防止用戶重復(fù)引入系統(tǒng)庫文件，幾乎所有庫文件中都采用了以上 3 種結(jié)構(gòu)中的一種，這也是為什么重復(fù)引入系統(tǒng)庫文件編譯器也不會報錯的原因。

總結(jié)

本節(jié)介紹了 3 種避免頭文件被重復(fù)引入的方法，其中 #pragma once 和 _Pragma("once") 可算作一類，其特點是編譯效率高，但可移植性差（編譯器不支持，會發(fā)出警告，但不會中斷程序的執(zhí)行）；而 #ifndef 的特點是可移植性高，編譯效率差。讀者可根據(jù)實際情況，挑選最符合實際需要的解決方案。

除非對項目的編譯效率有嚴格的要求，強烈推薦讀者選用第一種解決方案，即采用 #ifndef / #define / #endif 組合解決頭文件被重復(fù)引入。

另外在某些場景中，考慮到編譯效率和可移植性，#pragma once 和 #ifndef 經(jīng)常被結(jié)合使用來避免頭文件被重復(fù)引入。比如說：

#pragma once

#ifndef _STUDENT_H

#define _STUDENT_H

class Student {

    //......

};

#endif

當編譯器可以識別 #pragma once 時，則整個文件僅被編譯一次；反之，即便編譯器不識別 #pragma once 指令，此時仍有 #ifndef 在發(fā)揮作用。

關(guān)于“c++如何防止頭文件重復(fù)引入”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，使各位可以學(xué)到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。