设计模式之单例模式与工厂模式的Python实现

Posted 2021-01-07 青山牧云人

1. 单例模式

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

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

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

1.1 使用模块（不推荐）

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

mysingleton.py

class Singleton(object):
    def foo(self):
        pass
singleton = Singleton()

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

from mysingleton import singleton

对这种使用模块来实现单例模式的方法，只能在一些特定场景中使用（比如初始化一个config），因为不好修改和维护。比如如果我想在代码运行过程中，根据实时的参数生成一个单例，这种方法就不好用了。

1.2 使用装饰器(不考虑多线程影响时可以使用)

>>> def Singleton(cls):
    _instance = {}
    def _singleton(*args,**kw):
        if cls not in _instance:
            _instance[cls] = cls(*args,**kw)
        return _instance[cls]
    return _singleton

>>> @Singleton
class A(object):
    a = 1
    def __init__(self,x = 0):
        self.x = x

        
>>> a1 = A(2)
>>> a1
<__main__.A object at 0x000000893F3B0630>
>>> a1.x
2
>>> a2 = A(3)
>>> a2
<__main__.A object at 0x000000893F3B0630>
>>> a2.x
2

有几个知识点值得注意：

<1> 装饰器不仅可以装饰函数，也可以用来装饰类

<2> 我们通过查看生成的对象a1和a2，发现他们的内存地址都是一样的，是"0x000000893F3B0630",因此可以看出来是同一个对象，即验证了我们的单例模式是成功的

<3> 执行a2 = A(3)，我们可以看到a2.x = 2,而不是3。 这是因为正常情况下语句a2 = A(3)会调用__init__函数，将3传给x。但是由于我们是单例模式，a2 = A(3)并不会生成新的对象，而是将之前生成的a1的对象返回给了a2，因为__init__函数只有在生成新的对象时才会执行，所以a2.x = 2

但是这样的实现方式是有漏洞的，当在多进程运行情况下，一旦__init__函数中有些耗时比较长的操作，会发生下面的情况：进程a和进程b同时执行，如果此时实例并没有被生成，a和b会同时尝试去生成实例，并且由于__init__耗时较长，a和b在生成实例时，都没有现成的实例，就会造成a和b生成了不同的实例，我们的单例模式就失败了。

下面是例子

>>> def Singleton(cls):
    @functools.wrap(cls)
    _instance = {}
    def wrapper(*args,**kw):
        if cls not in _instance:
            _instance[cls] = cls(*args,**kw)
        return _instance[cls]
    return wrapper

>>> import time
>>> @Singleton
class A(object):
    a = 1
    def __init__(self,x = 0):
        time.sleep(2)
        self.x = x

>>> import threading

>>> def task(arg):
    obj = A(arg)
    print(obj, obj.x)

>>> for i in range(10):
    t = threading.Thread(target = task, args=[i,])
    t.start()

    
>>> <__main__.A object at 0x000000893F5F8D30><__main__.A object at 0x000000893F5F82B0><__main__.A object at 0x000000893F5F8B38><__main__.A object at 0x000000893FBE4358><__main__.A object at 0x000000893FBE4160><__main__.A object at 0x000000893F5F8F28><__main__.A object at 0x000000893F5F8940><__main__.A object at 0x000000893FBE4550><__main__.A object at 0x000000893FBE4940><__main__.A object at 0x000000893FBE4748>          3026541798

通过这些实例的地址我们可以看出来，这也instance是不同的实例，我们的单例模式失败了

1.3 使用类(基于__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()

值得注意的是类的实现中有两个判断：

第一个判断，是为了当单例对象生成后，不再锁多进程

第二个判断，是为了当单例对象还未生成时，确保只有一个对象被生成。（如果没有这一层判断，当对象被第一个进程生成后，后续的进程还会生成新的对象）

下面是例子：
只有一个判断，生成了多个实例。单例失败。

>>> class Singleton(object):
    _instance_lock = threading.Lock()
    def __init__(self):
        time.sleep(1)
    @classmethod
    def instance(cls,*args,**kw):
        if not hasattr(Singleton,"_instance"):
            with Singleton._instance_lock:
                Singleton._instance = Singleton(*args,**kw)
        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()

    
>>> <__main__.Singleton object at 0x000000893F5F8B38>
<__main__.Singleton object at 0x000000893FBE44A8>
<__main__.Singleton object at 0x000000893F5F8A90>
<__main__.Singleton object at 0x000000893F5F8E10>
<__main__.Singleton object at 0x000000893F5F87B8>
<__main__.Singleton object at 0x000000893F5F8C18>
<__main__.Singleton object at 0x000000893F5F8A90>
<__main__.Singleton object at 0x000000893F5F8710>
<__main__.Singleton object at 0x000000893F5F8BA8>
<__main__.Singleton object at 0x000000893F5F8E10>

有两个判断，只生成了一个实例，单例成功

>>> class Singleton(object):
    _instance_lock = threading.Lock()
    def __init__(self):
        time.sleep(1)
    @classmethod
    def instance(cls,*args,**kw):
        if not hasattr(Singleton,"_instance"):
            with Singleton._instance_lock:
                if not hasattr(Singleton,"_instance"):
                    Singleton._instance = Singleton(*args,**kw)
        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()

    
>>> <__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90><__main__.Singleton object at 0x000000893F5F8A90>

 

我们需要特别注意的是，这种实现方法也不好，因为是在单例模式的实现代码，写在了类的实现里。我们每要实现一个单例模式的类，就要在类的定义里写相应的代码。这样没有把设计模式和类的具体实现分离。

1.4 基于元类(metaclass)实现（推荐）

关于元类的知识点，可以参考我之前写的博文： 谈谈Python中元类Metaclass(一)：什么是元类

以下是几个关键的知识点：

• 简而言之，metaclass是元类，用来动态创建class，在创建时根据metaclass的定义（比如__new__, __call__, __init__）控制。
• __new__()函数用来创建类的实例，__call__()函数是能让实例可以被调用，__init__()函数用来对实例做一些初始化操作。从上而下看，在基于元类实现单例模式时，从属关系为 metaclass元类 --> 我们定义的class类(暂命名为\'A\') --> 实现的单例对象\'a\'；即我们定义的class \'A\'是元类metaclass的对象，我们实现的单例对象\'a\'是定义的class \'A\'的对象。而我们知道，单例对象创建时的语句是a=A(),也就是说，在这个语句执行时，我们调用的是A, 而控制A调用行为的函数，实际上是metaclass的__call__函数。因此我们要在__call__()函数中实现单例模式。

>>> import time
>>> 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(SingletonType,cls).__call__(*args, **kwargs)
        return cls._instance

>>> class Foo(metaclass=SingletonType):
    def __init__(self,name):
        self.name = name
        time.sleep(1)

        
>>> def task(arg):
    obj = Foo(arg)
    print(obj,obj.name)

    
>>> for i in range(10):
    t = threading.Thread(target=task,args=[i,])
    t.start()

    
>>> <__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8><__main__.Foo object at 0x000000893F5F87B8>          0000000000

这样，我们就完美的实现了单例模式，同时将达成了更优的目的：单例模式这个设计模式与类的定义分开。

 

参考链接：

1. 飘逸的python - __new__、__init__、__call__傻傻分不清: https://blog.csdn.net/handsomekang/article/details/46672251

2. Python中的单例模式的几种实现方式的及优化