头文件包含/前向声明

Question

在我的 C++ 项目中，什么时候必须使用头文件的包含 (#include "myclass.h")？什么时候必须使用类的前向声明（class CMyClass;）？

Answer 1

通常，首先尝试前向声明。这将减少编译时间等。如果不能编译，请使用#include。如果您需要执行以下任何操作，则必须使用#include：

1. 访问类的成员或函数。
2. 使用指针算术。
3. 使用 sizeof。
4. 任何 RTTI 信息。
5. new/delete、复制等。
6. 按值使用它。
7. 继承它。
8. 成为会员即可。
9. 函数中的实例。

（来自 @Mooing Duck 的 6,7,8,9）

它们可能更多，但我今天还没有戴上语言法帽子。

Answer 2

转发声明有几个问题：

• 这就像将类名存储在多个位置 - 如果您在一个位置更改它，那么您现在必须在其他地方更改它。重构成为一个挑战，因为代码仍然可以使用更改后的类名正常编译，但由于前向声明引用未定义的类，链接将失败。如果包含头文件并且不使用前向声明，您将在编译过程中发现这些问题。

• 前向声明对其他人来说很难维护。例如，如果头文件包含：

  包含“MyProject/MyWidgets/MyFooWidgets/FooUtil/Foo.h”
  

  而不是前向声明

   类 Foo ；  
  

  其他人很容易找到类 Foo 的声明位置。通过前向声明，情况并非如此
  明显的;当用户尝试打开时，某些 IDE（例如 Eclipse）可能会打开前向声明
  变量的声明。

• 当您在代码中包含包含前向声明的头文件，但实际的代码定义位于您未链接的某个其他库中时，链接可能会因未定义的符号错误而失败。在编译时捕获此问题会更方便，并出现诸如 "Could not find file MyProject/MyWidgets/MyFooWidgets/FooUtil/Foo.h" 之类的错误，这样您就会知道在哪里查找相应的 Foo.cpp 并识别包含它的库。

如果您认为构建花费的时间太长，请尝试仅进行不带链接的编译。如果您的代码需要 10 秒来编译，10 分钟来链接，则问题与一些额外的包含无关。同样，如果您的头文件中包含太多内容，实际上导致了性能问题，那么您可能是时候将该文件的内容重构为多个较小的头文件了。

那么什么时候可以转发申报呢？如果您在与真实声明相同的头文件中执行此操作。

示例：

class Foo ;

typedef Foo* FooPtr ;
typedef Foo& FooRef ;

class Foo
{
   public:
      Foo( ) ;
      ~Foo( ) ;
}

或

class TreeNode ;

class Tree
{
private:
   TreeNode m_root ;
}

class TreeNode
{
   void* m_data ;
} ;

Answer 3

如果您只需要指向类的指针，并且不需要有关该类的任何知识而不是其名称，则可以使用前向声明。

Answer 4

作为初学者，当您需要使用它们包含的类型或函数时，您应该始终 #include 头文件 - 不要尝试通过前向声明来“优化”您的构建 - 这几乎没有必要，即使在大型项目中，只要项目架构良好。

唯一绝对需要前向声明的情况是在这样的情况下：

struct A {
   void f( B b );
};

struct B {
   void f( A a );
};

每个结构（或类）引用另一个结构（或类）的类型。在这种情况下，您需要 B 的前向声明来解决问题：

struct B;   // forward declaration

struct A {
   void f( B b );
};

struct B {
   void f( A a );
};

Answer 5

您应该努力尽量减少 #include，这不仅是为了减少编译时间，也是为了帮助实现模块化和可测试性。正如 @ypnos 所说，当您只需要指针时，类转发非常出色。

有关如何减少标头依赖性的一些实用技巧，请参阅本文。