• Python 实现单例模式的五种写法

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

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

    事实上，类似 AppConfig 这样的类，我们希望在程序运行期间只存在一个实例对象。

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

    1. 使用模块

    2. 使用装饰器

    3. 使用类

    4. 基于 __new__ 方法实现

    5. 基于 metaclass 方式实现

    下面来详细介绍：

    使用模块

    其实，Python 的模块就是天然的单例模式，因为模块在第一次导入时，会生成 .pyc 文件，当第二次导入时，就会直接加载 .pyc 文件，而不会再次执行模块代码。

    因此，我们只需把相关的函数和数据定义在一个模块中，就可以获得一个单例对象了。

    如果我们真的想要一个单例类，可以考虑这样做：

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

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

    from mysingleton import singleton

    使用装饰器

    1. def Singleton(cls):
    2.     _instance = {}
    3.  
    4.     def _singleton(*args, **kargs):
    5.         if cls not in _instance:
    6.             _instance[cls] = cls(*args, **kargs)
    7.         return _instance[cls]
    8.  
    9.     return _singleton
    10.  
    11.  
    12. @Singleton
    13. class A(object):
    14.     a = 1
    15.  
    16.     def __init__(self, x=0):
    17.         self.x = x
    18.  
    19.  
    20. a1 = A(2)
    21. a2 = A(3)

    使用类

    1. class Singleton(object):
    2.  
    3.     def __init__(self):
    4.         pass
    5.  
    6.     @classmethod
    7.     def instance(cls, *args, **kwargs):
    8.         if not hasattr(Singleton, "_instance"):
    9.             Singleton._instance = Singleton(*args, **kwargs)
    10.         return Singleton._instance

    一般情况，大家以为这样就完成了单例模式，但是当使用多线程时会存在问题：

    1. class Singleton(object):
    2.  
    3.     def __init__(self):
    4.         pass
    5.  
    6.     @classmethod
    7.     def instance(cls, *args, **kwargs):
    8.         if not hasattr(Singleton, "_instance"):
    9.             Singleton._instance = Singleton(*args, **kwargs)
    10.         return Singleton._instance
    11.  
    12. import threading
    13.  
    14. def task(arg):
    15.     obj = Singleton.instance()
    16.     print(obj)
    17.  
    18. for i in range(10):
    19.     t = threading.Thread(target=task,args=[i,])
    20.     t.start()

    程序执行后，打印结果如下：

    1. <__main__.Singleton object at 0x02C933D0>
    2. <__main__.Singleton object at 0x02C933D0>
    3. <__main__.Singleton object at 0x02C933D0>
    4. <__main__.Singleton object at 0x02C933D0>
    5. <__main__.Singleton object at 0x02C933D0>
    6. <__main__.Singleton object at 0x02C933D0>
    7. <__main__.Singleton object at 0x02C933D0>
    8. <__main__.Singleton object at 0x02C933D0>
    9. <__main__.Singleton object at 0x02C933D0>
    10. <__main__.Singleton object at 0x02C933D0>

    看起来也没有问题，那是因为执行速度过快，如果在 __init__ 方法中有一些 IO 操作，就会发现问题了。

    下面我们通过 time.sleep 模拟，我们在上面 __init__ 方法中加入以下代码：

    1. def __init__(self):
    2.     import time
    3.     time.sleep(1)

    重新执行程序后，结果如下：

    1. <__main__.Singleton object at 0x034A3410>
    2. <__main__.Singleton object at 0x034BB990>
    3. <__main__.Singleton object at 0x034BB910>
    4. <__main__.Singleton object at 0x034ADED0>
    5. <__main__.Singleton object at 0x034E6BD0>
    6. <__main__.Singleton object at 0x034E6C10>
    7. <__main__.Singleton object at 0x034E6B90>
    8. <__main__.Singleton object at 0x034BBA30>
    9. <__main__.Singleton object at 0x034F6B90>
    10. <__main__.Singleton object at 0x034E6A90>

    问题出现了！按照以上方式创建的单例，无法支持多线程。

    解决办法：加锁！未加锁部分并发执行，加锁部分串行执行，速度降低，但是保证了数据安全。

    1. import time
    2. import threading
    3.  
    4.  
    5. class Singleton(object):
    6.     _instance_lock = threading.Lock()
    7.  
    8.     def __init__(self):
    9.         time.sleep(1)
    10.  
    11.     @classmethod
    12.     def instance(cls, *args, **kwargs):
    13.         with Singleton._instance_lock:
    14.             if not hasattr(Singleton, "_instance"):
    15.                 Singleton._instance = Singleton(*args, **kwargs)
    16.         return Singleton._instance
    17.  
    18.  
    19. def task(arg):
    20.     obj = Singleton.instance()
    21.     print(obj)
    22.     
    23.  
    24. for i in range(10):
    25.     t = threading.Thread(target=task,args=[i,])
    26.     t.start()
    27.  
    28.  
    29. time.sleep(20)
    30. obj = Singleton.instance()
    31. print(obj)

    打印结果如下：

    1. <__main__.Singleton object at 0x02D6B110>
    2. <__main__.Singleton object at 0x02D6B110>
    3. <__main__.Singleton object at 0x02D6B110>
    4. <__main__.Singleton object at 0x02D6B110>
    5. <__main__.Singleton object at 0x02D6B110>
    6. <__main__.Singleton object at 0x02D6B110>
    7. <__main__.Singleton object at 0x02D6B110>
    8. <__main__.Singleton object at 0x02D6B110>
    9. <__main__.Singleton object at 0x02D6B110>
    10. <__main__.Singleton object at 0x02D6B110>

    这样就差不多了，但是还是有一点小问题，就是当程序执行时，执行了 time.sleep(20) 后，下面实例化对象时，此时已经是单例模式了。

    但我们还是加了锁，这样不太好，再进行一些优化，把 intance 方法，改成下面这样就行：

    1. @classmethod
    2. def instance(cls, *args, **kwargs):
    3.     if not hasattr(Singleton, "_instance"):
    4.         with Singleton._instance_lock:
    5.             if not hasattr(Singleton, "_instance"):
    6.                 Singleton._instance = Singleton(*args, **kwargs)
    7.     return Singleton._instance

    这样，一个可以支持多线程的单例模式就完成了。+

    1. import time
    2. import threading
    3.  
    4.  
    5. class Singleton(object):
    6.     _instance_lock = threading.Lock()
    7.  
    8.     def __init__(self):
    9.         time.sleep(1)
    10.  
    11.     @classmethod
    12.     def instance(cls, *args, **kwargs):
    13.         if not hasattr(Singleton, "_instance"):
    14.             with Singleton._instance_lock:
    15.                 if not hasattr(Singleton, "_instance"):
    16.                     Singleton._instance = Singleton(*args, **kwargs)
    17.         return Singleton._instance
    18.  
    19.  
    20. def task(arg):
    21.     obj = Singleton.instance()
    22.     print(obj)
    23.     
    24.     
    25. for i in range(10):
    26.     t = threading.Thread(target=task,args=[i,])
    27.     t.start()
    28.     
    29.     
    30. time.sleep(20)
    31. obj = Singleton.instance()
    32. print(obj)

    这种方式实现的单例模式，使用时会有限制，以后实例化必须通过 obj = Singleton.instance()

    如果用 obj = Singleton()，这种方式得到的不是单例。

    基于 __new__ 方法实现

    通过上面例子，我们可以知道，当我们实现单例时，为了保证线程安全需要在内部加入锁。

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

    1. import threading
    2.  
    3.  
    4. class Singleton(object):
    5.     _instance_lock = threading.Lock()
    6.  
    7.     def __init__(self):
    8.         pass
    9.  
    10.  
    11.     def __new__(cls, *args, **kwargs):
    12.         if not hasattr(Singleton, "_instance"):
    13.             with Singleton._instance_lock:
    14.                 if not hasattr(Singleton, "_instance"):
    15.                     Singleton._instance = object.__new__(cls)  
    16.         return Singleton._instance
    17.  
    18. obj1 = Singleton()
    19. obj2 = Singleton()
    20. print(obj1,obj2)
    21.  
    22. def task(arg):
    23.     obj = Singleton()
    24.     print(obj)
    25.  
    26. for i in range(10):
    27.     t = threading.Thread(target=task,args=[i,])
    28.     t.start()

    打印结果如下：

    1. <__main__.Singleton object at 0x038B33D0> <__main__.Singleton object at 0x038B33D0>
    2. <__main__.Singleton object at 0x038B33D0>
    3. <__main__.Singleton object at 0x038B33D0>
    4. <__main__.Singleton object at 0x038B33D0>
    5. <__main__.Singleton object at 0x038B33D0>
    6. <__main__.Singleton object at 0x038B33D0>
    7. <__main__.Singleton object at 0x038B33D0>
    8. <__main__.Singleton object at 0x038B33D0>
    9. <__main__.Singleton object at 0x038B33D0>
    10. <__main__.Singleton object at 0x038B33D0>
    11. <__main__.Singleton object at 0x038B33D0>

    采用这种方式的单例模式，以后实例化对象时，和平时实例化对象的方法一样 obj = Singleton() 。

    基于 metaclass 方式实现

    相关知识:

    1. 类由 type 创建，创建类时，type 的 __init__ 方法自动执行，类() 执行 type 的 __call__ 方法(类的 __new__ 方法，类的 __init__ 方法)

    2. 对象由类创建，创建对象时，类的 __init__ 方法自动执行，对象()执行类的 __call__ 方法

    例子：

    1. class Foo:
    2.     def __init__(self):
    3.         pass
    4.  
    5.     def __call__(self, *args, **kwargs):
    6.         pass
    7.  
    8. obj = Foo()
    9. # 执行type的 __call__ 方法，调用 Foo类（是type的对象）的 __new__方法，用于创建对象，然后调用 Foo类（是type的对象）的 __init__方法，用于对对象初始化。
    10.  
    11. obj()    # 执行Foo的 __call__ 方法    

    元类的使用：

    1. class SingletonType(type):
    2.     def __init__(self,*args,**kwargs):
    3.         super(SingletonType,self).__init__(*args,**kwargs)
    4.  
    5.     def __call__(cls, *args, **kwargs): # 这里的cls，即Foo类
    6.         print('cls',cls)
    7.         obj = cls.__new__(cls,*args, **kwargs)
    8.         cls.__init__(obj,*args, **kwargs) # Foo.__init__(obj)
    9.         return obj
    10.  
    11. class Foo(metaclass=SingletonType): # 指定创建Foo的type为SingletonType
    12.     def __init__(self，name):
    13.         self.name = name
    14.     def __new__(cls, *args, **kwargs):
    15.         return object.__new__(cls)
    16.  
    17. obj = Foo('xx')

    实现单例模式：

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

    【python学习】
    学Python的伙伴,欢迎加入新的交流【君羊】：740587468
    一起探讨编程知识,成为大神,群里还有软件安装包，实战案例、学习资料

  • 相关阅读:
    Linux
    OpenCloudOS 助力趣丸科技降本增效，容器化高效运行
    聊一聊JDK21-虚拟线程
    分分钟让你学会栈和队列
    全力护航！广西移动圆满完成区运会通信保障任务
    Android 跨进程通信
    LeetCode笔记：Weekly Contest 320
    《论文阅读》同情对话生成的知识桥梁 AAAI 2021
    c刷题(四）
    每日一题9.17打家劫舍2
  • 原文地址：https://blog.csdn.net/weixin_56659172/article/details/127810305