C++实现简单的反射——根据字符串创建类对象

• 最近项目需求中需要一个关键功能——根据字符串创建了类对象。由于C++没有类似Java、C#这类动态语言中的反射机制，所以在C++程序中一般用if...else...或者switch来将字符串或者枚举值与类对象的创建方法来进行对应的映射。这里如果我们实现一个简单的反射机制，可以根据字符串创建了类对象就可以简化这个过程，而且无论对修改还是扩展都会更加方便。

• 理想的使用方式就是我们需要这个功能的类统一继承于一个Object基类，创建的时候通过统一的Object工厂类调用类名字符串做参数的Create方法，像这样，最后创建出来一个Panel类：

auto panel = (Object*)ObjectFactory::GetInstance()->CreateObject("Panel");

• 首先，我们需要一个单例类模板，方便后面创建单例工厂，模板如下：

// 单例类模板
template<class T>
class Singleton
{
public:
    using object_type = T;
    struct object_creator
    {
        object_creator() { Singleton<T>::GetInstance(); }
    };

    static object_creator creator_object;
public:
    static object_type* GetInstance()
    {
        static object_type _instance;
        return &_instance;
    }
};
template<typename T> typename Singleton<T>::object_creator Singleton<T>::creator_object;

• 然后，我们就可以定义Object构造函数指针以及Object工厂类。工厂类中我们通过unordered_map来保存类名字符串到类对象构造函数指针的映射。工厂类中定义Register（保存类名字符串到类对象构造函数指针的映射）和Create方法提供给外部注册以及类创建。

// 定义Object构造函数指针
using CreateObjectFunc = function<void*()>;

struct CreateObjectFuncClass {
    explicit CreateObjectFuncClass(CreateObjectFunc func) : create_func(func) {}
    CreateObjectFunc create_func;
};

// Object工厂类
class ObjectFactory : public Singleton<ObjectFactory> {
public:
    //返回void *减少了代码的耦合
    void* CreateObject(const string& class_name) {
        CreateObjectFunc createobj = nullptr;

        if (create_funcs_.find(class_name) != create_funcs_.end())
            createobj = create_funcs_.find(class_name)->second->create_func;

        if (createobj == nullptr)
            return nullptr;

        // 调用函数指针指向的函数 调用REGISTER_CLASS中宏的绑定函数，也就是运行new className代码
        return createobj();
    }

    void RegisterObject(const string& class_name, CreateObjectFunc func) {
        auto it = create_funcs_.find(class_name);
        if (it != create_funcs_.end())
            create_funcs_[class_name]->create_func = func;
        else
            create_funcs_.emplace(class_name, new CreateObjectFuncClass(func));
    }

    ~ObjectFactory() {
        for (auto it : create_funcs_)
        {
            if (it.second != nullptr)
            {
                delete it.second;
                it.second = nullptr;
            }
        }
        create_funcs_.clear();
    }

private:
    //缓存类名和生成类实例函数指针的map
    unordered_map<string, CreateObjectFuncClass* > create_funcs_;
};

• 之后我们定义一个宏方便Object的注册。

#define REGISTERPANELCLASS(className) \
class className##PanelHelper { \
public: \
    className##PanelHelper() \
    { \
        ObjectFactory::GetInstance()->RegisterObject(#className, []() \
        { \
            auto* obj = new className(); \
            obj->SetClassName(#className); \
            return obj; \
        }); \
    } \
}; \
className##PanelHelper g_##className##_panelhelper;// 初始化一个helper的全局变量，执行构造函数中的RegisterObject执行。

• 下面我们来定义所有类的基类，这个基类其实是个“鸡肋”，可有可无。但有它我们可以提供统一的Get、SetClassName的方法，也方便扩展。
• 最后，定义我们需要通过字符串创建的Panel类，该类继承于Object。

// 所有类的基类
class Object
{
public:
    Object() {}
    virtual ~Object() {}

    void SetClassName(const string& name) { class_name_ = name; }
    string GetClassName() const { return class_name_; }

protected:
    string class_name_;
};

class Panel : public Object
{
public:
    Panel() {}
    ~Panel() {}
};

• 下面是完整代码：

#include <iostream>
#include <unordered_map>
#include <functional>

using namespace std;

// 单例类模板
template<class T>
class Singleton
{
public:
    using object_type = T;
    struct object_creator
    {
        object_creator() { Singleton<T>::GetInstance(); }
    };

    static object_creator creator_object;
public:
    static object_type* GetInstance()
    {
        static object_type _instance;
        return &_instance;
    }
};
template<typename T> typename Singleton<T>::object_creator Singleton<T>::creator_object;


// 定义Object构造函数指针
using CreateObjectFunc = function<void*()>;

struct CreateObjectFuncClass {
    explicit CreateObjectFuncClass(CreateObjectFunc func) : create_func(func) {}
    CreateObjectFunc create_func;
};

// Object工厂类
class ObjectFactory : public Singleton<ObjectFactory> {
public:
    //返回void *减少了代码的耦合
    void* CreateObject(const string& class_name) {
        CreateObjectFunc createobj = nullptr;

        if (create_funcs_.find(class_name) != create_funcs_.end())
            createobj = create_funcs_.find(class_name)->second->create_func;

        if (createobj == nullptr)
            return nullptr;

        // 调用函数指针指向的函数 调用REGISTER_CLASS中宏的绑定函数，也就是运行new className代码
        return createobj();
    }

    void RegisterObject(const string& class_name, CreateObjectFunc func) {
        auto it = create_funcs_.find(class_name);
        if (it != create_funcs_.end())
            create_funcs_[class_name]->create_func = func;
        else
            create_funcs_.emplace(class_name, new CreateObjectFuncClass(func));
    }

    ~ObjectFactory() {
        for (auto it : create_funcs_)
        {
            if (it.second != nullptr)
            {
                delete it.second;
                it.second = nullptr;
            }
        }
        create_funcs_.clear();
    }

private:
    // 缓存类名和生成类实例函数指针的map
    unordered_map<string, CreateObjectFuncClass* > create_funcs_;
};


#define REGISTERPANELCLASS(className) \
class className##PanelHelper { \
public: \
    className##PanelHelper() \
    { \
        ObjectFactory::GetInstance()->RegisterObject(#className, []() \
        { \
            auto* obj = new className(); \
            obj->SetClassName(#className); \
            return obj; \
        }); \
    } \
}; \
className##PanelHelper g_##className##_panelhelper;// 初始化一个helper的全局变量，执行构造函数中的RegisterObject执行。


// 所有类的基类
class Object
{
public:
    Object() {}
    virtual ~Object() {}

    void SetClassName(const string& name) { class_name_ = name; }
    string GetClassName() const { return class_name_; }

protected:
    string class_name_;
};

class Panel : public Object
{
public:
    Panel() {}
    ~Panel() {}
};


int main() {
    REGISTERPANELCLASS(Panel)
    auto panel = (Object*)ObjectFactory::GetInstance()->CreateObject("Panel");
    auto name = panel->GetClassName();
    cout << name.c_str() << endl;
    delete panel;

    system("pause");

    return 0;
}

• 运行结果如图：

  
  运行结果