单例模式(创建型设计模式)的 C++ 代码示例模板

前言

单例模式(创建型设计模式)的 C++ 代码示例模板。


代码仓库


单例模式(Singleton)

结构

  • 单例类
  • 私有静态单例对象
  • 私有构造方法
  • 公有静态获取单例对象方法

返回引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除

  • 私有或删除拷贝构造方法和拷贝赋值运算符

设置为私有:允许类内将单例对象作为参数或返回值传递(公有静态获取单例对象方法 可以返回值而不是引用)
设置为删除:禁止拷贝
设置为私有和删除:禁止拷贝

核心

  • 私有静态单例对象:单例类内保存同一单例对象
  • 私有构造方法:禁止客户端创建多个单例对象
  • 公有静态获取单例对象方法:允许客户端创建或获取同一单例对象

一般 饿汉式是获取,懒汉式是创建或获取。

  • 私有或删除拷贝构造方法和拷贝赋值运算符:禁止客户端或单例类内创建一个或多个拷贝单例对象

类型

  • 饿汉式
  • 懒汉式

饿汉式

  • 程序启动时(main() 执行前) 创建单例对象(不管用不用都提前创建)
  • 在类外初始化私有静态单例对象(保证在程序启动时(main() 执行前)创建单例对象)

在类外初始化私有静态单例对象 注意:
静态非 const 整数类型(short 和 int 等) 或 静态非 constexpr 内置类型(char 和 float 等)的成员属性 只能在类外初始化;
因为构造方法是私有权限,所以在类外只能是隐式调用无参构造方法;
如果单例类需要传参并初始化成员属性,可以考虑额外 定义设置成员属性方法 或 在公有静态获取单例对象方法中设置成员属性

  • 线程安全
  • 公有静态获取单例对象方法直接返回单例对象(因为在程序启动时(main() 执行前)已经创建单例对象,且线程安全,无需其他逻辑)
  • 创建或获取单例对象时使用引用

使用引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除

代码(普通版)

// 饿汉式:程序启动时(main() 执行前) 创建单例对象(不管用不用都提前创建)
#include <iostream>

using std::cout;
using std::endl;

class Singleton
{
public:
    // 公有静态获取单例对象方法
    inline static Singleton &getInstance() // 返回引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除
    {
        return singleton; // 直接返回单例对象:因为在程序启动时(main() 执行前)已经创建单例对象,且线程安全,无需其他逻辑
    }

private:
    // 私有构造方法
    Singleton()
    {
        cout << "Singleton()" << endl;
    }

    // 私有或删除拷贝构造方法和拷贝赋值运算符
    // 设置为私有:允许类内将单例对象作为参数或返回值传递(公有静态获取单例对象方法 可以返回值而不是引用)
    // 设置为删除:禁止拷贝
    // 设置为私有和删除:禁止拷贝
    Singleton(const Singleton &) = delete;
    Singleton &operator=(const Singleton &) = delete;

    // 私有静态单例对象
    static Singleton singleton;
};

// 在类外初始化私有静态单例对象 注意:
// 静态非 const 整数类型(short 和 int 等) 或 静态非 constexpr 内置类型(char 和 float 等)的成员属性 只能在类外初始化
// 因为构造方法是私有权限,所以在类外只能是隐式调用无参构造方法
// 如果单例类需要传参并初始化成员属性,可以考虑额外 定义设置成员属性方法 或 在公有静态获取单例对象方法中设置成员属性
Singleton Singleton::singleton; // 隐式调用无参构造方法

// 客户端
int main()
{
    // 创建或获取单例对象
    Singleton &singleton_1 = Singleton::getInstance(); // 使用引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除
    Singleton &singleton_2 = Singleton::getInstance();

    // 输出单例对象地址:地址相同,说明是同一单例对象
    cout << "Singleton_1: " << &singleton_1 << endl;
    cout << "Singleton_2: " << &singleton_2 << endl;

    return 0;
}
/*
输出:
Singleton()
Singleton_1: 0x407030
Singleton_2: 0x407030
*/

代码

// 饿汉式:程序启动时(main() 执行前) 创建单例对象(不管用不用都提前创建)
#include <iostream>

using std::cout;
using std::endl;

// 单例类
class Singleton
{
public:
    ~Singleton() = default;

    // 公有静态获取单例对象方法
    inline static Singleton &getInstance() // 返回引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除
    {
        return singleton; // 直接返回单例对象:因为在程序启动时(main() 执行前)已经创建单例对象,且线程安全,无需其他逻辑
    }

private:
    // 私有构造方法
    Singleton()
    {
        cout << "Singleton()" << endl;
    }

