C++接口与多种实现的隔离
本文介绍一种将接口和实现完全隔离的技术, 其特点是增加新的实现不影响任何已有代码, 只需在新源文件中实现新的接口.
该方法见于SICP(计算机程序的构造和解释).
具体方法就是通过Install(Id, Maker)和Make(Id)来添加和使用新的实现. 实现通过Id来唯一标识, Install(Id, Maker)供新实现的作者调用以完成安装或注册. 使用者通过Make(Id)来使用(构造)它. Id的值应该是使用者能获取的, 比如事先已知或读取配置文件等等.
下面示例中, Logger的Write()接口只是输出一个字符串, 具体实现(派生类)使用字符串作为Id:
// file0: logger.h
// ...
class Logger
{
public:
typedef std::string Id;
typedef std::shared_ptr<Logger> Ptr;
static Ptr Make(const Id &id) {
auto pos = Makers().find(id);
if (pos == Makers().end()) {
return Ptr();
} else {
return pos->second();
}
}
int Write(const std::string &msg) { return DoWrite(msg); }
private:
virtual int DoWrite(const std::string &msg) = 0;
protected:
typedef std::function<Ptr()> Maker;
static bool Install(const Id &id, const Maker &func) {
if (Makers().find(id) != Makers().end()) {
return false;
} else {
Makers()[id] = func;
return true;
}
}
static std::map<Id, Maker> & Makers() {
static std::map<Id, Maker> s;
return s;
}
};
// ...
ConsoleLogger是一个实现, 其Id我们设置为"console".
// file1: console_logger.cpp
// ....
#include "logger.h"
class ConsoleLogger : public Logger
{
public:
static bool InstallThis() {
auto maker = []() { return Logger::Ptr(new ConsoleLogger); };
return Logger::Install("console", maker);
}
private:
int DoWrite(const std::string &msg) override {
std::cout << msg << std::endl;
return msg.size();
}
};
namespace {
const bool kInstalled = ConsoleLogger::InstallThis();
}
使用示例如下:
//...
#include "logger.h"
int main(int argc, const char *argv[])
{
Logger::Ptr lgr = Logger::Make("console");
assert(lgr);
lgr->Write("Hello, World!");
return 0;
}
注意到了吧, 添加新实现的时候, 接口和其他实现不需要修改任何代码, 使用时只需要Id值, 甚至不需要知道ConsoleLogger等实现(类)的存在, 也不必提供头文件.
这种方法依赖统一的Make接口, 示例中的Make没有参数, 实际项目中可能会有不同, 比如FileLogger可能需要一个文件路径. 遇到差异可能就要void*之类的参数来处理了. 当然你也可以重载多个Make, 不过那就比较繁琐了.
其实, 这种Install,Make方法是通用的, 可以提取出来作为模板类重复使用. 但要注意处理Make接口问题, 需要用variable template支持多种接口, 还要注意各个接口类的Makers()不要混淆.
2017-06-08
