C++ 设计模式 Forward Declaration Pimpl

放几轮跟 chatgpt 的对话，很精彩的回答

You

我有个问题，我的 main 目标依赖 src/gcp_subscriber.h 的 GCPSubscriber class
这个 class 有个 private 成员 google::cloud::pubsub::Subscriber
也就意味着我得在 gcp_subscriber.h 里面引用 google cloud 的依赖库。
也就意味着 main 也会 include 到 google cloud 依赖库，这会减慢我的 main 目标编译速度

ChatGPT

在 C++ 中，使用前置声明（forward declaration）可以避免引入完整的头文件而只引入所需的类的声明。通过使用前置声明，你可以减少编译时需要处理的代码量，从而提高编译速度。

在你的 gcp_subscriber.h 中，尝试使用前置声明而不是包含整个 google/cloud/pubsub/subscriber.h 头文件。只在实现文件中（例如 gcp_subscriber.cpp）引入完整的头文件。这样可以将依赖库的具体实现细节延迟到编译阶段的实现文件中，从而加速主目标的编译。

以下是一个示例：

gcp_subscriber.h:

#ifndef GCP_SUBSCRIBER_H_
#define GCP_SUBSCRIBER_H_#include <memory> // 如果使用了 std::shared_ptr// Forward declaration of google::cloud::pubsub::Subscriber
namespace google::cloud::pubsub {
class Subscriber;
} // namespace google::cloud::pubsubclass GCPSubscriber {
public:GCPSubscriber(std::string channel, std::shared_ptr<MessageBufferQueue> queue);void block_receive();private:std::shared_ptr<MessageBufferQueue> queue;std::unique_ptr<google::cloud::pubsub::Subscriber> subscriber;
};#endif  // GCP_SUBSCRIBER_H_

gcp_subscriber.cpp:

#include "gcp_subscriber.h"
#include <google/cloud/pubsub/subscriber.h>GCPSubscriber::GCPSubscriber(std::string channel, std::shared_ptr<MessageBufferQueue> queue): queue(queue),subscriber(std::make_unique<google::cloud::pubsub::Subscriber>(google::cloud::pubsub::MakeSubscriberConnection(google::cloud::pubsub::Subscription("combo-001", fmt::format("cme-mktdata-{}-NR", channel)))))
{
}void GCPSubscriber::block_receive() {// 实现 block_receive 函数的具体内容// ...
}

通过这种方式，gcp_subscriber.h 只需要知道 google::cloud::pubsub::Subscriber 的存在，而不需要知道它的具体实现细节。这有助于减少 main 目标的编译时间，因为它不再需要处理完整的 google/cloud/pubsub/subscriber.h。

省略中间一些对话

You

那这前置声明不就失效了吗

ChatGPT

你是对的，我为之前的回答道歉。由于需要在 gcp_subscriber.h 中的实现文件 (gcp_subscriber.cc) 中使用完整的 google::cloud::pubsub::Subscriber，前置声明就不再适用了。

在这种情况下，你需要在 gcp_subscriber.h 中包含完整的头文件，以便确保 google::cloud::pubsub::Subscriber 的定义是可见的。这将导致包含 Google Cloud Pub/Sub 相关的头文件，从而增加了编译时间。解决方案是确保只在需要的地方包含这些头文件，以尽量减小编译时间的影响。

如果你的项目结构允许，可以考虑将 google::cloud::pubsub::Subscriber 的具体实现移到实现文件（如 gcp_subscriber.cc）中，而不是将其定义放在头文件中。这样，头文件只需要进行前置声明，而不必包含完整的定义。这样可以减小头文件的依赖，提高编译速度。例如：

gcp_subscriber.h:

#ifndef GCP_SUBSCRIBER_H_
#define GCP_SUBSCRIBER_H_#include <memory>class MessageBufferQueue;  // 前置声明class GCPSubscriber {
public:GCPSubscriber(std::string channel, std::shared_ptr<MessageBufferQueue> queue);void block_receive();private:std::shared_ptr<MessageBufferQueue> queue;class Impl;  // 前置声明std::unique_ptr<Impl> subscriber_impl;
};#endif  // GCP_SUBSCRIBER_H_

gcp_subscriber.cc:

#include "gcp_subscriber.h"
#include <google/cloud/pubsub/subscriber.h>class GCPSubscriber::Impl {
public:google::cloud::pubsub::Subscriber subscriber;// ... 其他成员和实现
};GCPSubscriber::GCPSubscriber(std::string channel, std::shared_ptr<MessageBufferQueue> queue): queue(queue), subscriber_impl(std::make_unique<Impl>())
{// 对 Impl 进行初始化，包括创建 google::cloud::pubsub::Subscriber
}void GCPSubscriber::block_receive() {// 实现 block_receive 函数的具体内容，使用 subscriber_impl->subscriber// ...
}

这种方式可以将 Google Cloud Pub/Sub 的具体实现从头文件中移除，从而减小编译时的依赖。

You

这是 pimpl 吗

ChatGPT

是的，这种技术被称为 Pimpl（Pointer to Implementation）或者又称为 Opaque Pointer。Pimpl 是一种设计模式，其主要目标是将类的实现细节（成员变量、成员函数的实现等）隐藏在一个独立的类中，以减小头文件的依赖，提高封装性，同时降低编译时的依赖性。

在 Pimpl 模式中，类的头文件只包含对实现类的前置声明，而实现类的定义则放在实现文件中。这样，只有在实现文件中才需要包含具体的头文件，而头文件中则只需要包含前置声明，从而减小了编译时的依赖。

这对于减小编译时间和隐藏实现细节非常有用。同时，当实现发生变化时，只需要修改实现文件，而头文件可以保持不变，从而减小了对外部代码的影响。

在你的例子中，GCPSubscriber 类的具体实现被封装在 GCPSubscriber::Impl 类中，而 GCPSubscriber 的头文件中只包含了 MessageBufferQueue 的前置声明和 Impl 的前置声明，从而隐藏了 google::cloud::pubsub::Subscriber 的具体实现。