C++使用宏函数实现单例模板详解

下面就为你详细讲解“C++使用宏函数实现单例模板详解”的完整攻略。

1. 单例模式简介

单例模式是一种创建型设计模式，它确保某个类只有一个实例，并提供一个全局访问点，使得该实例能够被访问。单例模式在很多场景下都有非常重要的作用，例如线程池、配置文件读取等。

2. 使用宏函数实现单例模板

C++中使用宏函数可以方便地实现单例模板。具体实现步骤如下：

1. 定义一个模板类，并将构造函数、拷贝构造函数、赋值运算符等函数都定义为private，以避免在类外部实例化该类。

template<typename T>
class Singleton{
private:
    Singleton() = default;
    Singleton(const Singleton&) = delete;
    Singleton& operator=(const Singleton&) = delete;
public:
    static T& instance() {
        static T t {};
        return t;
    }
};

1. 调用宏函数定义单例模板的基本代码块，可将其命名为DECLARE_SINGLETON。

#define DECLARE_SINGLETON(class_name) \
    friend class Singleton<class_name>; \
    class_name() = default; \
    virtual ~class_name() = default;

1. 在定义类中使用DECLARE_SINGLETON和public:，可实现添加到单例类模板的基本成员函数。

class Test {
public:
    DECLARE_SINGLETON(Test)
    void func() {
        std::cout << "test func" << std::endl;
    }
};

1. 在需要使用单例模板的地方，调用instance()函数即可获取该单例的唯一实例。

Test& t = Singleton<Test>::instance();
t.func(); // test func

至此，单例模板的基本代码框架已经搭建完成。对于一些较为复杂的应用场景，还需要在单例模板中添加一些额外的成员函数和变量才能满足需求。

3. 示例说明

下面是两个示例，分别演示了如何使用宏函数实现单例模板。

示例1

下面是一个用于保存游戏得分的单例模板类。

template<ScoreType TYPE>
class ScoreManager final {
public:
    DECLARE_SINGLETON(ScoreManager)
    int get_score() {
        return score_;
    }
    void add_score(int score) {
        score_ += score;
    }
private:
    int score_ {};
};

该模板类应具体化为两个不同的类型：ScoreType::Easy和ScoreType::Hard，分别表示不同难度级别的游戏得分管理器。可以使用宏定义SCORE_MANAGER自动化生成两个具体类并定义一个简单的全局函数。

#define SCORE_MANAGER(type) \
    class ScoreManager##type : public ScoreManager<ScoreType::type> {\
    public: ScoreManager##type() {} virtual ~ScoreManager##type() = default; \
    }; \
    static inline auto& Get##type############Singleton() { \
        return Singleton<ScoreManager##type>::instance(); \
    }
SCORE_MANAGER(Easy)
SCORE_MANAGER(Hard)

上述代码利用了##标记来进行宏函数替换，以自动定义具体化的类名和全局函数名。

例如，SCORE_MANAGER(Easy)宏展开后，生成的具体类名为ScoreManagerEasy，全局函数名为GetEasySingleton()，其调用方法为：

auto& score_manager_easy = GetEasySingleton();
score_manager_easy.add_score(100);
std::cout << score_manager_easy.get_score() << std::endl; // 100

同理，SCORE_MANAGER(Hard)生成的具体类名为ScoreManagerHard，全局函数名为GetHardSingleton()。由于ScoreManager类的构造函数为private，因此只能通过使用GetEasySingleton()或GetHardSingleton()方法来获取其唯一实例。

示例2

下面是一个用于保存各种配置文件的单例模板类。

template<typename T>
class ConfigManager final {
public:
    DECLARE_SINGLETON(ConfigManager)
    bool load(const std::string& file_path) {
        try {
            std::ifstream file_stream(file_path);
            if (file_stream.fail()) throw;
            T config;
            nlohmann::json json_config;
            file_stream >> json_config;
            json_config.get_to(config);
            configs_.push_back(std::move(config));
            return true;
        } catch (...) {
            return false;
        }
    }
    const T& get(int index = 0) const {
        return configs_[index];
    }
private:
    std::vector<T> configs_ {};
};

该模板类支持从文件中读取配置信息并以数组形式存储起来。可以使用宏定义CONFIG_MANAGER自动化生成不同类型的具体化类，以便支持多种配置类型。

#define CONFIG_MANAGER(class_name) \
    class ConfigManager##class_name : public ConfigManager<class_name> {\
    public: ConfigManager##class_name() {} virtual ~ConfigManager##class_name() = default; \
    }; \
    static inline auto& Get##class_name##Singleton() { \
        return Singleton<ConfigManager##class_name>::instance(); \
    }
CONFIG_MANAGER(int)
CONFIG_MANAGER(std::string)

上述代码利用了##标记来进行宏函数替换，以自动定义具体化的类名和全局函数名。

例如，CONFIG_MANAGER(int)宏展开后，生成的具体类名为ConfigManagerint，全局函数名为GetIntSingleton()，其调用方法为：

auto& config_manager_int = GetIntSingleton();
config_manager_int.load("int_config.json");
std::cout << config_manager_int.get().size() << std::endl; // 1
std::cout << config_manager_int.get()[0] << std::endl; // 10

auto& config_manager_string = GetStringSingleton();
config_manager_string.load("string_config.json");
std::cout << config_manager_string.get().size() << std::endl; // 2
std::cout << config_manager_string.get()[0] << std::endl; // abc
std::cout << config_manager_string.get()[1] << std::endl; // def

同理，CONFIG_MANAGER(std::string)生成的具体类名为ConfigManagerstd::string，全局函数名为GetStringSingleton()。由于ConfigManager类的构造函数为private，因此只能通过使用GetIntSingleton()或GetStringSingleton()方法来获取其唯一实例。

4. 总结

本文介绍了如何使用宏函数实现单例模板，详细讲解了宏函数的基本生成流程，并给出了两个示例以说明其具体应用过程。单例模式具有非常重要的应用场景，掌握如何使用宏函数实现单例模板，可帮助我们在实际开发中更好地运用该设计模式。