单例模式(Singleton Pattern) 是一种常用的软件设计模式,该模式的主要目的是确保某一个类只有一个实例存在。当你希望在整个系统中,某个类只能出现一个实例时,单例对象就能派上用场。
比如,某个服务器程序的配置信息存放在一个文件中,客户端通过一个 AppConfig 的类来读取配置文件的信息。如果在程序运行期间,有很多地方都需要使用配置文件的内容,也就是说,很多地方都需要创建 AppConfig 对象的实例,这就导致系统中存在多个 AppConfig 的实例对象,而这样会严重浪费内存资源,尤其是在配置文件内容很多的情况下。
事实上,类似 AppConfig 这样的类,我们希望在程序运行期间只存在一个实例对象。在 Python 中,我们可以用多种方法来实现单例模式:
- 使用模块
- 使用装饰器
- 使用类
- 基于
__new__
方法实现 - 基于 metaclass 方式实现
使用模块
使用模块其实,Python 的模块就是天然的单例模式,因为模块在第一次导入时,会生成 .pyc 文件,当第二次导入时,就会直接加载 .pyc 文件,而不会再次执行模块代码。
因此,我们只需把相关的函数和数据定义在一个模块中,就可以获得一个单例对象了。
如果我们真的想要一个单例类,可以考虑这样做:
class Singleton(object):
def foo(self):
pass
singleton = Singleton()
将上面的代码保存在文件 mysingleton.py 中,要使用时,直接在其他文件中导入此文件中的对象,这个对象即是单例模式的对象。
from mysingleton import singleton
使用装饰器
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
使用类
class Singleton(object):
def __init__(self, *args, **kwargs):
pass
@classmethod
def instance(cls, *args, **kwargs):
if not hasattr(Singleton, "_instance"):
Singleton._instance = Singleton(*args, **kwargs)
return Singleton._instance
上面是一个简单的实现,但是这个在多线程的情况下是会失效的。
import threading
import time
class Singleton(object):
def __init__(self, *args, **kwargs):
time.sleep(1)
@classmethod
def instance(cls, *args, **kwargs):
if not hasattr(Singleton, "_instance"):
Singleton._instance = Singleton(*args, **kwargs)
return Singleton._instance
def task():
obj = Singleton.instance()
print(obj)
threading.Thread(target=task).start()
threading.Thread(target=task).start()
可以通过上锁的方式实现单例模式。
import threading
import time
class Singleton(object):
instance_lock = threading.Lock()
def __init__(self, *args, **kwargs):
time.sleep(1)
@classmethod
def instance(cls, *args, **kwargs):
# 如果对象已经创建了,就没必要再加锁了,避免锁竞争造成等待
if hasattr(Singleton, "_instance"):
return Singleton._instance
with cls.instance_lock:
if not hasattr(Singleton, "_instance"):
Singleton._instance = Singleton(*args, **kwargs)
return Singleton._instance
def task():
obj = Singleton.instance()
print(obj)
threading.Thread(target=task).start()
threading.Thread(target=task).start()
这种方式有一定的缺陷,需要特定的创建方式。
基于 __new__
方法实现
import threading
import time
class Singleton(object):
_instance = None
instance_lock = threading.Lock()
def __init__(self, *args, **kwargs):
time.sleep(1)
def __new__(cls, *args, **kwargs):
if cls._instance:
return cls._instance
with cls.instance_lock:
cls._instance = object.__new__(cls)
return cls._instance
def task():
obj = Singleton()
print(obj)
threading.Thread(target=task).start()
threading.Thread(target=task).start()
基于 metaclass 方式实现
import threading
import time
class SingletonType(type):
_instances = {}
instance_lock = threading.Lock()
def __call__(cls, *args, **kwargs):
if cls in cls._instances:
return cls._instances[cls]
with cls.instance_lock:
# 可能都经过了是否存在的判断,但是先拿到锁的那个线程已经创建了
# 这里再判断一次,避免重复创建
if cls not in cls._instances:
instance = super().__call__(*args, **kwargs)
cls._instances[cls] = instance
return cls._instances[cls]
class Singleton(metaclass=SingletonType):
def __init__(self):
print("-----")
time.sleep(1)
def task():
obj = Singleton()
print(obj)
threading.Thread(target=task).start()
threading.Thread(target=task).start()