python-单例模式-实现

发表于 | in | | 访客

单例模式（Singleton Pattern）是一种常用的软件设计模式，该模式的主要目的是确保某一个类只有一个实例存在。当你希望在整个系统中，某个类只能出现一个实例时，单例对象就能派上用场。

比如，某个服务器程序的配置信息存放在一个文件中，客户端通过一个 AppConfig 的类来读取配置文件的信息。如果在程序运行期间，有很多地方都需要使用配置文件的内容，也就是说，很多地方都需要创建 AppConfig 对象的实例，这就导致系统中存在多个 AppConfig 的实例对象，而这样会严重浪费内存资源，尤其是在配置文件内容很多的情况下。事实上，类似 AppConfig 这样的类，我们希望在程序运行期间只存在一个实例对象。

使用模块

Python 的模块就是天然的单例模式，因为模块在第一次导入时，会生成 .pyc 文件，当第二次导入时，就会直接加载 .pyc 文件，而不会再次执行模块代码。因此，我们只需把相关的函数和数据定义在一个模块中，就可以获得一个单例对象了。如果我们真的想要一个单例类，可以考虑这样做：
mysingleton.py:

1
2
3
4
5
class Singleton(object):
    def foo(self):
        pass
singleton = Singleton()

将上面的代码保存在文件 mysingleton.py 中，要使用时，直接在其他文件中导入此文件中的对象，这个对象即是单例模式的对象:

1
from a import singleton

使用装饰器

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
def Singleton(cls):
  _instance = {}
  def _singleton(*args, **kwargs):
    if cls not in _instance:
        _instance[cls] = cls(*args, **kwargs)
    return _instance[cls]
  return _singleton
@Singletone
class A(object):
  def __init__(self, x=0):
    self.x = x
a1 = A(2)
print a1    ## <__main__.A object at 0x7fb47be6c090>
a2 = A(3)
print a2    ## <__main__.A object at 0x7fb47be6c090>

基于new方法实现

当我们实例化一个对象时，是先执行了类的new方法（我们没写时，默认调用object.new），实例化对象；然后再执行类的init方法，对这个对象进行初始化，所有我们可以基于这个，实现单例模式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
import threading
class Singleton(object):
  _instance_lock = threading.Lock()
  def __init__(self):
    pass
  def __new__(cls, *args, **kwargs):
    if not hasattr(Singleton, "_instance"):  # 多加一层判断，是避免后续的调用一直对该对象有锁，如果_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()

打印结果如下：

1
2
3
4
5
6
7
8
9
10
11
(<__main__.Singleton object at 0x7f5829b3d410>, <__main__.Singleton object at 0x7f5829b3d410>)
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>
<__main__.Singleton object at 0x7f5829b3d410>

基于metaclass方式实现

相关知识

  • 类由type创建，创建类时，type的__init__方法自动执行，类() 执行type的 __call__方法(类的__new__方法,类的__init__方法)
  • 对象由类创建，创建对象时，类的__init__方法自动执行，对象()执行类的 __call__ 方法
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    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__ 方法

元类使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class SingletonType(type):
    def __init__(self,*args, **kwargs):
        super(SingletonType, self).__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(object): # 指定创建Foo的type为SingletonType
    __metaclass__ = SingletonType
    def __init__(self, name):
        self.name = name
    def __new__(cls, *args, **kwargs):
        return object.__new__(cls)
obj = Foo('xx')

实现单例模式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import threading
class SingletonType(type):
    _instance_lock = threading.Lock()
    def __call__(cls, *args, **kwargs):
        if not hasattr(cls, "_instance"):
            with SingletonType._instance_lock:
                cls._instance = super(SingletonType,cls).__call__(*args, **kwargs)
        return cls._instance
class Foo(object):
    __metaclass__ = SingletonType  # 指定创建Foo的type为SingletonType
    def __init__(self, name):
        self.name = name
obj1 = Foo('name')
obj2 = Foo('name')
print(obj1, obj2)

在python中，类的行为就是这样，new、init、call等方法不是必须写的，会默认调用，如果自己定义了，就是override,可以custom。既然override了，通常也会显式调用进行补偿以达到extend的目的。

参考：Python中的单例模式的几种实现方式的及优化