    // 私有或删除拷贝构造方法和拷贝赋值运算符
    // 设置为私有:允许类内将单例对象作为参数或返回值传递(公有静态获取单例对象方法 可以返回值而不是引用)
    // 设置为删除:禁止拷贝
    // 设置为私有和删除:禁止拷贝
    Singleton(const Singleton &) = delete;
    Singleton &operator=(const Singleton &) = delete;

    // 私有静态单例对象
    static Singleton singleton;
};

// 在类外初始化私有静态单例对象 注意:
// 静态非 const 整数类型(short 和 int 等) 或 静态非 constexpr 内置类型(char 和 float 等)的成员属性 只能在类外初始化
// 因为构造方法是私有权限,所以在类外只能是隐式调用无参构造方法
// 如果单例类需要传参并初始化成员属性,可以考虑额外 定义设置成员属性方法 或 在公有静态获取单例对象方法中设置成员属性
Singleton Singleton::singleton; // 隐式调用无参构造方法

// 客户端
int main()
{
    // 创建或获取单例对象
    Singleton &singleton_1 = Singleton::getInstance(); // 使用引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除
    Singleton &singleton_2 = Singleton::getInstance();

    // 输出单例对象地址:地址相同,说明是同一单例对象
    cout << "Singleton_1: " << &singleton_1 << endl;
    cout << "Singleton_2: " << &singleton_2 << endl;

    return 0;
}
/*
输出:
Singleton()
Singleton_1: 0x407030
Singleton_2: 0x407030
*/

懒汉式

  • 程序运行时创建单例类对象(需要用了才创建)
  • 在类外初始化私有静态单例对象 和 私有静态互斥锁(保证在程序运行时创建单例类对象)

在类外初始化私有静态单例对象 和 私有静态互斥锁 注意:
静态非 const 整数类型(short 和 int 等) 或 静态非 constexpr 内置类型(char 和 float 等)的成员属性 只能在类外初始化;
因为构造方法是私有权限,所以在类外只能是隐式调用无参构造方法;
如果单例类需要传参并初始化成员属性,可以考虑额外 定义设置成员属性方法 或 在公有静态获取单例对象方法中设置成员属性

  • 线程不安全(如多个线程同时调用公有静态获取单例对象方法)
  • 公有静态获取单例对象方法使用 私有静态互斥锁 和 双重检查锁定(保证线程安全)
  • 创建或获取单例对象时使用引用

使用引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被禁止

代码(普通版)

// 懒汉式:程序运行时创建单例类对象(需要用了才创建)
#include <iostream>
#include <mutex>

using std::cout;
using std::endl;
using std::lock_guard;
using std::mutex;

// 单例类
class Singleton
{
public:
    // 注意:静态对象由程序管理,不需要析构方法
    // ~Singleton()
    // {
    //     delete singleton;
    // }

    // 公有静态获取单例对象方法
    static Singleton &getsingleton() // 返回引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除
    {
        // 线程不安全(如多个线程同时调用公有静态获取单例对象方法)
        // 使用 私有静态互斥锁 和 双重检查锁定(保证线程安全)
        if (singleton == nullptr) // 第一重检查锁定
        {
            lock_guard<mutex> mutex_lock_guard(mutex_lock); // 上锁

            // 第二次检查,确保在互斥锁区域内再次检查单例对象是否未创建
            if (singleton == nullptr) // 第二重检查锁定
            {
                singleton = new Singleton();
            }

            // 隐式解锁
        }

        return *singleton;
    }

private:
    // 私有构造方法
    Singleton()
    {
        cout << "Singleton()" << endl;
    }

    // 私有或删除拷贝构造方法和拷贝赋值运算符
    // 设置为私有:允许类内将单例对象作为参数或返回值传递(公有静态获取单例对象方法 可以返回值而不是引用)
    // 设置为删除:禁止拷贝
    // 设置为私有和删除:禁止拷贝
    Singleton(const Singleton &) = delete;
    Singleton &operator=(const Singleton &) = delete;

    // 私有静态单例对象
    static Singleton *singleton;

    // 私有静态互斥锁
    static mutex mutex_lock;
};

