深度理解:#pragma once防止文件重复包含

深度理解:#pragma once防止文件重复包含

作者:BlogUpdater |  时间:2018-07-15 |  浏览:4634 |  评论已关闭 条评论

今天的主题,做C++的朋友可能都不会太陌生。此文的目的,主要是深挖一下这个#pragma once。

示例代码

=====================MyBase.h=====================
#pragma message("Including MyClass.h")
#pragma once

class CMyBase
{
public:
	CMyBase(void);
	~CMyBase(void);
};
=====================MyDerived.h=====================
#pragma once

#include "MyBase.h"

class CMyDerived : CMyBase
{
public:
	CMyDerived(void);
	~CMyDerived(void);
};
=====================Main.cpp=====================
#include "stdafx.h"
#include "MyBase.h"
#include "MyDerived.h"

int _tmain(int argc, _TCHAR* argv[])
{
	CMyBase objBase;
	CMyDerived objDerived;

	getchar();
	return 0;
}

在以上代码中,我们定义了两个类,CMyBase和CMyDerived,其中CMyDerived继承自CMyBase,所以,这里的CMyDerived需要在其头文件中包含MyBase.h。在我们的客户程序Main.cpp中,我们使用到了CMyBase类和CMyDerived类,所以需要包含着两个类的头文件。
为了探究#pragma once的作用,我在基类CMyBase的头文件的第一行,添加了如下代码:
#pragma message(“Including MyBase.h”)
这句代码的意思是:每当编译器包含CMyBase的头文件时,都输出一行”Including MyBase.h”的日志。

现在,我们来编译Main.cpp,观察编译输出:

可以看到,虽然Main.cpp包含了两次MyBase.h,一次是在Main.cpp中直接包含,一次是通过MyDerived.h间接包含。实际编译时,MyBase.h头文件也只会被包含一次。因为我们的日志输出放在了MyBase.h头文件中的第一行,所以,编译器在编译的时候,也只会打开MyBase.h这个头文件一次,也即文件的IO操作,只有一次。
以上,我们验证了#pragma once的实际效果。

冗余包含哨卫

在<<大规模C++程序设计>>一书中,作者推荐使用如下的冗余包含哨卫来实现同样的效果。

=====================MyBase.h=====================
#pragma message("Including MyClass.h")
#ifndef INCLUDED_MYBASE
#define INCLUDED_MYBASE

class CMyBase
{
public:
	CMyBase(void);
	~CMyBase(void);
};
#endif
=====================MyDerived.h=====================
#ifndef INCLUDED_MYDERIVED
#define INCLUDED_MYDERIVED

#ifndef INCLUDED_MYBASE
#include "MyBase.h"
#endif

class CMyDerived : CMyBase
{
public:
	CMyDerived(void);
	~CMyDerived(void);
};
=====================Main.cpp=====================
#include "stdafx.h"

#ifndef INCLUDED_MYBASE
#include "MyBase.h"

#ifndef INCLUDED_MYDERIVED
#include "MyDerived.h"
#endif

int _tmain(int argc, _TCHAR* argv[])
{
	CMyBase objBase;
	CMyDerived objDerived;

	getchar();
	return 0;
}

在以上代码中,通过双重#ifndef语句,也实现了只包含一次头文件且只进行一次文件IO操作的效果。但是从代码结构上来看,需要为每一个头文件都编制#ifndef,需要保证符号的唯一性,而#pragma once则没有这样的顾虑,编译器内部已经确保了符号的唯一性。

结论
1) <<大规模C++程序设计>>一书中的冗余包含哨卫可以解决头文件重复包含的问题,也实现了作者所说的仅扫描一次(文件IO操作)的优化措施。
2) #pragma once可以达到同样的效果,且无需关心符号的唯一性的问题,而冗余包含哨卫需要程序员实现符号唯一性。
3) 相对于#ifndef,#pragma once可能跨编译器兼容性稍稍差一点。
4) 如编译平台固定,推荐使用#pragma once。

标签:

评论已关闭。