如何在C++中设计一个大类头文件？

Question

我有一个很大的C++类，其中包括5个其他类，其中一些内部有其他类。标题（.h）文件的总长度非常大并且不可读。这就是我想要做的事：

// Foo.h file 
#ifndef __INCLUDE_FOO_H 
#define __INCLUDE_FOO_H 
namespace foo { 
class Foo { 
public: 
    #include "foo/Bar.h" 
    void f() { /* something here */ } 
}; 
} 
#endif 

这是子类：

// Foo/Bar.h file 
class Bar { 
} 

你觉得呢？这是一种合适的方法，还是我正在重新发明轮子？

Answer 1

代替把内部类内部类的，你最好还是留给他们自己，最终在自己的命名空间：

// in file foo/bar.h 
namespace foo_detail 
{ 
    class Bar 
    { 
    }; 
}; 

// in file foo.h 
#include "foo/bar.h" 

class Foo 
{ 
private: 
    foo_detail::Bar theBar; 
}; 

这样你Foo类定义不是太复杂，你的定义文件很小（并且很容易浏览），所以在Foo类定义中不包含任何东西（尊重最小惊喜的原则 - 或者减少WTF/LOC的数量），并且当您查看Bar的定义，您可以清楚地看到它是foo的实现细节（如果没有其他名称，则通过命名空间名称）。

命名空间很好。相信命名空间。

Answer 2

我不会去为类声明中#include指令。我倾向于将它们在文件开头的一个地方分组。此外，由于您使用的是名称空间，因此文件Bar.h将具有不同的含义，它将被包含在代码中的其他位置。

关于在类的方法，我知道这可能是偶尔有用类的类，但你不能只是简单地创建单独的类，然后使用这些类的实例/引用/指针需要的地方？

和我的最后一点是，如果你已经有了巨大的头，你总是可以定义体的方法在不同的文件（即foo.h中只包含声明，所有的代码去foo.c的）。它使你的软件编译更复杂一些，但是使代码更具可读性。

Answer 3

我会做的是真正考虑你是否需要所有这些嵌套类，或能将它们分成不同的类中的第一件事情？

如果你真的需要他们，那么你有什么工作，但在所有诚实，我只想把它们放在一个大文件。如果你像这样分割文件，你会混淆人们，他们会认为这些内部类在他们看到他们的头文件时处于命名空间范围。

Answer 4

你可以使用PIMPL，并将所有私人领域的私人相关类，如：

// foo.h 

class FooPrivate; /* Forward declaration */ 

class Foo { 
    public: /* Public fields, if any */ 

    Foo(); /* c-tor */ 
    ~Foo(); /* d-tor */ 

    /* Public methods */ 
    int how_old_is_frisky(); /* Sample method declaration */ 

    private: /* No private fields */ 
     FooPrivate *priv; 
} 

// foo.cpp 

// may be a struct, it's plain ol' data container 
class FooPrivate { 
    public: 
     /* Any data private to Foo. As FooPrivate 
      class is declared in .cpp file, it 
      will be accessible only from this file */ 
     Bar bar; 
     Cat frisky; 
     Dog goggie;   
} 

/* Constructor - remember to allocate private data */ 
Foo::Foo() 
{ 
    priv = new FooPrivate; 
} 

/* Destructor, remember to deallocate private data */ 
Foo::~Foo() 
{ 
    delete priv; 
} 

/* Sample method definition */ 
int Foo::how_old_is_frisky() 
{ 
    return priv->frisky.get_age(); 
} 

这样：

1. 你的头是短了很多
2. 您的私人数据是真正的私有
3. 为2的结果，如果你改变你的类的实施，你不必重新编译仅使用接口的每个源文件。

此外，如示例所示，在源文件（.cpp）文件中放置方法定义（即方法体）。这样他们将只被编译一次。如果将它们放在标题中，则每次编译标题时都会对它们进行编译。

--- --- EDIT

的2点和3不是隐藏从恶意观看者的眼睛的数据成员。在C++中有一个“特性”，它使私有成员成为接口的一部分。理想情况下，私有成员应该是实现的一部分，因此接口的用户不应该受实现变化的影响。不幸的是，C++并非如此。当您更改私人成员（即添加新成员）时，您将更改整个类接口，因此您的界面的用户（即包含头文件的所有文件）必须重新编译。

但是，当您使用pointer-to-implementation模式，唯一的私有成员是一个指针，所以只能做公共成员变动引发的客户端代码重新编译（除非你，当然，改变priv指针）。要查看真实生活中的示例，请查看广泛使用PIMPL模式的Qt库。