C++中 #pragma once 與 #ifndef 解析
為了避免同一個(gè)文件被include多次,C/C++中有兩種方式,一種是#ifndef方式,一種是#pragma once方式。在能夠支持這兩種方式的編譯器上,二者并沒(méi)有太大的區(qū)別,但是兩者仍然還是有一些細(xì)微的區(qū)別。
??? 方式一:
???
#ifndef __SOMEFILE_H__
??? #define __SOMEFILE_H__
??? ... ... // 聲明、定義語(yǔ)句
??? #endif
??? 方式二:
???
#pragma once
??? ... ... // 聲明、定義語(yǔ)句
??? #ifndef的方式受C/C++語(yǔ)言標(biāo)準(zhǔn)支持。它不光可以保證同一個(gè)文件不會(huì)被包含多次,也能保證內(nèi)容完全相同的兩個(gè)文件(或者代碼片段)不會(huì)被不小心同時(shí)包含。
??? 當(dāng)然,缺點(diǎn)就是如果不同頭文件中的宏名不小心“撞車”,可能就會(huì)導(dǎo)致你看到頭文件明明存在,編譯器卻硬說(shuō)找不到聲明的狀況——這種情況有時(shí)非常讓人抓狂。
??? 由于編譯器每次都需要打開頭文件才能判定是否有重復(fù)定義,因此在編譯大型項(xiàng)目時(shí),ifndef會(huì)使得編譯時(shí)間相對(duì)較長(zhǎng),因此一些編譯器逐漸開始支持#pragma?once的方式。
??? #pragma once一般由編譯器提供保證:同一個(gè)文件不會(huì)被包含多次。注意這里所說(shuō)的“同一個(gè)文件”是指物理上的一個(gè)文件,而不是指內(nèi)容相同的兩個(gè)文件。你無(wú)法對(duì)一個(gè)頭文件中的一段代碼作pragma once聲明,而只能針對(duì)文件。
??? 其好處是,你不必再費(fèi)勁想個(gè)宏名了,當(dāng)然也就不會(huì)出現(xiàn)宏名碰撞引發(fā)的奇怪問(wèn)題。大型項(xiàng)目的編譯速度也因此提高了一些。
??? 對(duì)應(yīng)的缺點(diǎn)就是如果某個(gè)頭文件有多份拷貝,本方法不能保證他們不被重復(fù)包含。當(dāng)然,相比宏名碰撞引發(fā)的“找不到聲明”的問(wèn)題,這種重復(fù)包含很容易被發(fā)現(xiàn)并修正。
??? #pragma once方式產(chǎn)生于#ifndef之后,因此很多人可能甚至沒(méi)有聽說(shuō)過(guò)。目前看來(lái)#ifndef更受到推崇。因?yàn)?ifndef受C/C++語(yǔ)言標(biāo)準(zhǔn)的支持,不受編譯器的任何限制;而#pragma once方式卻不受一些較老版本的編譯器支持,一些支持了的編譯器又打算去掉它,所以它的兼容性可能不夠好。一般而言,當(dāng)程序員聽到這樣的話,都會(huì)選擇#ifndef方式,為了努力使得自己的代碼“存活”時(shí)間更久,通常寧愿降低一些編譯性能,這是程序員的個(gè)性,當(dāng)然這是題外話啦。
??? 還看到一種用法是把兩者放在一起的:
???
#pragma once
??? #ifndef __SOMEFILE_H__
??? #define __SOMEFILE_H__
??? ... ... // 聲明、定義語(yǔ)句
??? #endif
??? 看起來(lái)似乎是想兼有兩者的優(yōu)點(diǎn)。不過(guò)只要使用了#ifndef就會(huì)有宏名沖突的危險(xiǎn),也無(wú)法避免不支持#pragma once的編譯器報(bào)錯(cuò),所以混用兩種方法似乎不能帶來(lái)更多的好處,倒是會(huì)讓一些不熟悉的人感到困惑。
??? 選擇哪種方式,應(yīng)該在了解兩種方式的情況下,視具體情況而定。只要有一個(gè)合理的約定來(lái)避開缺點(diǎn),我認(rèn)為哪種方式都是可以接受的。而這個(gè)已經(jīng)不是標(biāo)準(zhǔn)或者編譯器的責(zé)任了,應(yīng)當(dāng)由程序員自己或者小范圍內(nèi)的開發(fā)規(guī)范來(lái)搞定。
??? btw:我看到GNU的一些討論似乎是打算在GCC 3.4(及其以后?)的版本取消對(duì)#pragma once的支持。不過(guò)事實(shí)上,我手上的GCC 3.4.2和GCC 4.1.1仍然支持#pragma once,甚至沒(méi)有deprecation warning,倒是GCC2.95會(huì)對(duì)#pragma once提出warning。
??? VC6及其以后版本亦提供對(duì)#pragma once方式的支持,這一特性應(yīng)該基本穩(wěn)定下來(lái)了。