C++ 单例模式

原创文章，转载请注明出处。本文主要从单例的用处以及问题所做介绍

WhiteTian

41850人浏览 · 2021-04-24 21:54:10

WhiteTian · 2021-04-24 21:54:10 发布

原创文章，转载请注明出处。

C++ 单例模式介绍

单例可能是最简单的一种设计模式，实现方法很多种；同时单例也有其局限性。

本文对C++ 单例的常见写法进行了一个总结，包括1>懒汉式版本、2>线程安全版本智能指针加锁、3>线程安全版本Magic Static；按照从简单到复杂，最终回归简单的的方式循序渐进地介绍，并且对各种实现方法的局限进行了简单的阐述，大量用到了C++ 11的特性如智能指针，magic static，线程锁；从头到尾理解下来，对于学习和巩固C++语言特性还是很有帮助的。

一、单例是什么

单例是设计模式里面的一种，全局有且只有一个类的static实例，在程序任何地方都能够调用到。比如游戏客户端的本地Excel的加载，我们都会格式化成json，我习惯用单例做本地数据的管理。

二、C++实现单例

2.1 一个好的单例应该具备下面4点

1.全局只有一个实例：static 特性，同时禁止用户自己声明并定义实例（把构造函数设为 private）
2.线程安全
3.禁止赋值和拷贝
4.用户通过接口获取实例：使用 static 类成员函数

2.2 C++ 实现单例的几种方式

2.2.1 有缺陷的懒汉式

懒汉式(Lazy-Initialization)的方法是直到使用时才实例化对象，也就说直到调用Instance() 方法的时候才 new 一个单例的对象，如果不被调用就不会占用内存。如果单线程没有问题，当多线程的时候就会出现不可靠的情况。

#include <iostream>
using namespace std;

/*
*	版本1 SingletonPattern_V1 存在以下两个问题
*	
*	1. 线程不安全, 非线程安全版本
*	2. 内存泄露
*/
class SingletonPattern_V1
{
private:
	SingletonPattern_V1() {
		cout << "constructor called!" << endl;
	}
	SingletonPattern_V1(SingletonPattern_V1&) = delete;
	SingletonPattern_V1& operator=(const SingletonPattern_V1&) = delete;
	static SingletonPattern_V1* m_pInstance;

public:
	~SingletonPattern_V1() {
		cout << "destructor called!" << endl;
	}
	//在这里实例化
	static SingletonPattern_V1* Instance() {
		if (!m_pInstance) {
			m_pInstance = new SingletonPattern_V1();
		}
		return m_pInstance;
	}
	void use() const { cout << "in use" << endl; }
};

//在类外初始化静态变量
SingletonPattern_V1* SingletonPattern_V1::m_pInstance = nullptr;

//函数入口
int main()
{
    //测试
	SingletonPattern_V1* p1 = SingletonPattern_V1::Instance();
	SingletonPattern_V1* p2 = SingletonPattern_V1::Instance();

	system("pause");
	return 0;
}

执行结果是 constructor called!

可以看到，获取了两次类的实例，构造函数被调用一次，表明只生成了唯一实例，这是个最基础版本的单例实现，他有哪些问题呢？

线程安全的问题，当多线程获取单例时有可能引发竞态条件：第一个线程在if中判断 m_pInstance是空的，于是开始实例化单例;同时第2个线程也尝试获取单例，这个时候判断m_pInstance还是空的，于是也开始实例化单例;这样就会实例化出两个对象,这就是线程安全问题的由来; 解决办法:加锁
内存泄漏. 注意到类中只负责new出对象，却没有负责delete对象因此只有构造函数被调用，析构函数却没有被调用；因此会导致内存泄漏。解决办法1：当然我们自己手动调用delete来进行释放是可以的，但是维护在何处释放又成了问题。正确解决办法：使用共享指针;

因此，这里提出一个改进的，线程安全的、使用智能指针的实现：

2.2.2 线程安全、内存安全的懒汉式单例（C++11Shared_ptr，C++11 mutex lock）

#include <iostream>
using namespace std;
#include <memory> // C++11 shared_ptr头文件
#include <mutex>  // C++11 mutex头文件
/*
*	版本2 SingletonPattern_V2 解决了V1中的问题
*
*	1. 通过加锁让线程安全了
*	2. 通过智能指针(shareptr 基于引用计数)内存没有泄露了
*/
class SingletonPattern_V2 
{
public:
	~SingletonPattern_V2() {
		std::cout << "destructor called!" << std::endl;
	}
	SingletonPattern_V2(SingletonPattern_V2&) = delete;
	SingletonPattern_V2& operator=(const SingletonPattern_V2&) = delete;

