头文件交叉声明的解决办法

头文件交叉声明的解决办法

编程实践总结 2009-12-06 15:57:00 阅读69 评论0 字号：大中小

问题描述：在类A中使用了类B的对象（作为函数的参数或者私有数据成员），而在类B中同样使用了类A的对象
此时在类A中#include "B.h" 而在类B中*include "A.h"此时编译就会出错

解决办法：
1>
你只要记住，系统是编译.cpp，.c等文件的，因此，你要检查每个.cpp文件，看看是否包含了足够多的文件。比如，在编译C.cpp文件时，可能包含了A.h文件，可是A.h文件又需要B.h文件中定义的某个类声明，而你又没在A.h文件中#include  "B.h"文件，那么就会出错，这时你可以直接在你的C.cpp文件中#include  "B.h"  #include  "A.h"  
当然，如果你的B.h文件又需要其它的文件，那你看着办吧  
那么为什么A.h文件不直接#include  "B.h"呢，如果A.h需要B.h的话？  
有时候，可能class  CA定义在A.h文件中，class  CB定义在B.h文件中，你的CA中定义了CB的实例或实例指针，而CB中又定义了CA的实例或实例指针，这时，你可以在class  CA前先声明一个class  CB;就不用再在A.h中#include  "B.h"了，这样就不存在交叉包含的问题了。当然在A.cpp和B.cpp中都得包含A.h和B.h，而且得注意先后顺序。

2>