// 在类外初始化私有静态单例对象为空 和 私有静态互斥锁 注意:
// 静态非 const 整数类型(short 和 int 等) 或 静态非 constexpr 内置类型(char 和 float 等)的成员属性 只能在类外初始化
// 因为构造方法是私有权限,所以在类外只能是隐式调用无参构造方法
// 如果单例类需要传参并初始化成员属性,可以考虑额外 定义设置成员属性方法 或 在公有静态获取单例对象方法中设置成员属性
Singleton *Singleton::singleton = nullptr;
mutex Singleton::mutex_lock;

// 客户端
int main()
{
    // 创建或获取单例对象
    Singleton &singleton_1 = Singleton::getsingleton(); // 使用引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被禁止
    Singleton &singleton_2 = Singleton::getsingleton();

    // 输出单例对象地址:地址相同,说明是同一单例对象
    cout << "Singleton_1: " << &singleton_1 << endl;
    cout << "Singleton_2: " << &singleton_2 << endl;

    return 0;
}
/*
输出:
Singleton()
Singleton_1: 0x2502500
Singleton_2: 0x2502500
*/

代码

// 懒汉式:程序运行时创建单例类对象(需要用了才创建)
#include <iostream>
#include <memory>
#include <mutex>

using std::cout;
using std::endl;
using std::lock_guard;
using std::make_unique;
using std::mutex;
using std::unique_ptr;

// 单例类
class Singleton
{
public:
    ~Singleton() = default;

    // 公有静态获取单例对象方法
    static Singleton &getsingleton() // 返回引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被删除
    {
        // 线程不安全(如多个线程同时调用公有静态获取单例对象方法)
        // 使用 私有静态互斥锁 和 双重检查锁定(保证线程安全)
        if (singleton == nullptr) // 第一重检查锁定
        {
            lock_guard<mutex> mutex_lock_guard(mutex_lock); // 上锁

            if (singleton == nullptr) // 第二重检查锁定
            {
                // make_unique<> 是非成员函数模板,不是类的成员,即使在类内也不能访问类内私有成员,需要声明为友元
                singleton = make_unique<Singleton>();
            }

            // 隐式解锁
        }

        return *singleton;
    }

private:
    // 私有构造方法
    Singleton()
    {
        cout << "Singleton()" << endl;
    }

    // 私有或删除拷贝构造方法和拷贝赋值运算符
    // 设置为私有:允许类内将单例对象作为参数或返回值传递(公有静态获取单例对象方法 可以返回值而不是引用)
    // 设置为删除:禁止拷贝
    // 设置为私有和删除:禁止拷贝
    Singleton(const Singleton &) = delete;
    Singleton &operator=(const Singleton &) = delete;

    // 私有静态单例对象
    static unique_ptr<Singleton> singleton;

    // 私有静态互斥锁
    static mutex mutex_lock;

    // 声明 make_unique<> 为友元
    friend unique_ptr<Singleton> make_unique<Singleton>();
};

// 在类外初始化私有静态单例对象为空 和 私有静态互斥锁 注意:
// 静态非 const 整数类型(short 和 int 等) 或 静态非 constexpr 内置类型(char 和 float 等)的成员属性 只能在类外初始化
// 因为构造方法是私有权限,所以在类外只能是隐式调用无参构造方法
// 如果单例类需要传参并初始化成员属性,可以考虑额外 定义设置成员属性方法 或 在公有静态获取单例对象方法中设置成员属性
unique_ptr<Singleton> Singleton::singleton = nullptr;
mutex Singleton::mutex_lock;

// 客户端
int main()
{
    // 创建或获取单例对象
    Singleton &singleton_1 = Singleton::getsingleton(); // 使用引用的原因:保证是同一单例对象而不是副本;减少返回值的拷贝开销;返回值拷贝被禁止
    Singleton &singleton_2 = Singleton::getsingleton();

    // 输出单例对象地址:地址相同,说明是同一单例对象
    std::cout << "Singleton_1: " << &singleton_1 << std::endl;
    std::cout << "Singleton_2: " << &singleton_2 << std::endl;

    return 0;
}
/*
输出:
Singleton()
Singleton_1: 0x25624e0
Singleton_2: 0x25624e0
*/

总结

单例模式(创建型设计模式)的 C++ 代码示例模板。


参考资料


作者的话

  • 感谢参考资料的作者/博主
  • 作者:夜悊
  • 版权所有,转载请注明出处,谢谢~
  • 如果文章对你有帮助,请点个赞或加个粉丝吧,你的支持就是作者的动力~
  • 文章在描述时有疑惑的地方,请留言,定会一一耐心讨论、解答
  • 文章在认识上有错误的地方, 敬请批评指正
  • 望读者们都能有所收获

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值