	//在这里实例化
	static std::shared_ptr<SingletonPattern_V2> Instance() 
	{
		//双重检查锁
		if (m_pInstance == nullptr) {
			std::lock_guard<std::mutex> lk(m_mutex);
			if (m_pInstance == nullptr) {
				m_pInstance = std::shared_ptr<SingletonPattern_V2>(new SingletonPattern_V2());
			}
		}
		return m_pInstance;
	}

private:
	SingletonPattern_V2() {
		std::cout << "constructor called!" << std::endl;
	}
	static std::shared_ptr<SingletonPattern_V2> m_pInstance;
	static std::mutex m_mutex;
};

//在类外初始化静态变量
std::shared_ptr<SingletonPattern_V2> SingletonPattern_V2::m_pInstance = nullptr;
std::mutex SingletonPattern_V2::m_mutex;

int main()
{
	std::shared_ptr<SingletonPattern_V2> p1 = SingletonPattern_V2::Instance();
	std::shared_ptr<SingletonPattern_V2> p2 = SingletonPattern_V2::Instance();

	system("pause");
	return 0;
}

执行结果是 constructor called! destructor called!

优点

基于 shared_ptr，内部实现的是基于引用计数的智能指针，每次实例被赋值或者拷贝，都会引用+1，在内部的析构中判断引用计数为0的时候会调用真正的delete。(cocos2D中就是基于这个做的垃圾回收)(UE4中也有专门的智能指针，我的文章链接)用了C++比较倡导的 RAII思想，用对象管理资源，当 shared_ptr 析构的时候，new 出来的对象也会被 delete掉。以此避免内存泄漏。
加了锁，使用互斥锁来达到线程安全。这里使用了两个 if判断语句的技术称为双重检测锁；好处是，只有判断指针为空的时候才加锁，避免每次调用 get_instance的方法都加锁，锁的开销毕竟还是有点大的。

缺点

使用智能指针会要求外部调用也得使用智能指针，就算用个typedef也是一长串代码不好维护且不美观。非必要不应该提出这种约束; 使用锁也有开销; 同时代码量也增多了，实际上设计最简单的才是最好的。
其实还有双重检测锁某种程度上也是不可靠的：具体可以看这篇文章

因此这里还有第三种基于 magic static 达到线程安全的方式

2.2.3 最推荐的懒汉式单例(magic static)——局部静态变量

#include <iostream>
using namespace std;
/*
*	版本3 SingletonPattern_V3 使用局部静态变量 解决了V2中使用智能指针和锁的问题
*
*	1. 代码简洁 无智能指针调用
*	2. 也没有双重检查锁定模式的风险
*/
class SingletonPattern_V3
{
public:
	~SingletonPattern_V3() {
		std::cout << "destructor called!" << std::endl;
	}
	SingletonPattern_V3(const SingletonPattern_V3&) = delete;
	SingletonPattern_V3& operator=(const SingletonPattern_V3&) = delete;
	static SingletonPattern_V3& Instance() {
		static SingletonPattern_V3 m_pInstance;
		return m_pInstance;

	}
private:
	SingletonPattern_V3() {
		std::cout << "constructor called!" << std::endl;
	}
};

int main()
{
	SingletonPattern_V3& instance_1 = SingletonPattern_V3::Instance();
	SingletonPattern_V3& instance_2 = SingletonPattern_V3::Instance();

	system("pa

执行结果是 constructor called! destructor called!

魔法静态变量是C++11的核心语言功能特性，提案:N2660 - Dynamic Initialization and Destruction with Concurrency, 最早在GCC2.3 / Clang2.9 / MSVC19.0等编译器得到支持。

这种方法又叫做 Meyers' SingletonMeyer's的单例，是著名的写出《Effective C++》系列书籍的作者 Meyers 提出的。所用到的特性是在C++11标准中的Magic Static特性：

If control enters the declaration concurrently while the variable is being initialized, the concurrent execution shall wait for completion of the initialization.
如果当变量在初始化的时候，并发同时进入声明语句，并发线程将会阻塞等待初始化结束。

这样保证了并发线程在获取静态局部变量的时候一定是初始化过的，所以具有线程安全性。

C++静态变量的生存期是从声明到程序结束，这也是一种懒汉式。

这是最推荐的一种单例实现方式：