Singleton

单例模式

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

在 Python 中,我们可以用多种方法来实现单例模式:

  • 使用模块
  • 使用 __new__
  • 使用装饰器(decorator)
  • 使用元类(metaclass)

使用模块

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

1
2
3
4
5
6
7
8
9
# mysingleton.py

class My_Singleton(object):

def foo(self):

pass

my_singleton = My_Singleton()

将上面的代码保存在文件 mysingleton.py 中,然后这样使用:

1
2
3
from mysingleton import my_singleton

my_singleton.foo()

使用__new__

为了使类只能出现一个实例,我们可以使用 __new__ 来控制实例的创建过程,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class Singleton(object):

​ _instance = None

def __new\_\_(cls,*args, **kw):

if not cls._instance:

​ cls._instance = **super**(Singleton, cls).\_\_new__(cls, *args, **kw)

return cls.__instance

class MyClass(Singleton):

​ a = 1

在上面的代码中,我们将类的实例和一个类变量 _instance 关联起来,如果 cls._instance 为 None 则创建实例,否则直接返回 cls._instance

执行情况如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
>>> one = MyClass()

>>> two = MyClass()

>>> one == two

True

>>> one is two

True

>>> id(one), id(two)

(4303862608, 4303862608)

使用装饰器

装饰器(decorator)可以动态地修改一个类或函数的功能。

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
26
27
from functools import wraps



def singleton(cls):

​ instances = {}

​ @wraps(cls)

def getinstance(*args,**kw):

if cls not in instances:

​ instances[cls] = cls(*args,**kw)

return instances[cls]

return getinstance



@singleton

**class** MyClass(**object**):

​ a = 1

使用 metaclass

元类(metaclass)可以控制类的创建过程,它主要做三件事:

  • 拦截类的创建
  • 修改类的定义
  • 返回修改后的类

使用元类实现单例模式的代码如下:

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
26
27
class** Singleton(type):

​ _instances = {}

def __call__(cls, *args, **kwargs):

​ **if** cls **not** **in** cls._instances:

​ cls._instances[cls] = **super**(Singleton, cls).__call__(*args, **kwargs)

​ **return** cls._instances[cls]



\# Python2

**class** MyClass(**object**):

​ __metaclass__ = Singleton



\# Python3

\# class MyClass(metaclass=Singleton):

\# pass

小结

Python 的模块是天然的单例模式,这在大部分情况下应该是够用的,我们也可以使用装饰器、__new__等方法

-------------本文结束-------------