剑指offer (02)：实现 Singleton 单例模式 (Python 实现详解)
本文大部分内容来自于Python中的单例模式的几种实现方式的及优化 ，在此基础上进行修改，整理。
1 题目
单例模式（Singleton Pattern）是一种常用的软件设计模式。在它的核心结构中只包含一个被称为单例的特殊类。通过单例模式可以保证系统中，应用该模式的类一个类只有一个实例。即一个类只有一个对象实例。
又或者某个服务器程序的配置信息存放在一个文件中，客户端通过一个 AppConfig 的类来读取配置文件的信息。如果在程序运行期间，有很多地方都需要使用配置文件的内容，也就是说，很多地方都需要创建 AppConfig 对象的实例，这就导致系统中存在多个 AppConfig 的实例对象，而这样会严重浪费内存资源，尤其是在配置文件内容很多的情况下。事实上，类似 AppConfig 这样的类，我们希望在程序运行期间只存在一个实例对象。
在 Python 中，我们可以用多种方法来实现单例模式。
2 题解
2.1 使用模块
其实，Python 的模块就是天然的单例模式，因为模块在第一次导入时，会生成 .pyc 文件，当第二次导入时，就会直接加载 .pyc 文件，而不会再次执行模块代码。因此，我们只需把相关的函数和数据定义在一个模块中，就可以获得一个单例对象了。如果我们真的想要一个单例类，可以考虑这样做：
mysingleton.py
class Singleton(object):
def foo(self):
pass
singleton = Singleton()将上面的代码保存在文件 mysingleton.py 中，要使用时，直接在其他文件中导入此文件中的对象，这个对象即是单例模式的对象
from a import singleton2.2 使用装饰器decorator
这是一种更pythonic，更elegant的方法，单例类本身根本不知道自己是单例的，因为他自己的代码并不是单例的。
def Singleton(cls):
_instance = {}
def _singleton(*args, **kargs):
if cls not in _instance:
_instance[cls] = cls(*args, **kargs)
return _instance[cls]
return _singleton
@Singleton
class A(object):
a = 1
def __init__(self, x = 0):
self.x = x
a1 = A(2)
a2 = A(3)
print(a1.x) # 2
print(a2.x) # 依旧是 2
print(a1 is a2) # True2.3 使用类方法 @classmethod
classmethod 修饰符对应的函数不需要实例化，不需要 self 参数，但第一个参数需要是表示自身类的 cls 参数，可以被类直接调用，可以使用类的属性。
class Singleton():
def __init__(self, x):
self.x = x
@classmethod
def instance(cls, *args, **kargs):
if not hasattr(cls, "_instance"):
cls._instance = Singleton(*args, **kargs)
return cls._instance
a1 = Singleton.instance(2)
a2 = Singleton.instance(4)
print(a1 is a2) # True
print(a1.x) # 2
print(a2.x) # 依旧是 2这种方式实现的单例模式，使用时会有限制，实例化必须通过 obj = Singleton.instance() 方法。如果用 obj=Singleton() ,这种方式得到的不是单例。
一般情况，大家以为这样就完成了单例模式，但是这样当使用多线程时会存在问题。
class Singleton(object):
def __init__(self):
pass
@classmethod
def instance(cls, *args, **kargs):
if not hasattr(cls, "_instance"):
cls._instance = Singleton(*args, **kargs)
return cls._instance
import threading
def task(arg):
obj = Singleton.instance()
print(obj)
for i in range(10):
t = threading.Thread(target=task,args=[i,])
t.start()输出 ：
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>
<__main__.Singleton object at 0x000001A41D38DDA0>看起来也没有问题，那是因为执行速度过快，如果在init方法中有一些IO操作，就会发现问题了，下面我们通过time.sleep模拟。
我们在上面init方法中加入以下代码：
def __init__(self):
import time
time.sleep(1)重新执行程序后，结果如下：
<__main__.Singleton object at 0x00000277C22B67B8>
<__main__.Singleton object at 0x00000277C22B6898>
<__main__.Singleton object at 0x00000277C2291C50>
<__main__.Singleton object at 0x00000277C2301400>
<__main__.Singleton object at 0x00000277C2301D30>
<__main__.Singleton object at 0x00000277C23015C0>
<__main__.Singleton object at 0x00000277C22BF470>
<__main__.Singleton object at 0x00000277C23014A8>
<__main__.Singleton object at 0x00000277C230B7F0>
<__main__.Singleton object at 0x00000277C230B8D0>可以看出来，以上的方法无法支持多线程。
解决办法：加锁！未加锁部分并发执行,加锁部分串行执行,速度降低,但是保证了数据安全。
import time
import threading
class Singleton(object):
_instance_lock = threading.Lock()
def __init__(self):
time.sleep(1)
@classmethod
def instance(cls, *args, **kwargs):
with cls._instance_lock:
if not hasattr(cls, "_instance"):
cls._instance = Singleton(*args, **kwargs)
return cls._instance
def task(arg):
obj = Singleton.instance()
print(obj)
for i in range(10):
t = threading.Thread(target=task,args=[i,])
t.start()
time.sleep(20)
obj = Singleton.instance()
print(obj)打印结果如下：
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>
<__main__.Singleton object at 0x000001F0F817CA58>这样就差不多了，但是还是有一点小问题，就是当程序执行时，执行了time.sleep(20)后，下面实例化对象时，此时已经是单例模式了，但我们还是加了锁，这样不太好，再进行一些优化，把intance方法，改成下面的这样就行：
@classmethod
def instance(cls, *args, **kwargs):
if not hasattr(Singleton, "_instance"):
with Singleton._instance_lock:
if not hasattr(Singleton, "_instance"):
Singleton._instance = Singleton(*args, **kwargs)
return Singleton._instance这样，一个可以支持多线程的单例模式就完成了。完整代码：
import time
import threading
class Singleton(object):
_instance_lock = threading.Lock()
def __init__(self):
time.sleep(1)
@classmethod
def instance(cls, *args, **kwargs):
if not hasattr(Singleton, "_instance"):
with Singleton._instance_lock:
if not hasattr(Singleton, "_instance"):
Singleton._instance = Singleton(*args, **kwargs)
return Singleton._instance
def task(arg):
obj = Singleton.instance()
print(obj)
for i in range(10):
t = threading.Thread(target=task,args=[i,])
t.start()
time.sleep(20)
obj = Singleton.instance()
print(obj)2.4 基于 __new__ 方法实现（推荐，方便）
通过上面例子，我们可以知道，当我们实现单例时，为了保证线程安全需要在内部加入锁。
我们知道，当我们实例化一个对象时，是先执行了类的__new__方法（我们没写时，默认调用object.__new__），实例化对象；然后再执行类的__init__方法，对这个对象进行初始化，所有我们可以基于这个，实现单例模式。
import threading
class Singleton(object):
_instance_lock = threading.Lock()
def __init__(self):
pass
def __new__(cls, *args, **kwargs):
if not hasattr(Singleton, "_instance"):
with Singleton._instance_lock:
if not hasattr(Singleton, "_instance"):
Singleton._instance = object.__new__(cls)
return Singleton._instance
obj1 = Singleton()
obj2 = Singleton()
print(obj1,obj2)
def task(arg):
obj = Singleton()
print(obj)
for i in range(10):
t = threading.Thread(target=task,args=[i,])
t.start()打印结果：
<__main__.Singleton object at 0x038B33D0> <__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>
<__main__.Singleton object at 0x038B33D0>采用这种方式的单例模式，以后实例化对象时，和平时实例化对象的方法一样 obj = Singleton() 。
2.5 基于metaclass方式实现
- 类由type创建，创建类时，type的init方法自动执行，类() 执行type的 call方法(类的new方法,类的init方法)
- 对象由类创建，创建对象时，类的init方法自动执行，对象()执行类的 call 方法
例子：
class Foo:
def __init__(self):
pass
def __call__(self, *args, **kwargs):
pass
obj = Foo()
# 执行type的 __call__ 方法，调用 Foo类（是type的对象）的 __new__方法，用于创建对象，然后调用 Foo类（是type的对象）的 __init__方法，用于对对象初始化。
obj() # 执行Foo的 __call__ 方法现在是python较深层次的内容。
元类的使用：
class SingletonType(type):
def __init__(self,*args,**kwargs):
print('先创造类')
super().__init__(*args,**kwargs)
def __call__(cls, *args, **kwargs): # 这里的cls，即Foo类
print('cls',cls)
obj = cls.__new__(cls,*args, **kwargs)
cls.__init__(obj,*args, **kwargs) # Foo.__init__(obj)
return obj
class Foo(metaclass=SingletonType): # 指定创建Foo的type为SingletonType
def __init__(self, name):
print('再创造对象')
self.name = name
def __new__(cls, *args, **kwargs):
return object.__new__(cls)
obj = Foo('xx')输出：
先创造类
cls <class '__main__.Foo'>
再创造对象注意这里面的逻辑，Foo 类由 SingletonType 类创建，创建 Foo 类时，SingletonType 的__init__方法自动执行，Foo( ) 执行 SingletonType 的 __call__方法（里面执行 Foo 类的__new__方法，Foo 类的__init__方法）。obj 对象由 Foo 类创建，创建对象时，Foo 类的__init__方法自动执行，obj( ) 执行类的 __call__ 方法。
实现单例模式
import threading
class SingletonType(type):
_instance_lock = threading.Lock()
def __call__(cls, *args, **kwargs):
if not hasattr(cls, "_instance"):
with SingletonType._instance_lock:
if not hasattr(cls, "_instance"):
cls._instance = super().__call__(*args, **kwargs)
return cls._instance
class Foo(metaclass=SingletonType):
def __init__(self,name):
self.name = name
def task(arg):
obj = Foo('name')
print(obj)
for i in range(10):
t = threading.Thread(target=task,args=[i,])
t.start()输出：
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>
<__main__.Foo object at 0x00000171D81BB710>成功！
2.6 共享属性
网上还有一种共享属性的做法，就是一个类可以创造多个实例，通过__dict__属性指向（引用）同一个字典（dict）。代码如下
class Borg(object):
_state = {}
def __new__(cls, *args, **kwargs):
ob = super(Borg, cls).__new__(cls, *args, **kwargs)
ob.__dict__ = cls._state
return ob
class MyClass2(Borg):
a = 1
one = MyClass2()
two = MyClass2()
two.a = 3
print(one.a)
# one 和 two 是两个不同的对象，id，==，is对比结果可以看出
print(id(one)) # 18410480
print(id(two)) # 18410512
print(one == two) # False
print(one is two) # False
# 但是one和two具有相同的（同一个）__dict__属性
print(id(one.__dict__)) # 14194768
print(id(two.__dict__)) # 14194768但是我感觉不是严格意义上的单例模式，毕竟是两个实例，开辟了两个内存空间。
3 推荐阅读
(1) python装饰器大详解
(2) python ——面向对象进阶（反射，双下线方法，静态方法，类方法)
(3) 剑指offer python 实现
(4) Python: super 没那么简单