在一些大的工程中，可能会包含几十个基础类，免不了之间会互相引用 ( 不满足继承关系，而是组合关系 ) 。也就是需要互相声明。好了，这时候会带来一些混乱。如果处理得不好，会搞得一团糟，根据我的经验，简单谈谈自已的处理办法： 编码时，我们一般会尽量避免 include 头文件，而是采用声明 class XXX 。 但有时候还是必须用 Include 头文件，那么，两者的划分在于什么呢？ 应该是很明确的，但书上好像都少有提及。 首先： 我们要明白为什么要用声明取代头文件包含：对了，是为了避免无必要的重编译 ( 在头文件发生变更时 ) 。 工程较大，低速机，或基础类经常变更 ( 不合理的设计吧 ) ，编译速度还是会在意的， 另外，更为重要的是，采用声明可降低代码 (class) 之间的藕合度，这也是面向对象设计的一大原则。 二：一般原则： a. 头文件中尽量少 include, 如果可以简单申明 class clsOld; 解决，那最好。减少没有必要的 include； b. 实现文件中也要尽量少 include, 不要 include 没有用到的头文件。 三：那什么时候可以只是简单声明 class clsOld 呢？ 简单的说：不需要知道 clsOld 的内存布局的用法都可以 ( 静态成员除外 ) ，也就是讲如果是指针或引用方式的 都行。 比如： clsOld * m_pOld; // 指针占 4 个字节长 clsOld & test(clsOld * pOld) {return *pOld}; 一切 OK 。 四：什么时候不能简单声明 class clsOld ，必须 include 呢？ 不满足三的情况下： 比如： clsOld m_Objold; // 不知道占据大小，必须要通过它的具体声明来计算 原因很简单，想想你要计算 sizeof(classNew) ，但连 clsOld 的 size 都不知道，编译器显然会无能为力。 特殊情况： int test() { return clsOld::m_sInt;} 静态成员调用，想来应该是不需要知道内存布局的，但因为需要知道 m_sInt 是属于 clsOld 命名空间 的，如果只声明 class xxx 显然是不足以说明的，所以必须包含头文件。 综上所述，我有以下几点建议： 1 ：如果有共同相关依赖 ( 必须 include) 的类，比如 A,B 都依赖 D 可以放在一起，然后直接 Include "d" 类的使用者只需关心与本类暴露出的相关类型，内部用到的类型不用去管 ( 不用自已去 include d) 。这样 给出的 class ，调用者才更好用 ( 不用去看代码查找，是不是还需要包含其它头文件 ) 。 2 ：如果 A 类依赖 D B 类不依赖 D ，可以把它们分开两个头文件。各自 Include 。这样可避免当 D 发生变化时， 避免不必要重编译。 3 ：类中尽量采用指针或引用方式调用其它类，这样就可以只声明 class xxx 了。并且这也符合资源最优 利用，更利于使用多态。 /--------------------------------------------------/ 对于VC++中的头文件包含值得注意的一点 　　 今天用VC++编译我这昨天写的代码时发现总是通不过，看到大部分的错误都是与一个类的定义有关。 　　明明我已经在这个类中定义了一个成员变量，可编译器偏要说那个变量不是这个类的成员。没办法，找了半天原因还是没有头绪。再三地确认不是我C++的语法错误之后。我开始怀疑是不是头文件的问题。因为当我把一些#include "..."搬到#pragma once之前或者之后，错误报告就会发生变化。有时就只是说我的一个类重复定义了。 以前用C写头文件的时候都是用宏定义来避免重复包含头文件。C++里虽然也还可用这个方法，但VC++就是不用，它用的是#pragma once。这一变化对我来说真是有点摸不着头脑了，我不清楚#pragma once的工作方式是如何的。而我现在遇到的问题又与这个有关。找找网上的内容看吧。上google搜了半天，那些论坛里的回答基本上都是“防止重复包含头文件的，你不用管他。”这样的。可是不管他真的行吗？我刚学的VC++，我看的书上是没有讲过这个内容的。怎么在网上也搜不到呢？经过我不懈的努力，终于让我找到了一篇http://www.yesky.com/127/1736627_3.shtml。 作者Adding的这段话对我的帮助最大：“ 既然使用了包含文件，为什么还要在class CMainFrame前添加"class CViewerView;"等代码？如果用包含文件代替它，行不行？　　很多Visual C++书籍对这些问题避而不谈，但实际上这是一个重要的问题。如果不能理解上述代码，我们很可能为无法通过编译而大伤脑筋。这些问题的出现是基于这样的一些事实：在我们用标准C/C++设计程序时，有一个原则即两个代码文件不能相互包含，而且多次包含还会造成重复定义的错误。为了解决这个难题， Visual C++使用#pragma once来通知编译器在生成时只包含(打开)一次，也就是说，在第一次#include之后，编译器重新生成时不会再对这些包含文件进行包含(打开)和读取，因此我们看到在用向导创建的所有类的头文件中有#pragma once语句就不会觉得奇怪了。然而正是由于这个语句而造成了在第二次#include后编译器无法正确识别所引用的类。因此，我们在相互包含时还需要加入类似class CViewerView这样的语句来通知编译器这个类是一个实际的调用。 ” 看来就是这个问题了。把我的代码一加上那些类的声明以后果然通过了编译。我感觉这个问题在VC++里面来说应该是值得注意的。可能是由于我刚学VC++，见识太少的原故吧。无论如何先记下来，说不定也有人在为这个#pragma once伤脑筋呢。 头文件包含其实是一想很烦琐的工作，不但我们看着累，编译器编译的时候也很累，再加上头文件中常常出现的宏定义。感觉各种宏定义的展开是非常耗时间的，远不如自定义函数来得速度。我仅就不同头文件、源文件间的句则结构问题提出两点原则，仅供参考： 第一个原则应该是，如果可以不包含头文件，那就不要包含了。这时候前置声明可以解决问题。如果使用的仅仅是一个类的指针，没有使用这个类的具体对象（非指针），也没有访问到类的具体成员，那么前置声明就可以了。因为指针这一数据类型的大小是特定的，编译器可以获知。 第二个原则应该是，尽量在CPP文件中包含头文件，而非在头文件中。假设类A的一个成员是是一个指向类B的指针，在类A的头文件中使用了类B的前置声明并便宜成功，那么在A的实现中我们需要访问B的具体成员，因此需要包含头文件，那么我们应该在类A的实现部分（CPP文件）包含类B的头文件而非声明部分(H 文件)。