单例模式及其实现
单例模式
单例模式(Singleton Pattern)是一种常用的软件设计模式,该模式的主要目的是确保某一个类只有一个实例存在。当你希望在整个系统中,某个类只能出现一个实例时,单例对象就能派上用场。
比如,某个服务器程序的配置信息存放在一个文件中,客户端通过一个 AppConfig 的类来读取配置文件的信息。如果在程序运行期间,有很多地方都需要使用配置文件的内容,也就是说,很多地方都需要创建 AppConfig 对象的实例,这就导致系统中存在多个 AppConfig 的实例对象,而这样会严重浪费内存资源,尤其是在配置文件内容很多的情况下。事实上,类似 AppConfig 这样的类,我们希望在程序运行期间只存在一个实例对象。
在 Python 中,我们可以用多种方法来实现单例模式
### 实现单例模式的几种方式
使用模块导入机制
其实,Python 的模块就是天然的单例模式,因为模块在第一次导入时,会生成 .pyc
文件,当第二次导入时,就会直接加载 .pyc
文件,而不会再次执行模块代码。因此,我们只需把相关的函数和数据定义在一个模块中,就可以获得一个单例对象了。如果我们真的想要一个单例类,可以考虑这样做:
新建一个mysingleton.py,写入如下代码:
class Singleton(object):
def foo(self):
pass
singleton = Singleton()
使用时直接在其他文件中导入singleton对象,这个对象即是单例模式的对象
from mysingleton import singleton
这种方式很常见,Django的admin组件里就采用了这种方法实现单例模式的
#### 使用装饰器
使用装饰器也可以实现单例模式
def singleton(cls):
_instance = {}
def _singleton(*args, **kwargs):
if cls not in _instance:
_instance[cls] = cls(*args, **kwargs)
return _instance[cls]
return _singleton
@singleton
class Vector(object):
def __init__(self, x=0, y=0):
self.x = x
self.y = y
def __repr__(self):
return "Vector(%s, %s)" % (self.x, self.y)
v1 = Vector(1, 2)
v2 = Vector(2, 3)
print(v1 is v2) # True
如果有多个类需要用到单例模式,可以考虑使用装饰器
#### 使用类
在类里面定义一个类方法或静态方法,也可以实现单例模式
class Singleton(object):
def __init__(self, *args, **kwargs):
pass
@classmethod
def get_instance(cls, *args, **kwargs):
if not hasattr(cls, "_instance"):
cls._instance = cls(*args, **kwargs)
return cls._instance
s1 = Singleton.get_instance()
s2 = Singleton.get_instance()
print(s1 is s2) # True
这样虽然实现了单例模式,但是使用多线程时又存在问题
多线程下
import threading
class Singleton(object):
def __init__(self, *args, **kwargs):
pass
@classmethod
def get_instance(cls, *args, **kwargs):
if not hasattr(cls, "_instance"):
cls._instance = cls(*args, **kwargs)
return cls._instance
def task():
obj = Singleton.get_instance()
print(obj)
for i in range(10):
t = threading.Thread(target=task)
t.start()
执行结果
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
<__main__.Singleton object at 0x000002646E5DE7B8>
看起来也没有问题,这是因为执行速度太快,如果在`__init__`方法里面加入一些IO操作,就会发现问题,下面我们通过time.sleep模拟
def __init__(self, *args, **kwargs):
import time
time.sleep(0.01)
再次执行,结果如下:
<__main__.Singleton object at 0x00000281A6ACF828>
<__main__.Singleton object at 0x00000281A6AE8940>
<__main__.Singleton object at 0x00000281A6AE8A20>
<__main__.Singleton object at 0x00000281A6B31710>
<__main__.Singleton object at 0x00000281A6B31748>
<__main__.Singleton object at 0x00000281A6B317B8>
<__main__.Singleton object at 0x00000281A6AF0630>
<__main__.Singleton object at 0x00000281A6B3D978>
<__main__.Singleton object at 0x00000281A6B31E10>
<__main__.Singleton object at 0x00000281A6B3DA58>
可以看到,10个线程获取到的不是同一个单例对象!因此,按照上述方式创建的单例不支持多线程!
解决办法:加锁
import threading
class Singleton(object):
_instance_lock = threading.Lock()
def __init__(self, *args, **kwargs):
import time
time.sleep(0.01)
@classmethod
def get_instance(cls, *args, **kwargs):
# 加锁,保证每次只有一个线程能够实例化对象
with cls._instance_lock:
if not hasattr(cls, "_instance"):
cls._instance = cls(*args, **kwargs)
return cls._instance
def task():
obj = Singleton.get_instance()
print(obj)
for i in range(10):
t = threading.Thread(target=task)
t.start()
执行程序,结果如下:
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
<__main__.Singleton object at 0x0000019581A4D860>
到现在为止,我们已经实现了多线程环境下的单例模式,但是这里还有一个小瑕疵,就是我们必须通过Singleton.get_instance()
是方式获取实例,也就是说,直接用Singleton()
得到的不是单例对象
#### 使用`__new__`方法(推荐使用)
import threading
class Singleton(object):
_instance = None
_instance_lock = threading.Lock()
def __init__(self, *args, **kwargs):
import time
time.sleep(0.1)
def __new__(cls, *args, **kwargs):
# 同样,使用__new__也必须加锁
with cls._instance_lock:
if cls._instance is None:
cls._instance = object.__new__(cls)
return cls._instance
def task(arg):
obj = Singleton()
print(obj)
for i in range(1000):
t = threading.Thread(target=task, args=(i, ))
t.start()