Python实现单例模式的几种方式

6,577 阅读5分钟

这是我参与8月更文挑战的第8天,活动详情查看:8月更文挑战

认识单例模式

含义

单例模式是一种常用的软件设计模式,在应用这个模式时,类只会生成一个实例对象。
换句话说,单例模式确保某个类有且仅有一个实例,而且自行实例化并向整个系统提供这个实例,当我们在程序中的不同位置调用这个类进行实例化,如果类的实例不存在,会创建一个实例;如果已存在就会返回这个实例。
比如回收站就是单例模式的应用,我们电脑桌面上都有一个回收站,在整个操作系统中,回收站只能有一个实例,整个系统都是使用这个唯一的实例。

优点

  • 因为单例模式在全局内只有一个实例,因此可以节省比较多的内存空间。
  • 全局只有一个接入点,可以更好地进行数据同步控制,避免多重占用。

Python实现单例模式

使用装饰器方式实现

函数装饰器方式
def singleton(cls):

    # 创建一个字典用来保存被装饰类的实例对象 _instance = {}
    def _singleton(*args, **kwargs):
        # 判断这个类有没有创建过对象,没有新创建一个,有则返回之前创建的  
        if cls not in _instance:
            _instance[cls] = cls(*args, **kwargs)
        return _instance[cls]
    return _singleton

@singleton
class A(object):
    def __init__(self, a=0):
        self.a = a


a1 = A(1)
a2 = A(2)
# id()函数可以获取对象的内存地址,同一内存地址即为同一对象
print(id(a1), id(a2))
类装饰器方式
class Singleton(object):
    def __init__(self, cls):
        self._cls = cls
        self._instance = {}

    def __call__(self):
        if self._cls not in self._instance:
            self._instance[self._cls] = self._cls()
        return self._instance[self._cls]


@Singleton
class B(object):
    def __init__(self):
        pass

b1 = B()
b2 = B()
print(id(b1), id(b2))

关于装饰器,我在之前的文章就有介绍Python装饰器,读完这篇你就懂了,感兴趣的小伙伴可以看一下。

使用类的方式实现

class Singleton(object):
    def __init__(self, *args, **kwargs):
        pass
        
    @classmethod
    def get_instance(cls, *args, **kwargs):
        # hasattr() 函数用于判断对象是否包含对应的属性 , 这里是看看这个类有没有 _instance 属性  
        if not hasattr(Singleton, '_instance' ):
            Singleton._instance = Singleton(*args, **kwargs)

        return Singleton._instance


s1 = Singleton()  # 使用这种方式创建实例的时候 , 并不能保证单例 
s2 = Singleton.get_instance()  # 只有使用这种方式创建的时候才可以实现单例 
s3 = Singleton()
s4 = Singleton.get_instance()

print(id(s1), id(s2), id(s3), id(s4))

其实这种方式的思路就是,调用类的get_instance()方法去创建对象,get_instance方法会判断之前有没有创建过对象,有的话也是会返回之前已经创建的对象,不再新创建,但是这样有一个弊端,就是在使用类创建s3 = Singleton()这种方式的时候,就不能保证单例了,也就是说在创建类的时候一定要用类里面规定的get_instance()方法创建。 再者,当使用多线程时这样也会存在问题,我们来看下面的代码:

class Singleton(object):
    def __init__(self, *args, **kwargs):
        import time
        time.sleep(1)

    @classmethod
    def get_instance(cls, *args, **kwargs):
        # hasattr() 函数用于判断对象是否包含对应的属性 , 这里是看看这个类有没有 _instance 属性
        if not hasattr(Singleton, '_instance'):
            Singleton._instance = Singleton(*args, **kwargs)

        return Singleton._instance


def task():
    obj = Singleton.get_instance()
    print(obj)


for i in range(10):
    t = threading.Thread(target=task)
    t.start()

程序执行后,打印结果:

<__main__.Singleton object at 0x031014B0>
<__main__.Singleton object at 0x00DA32F0>
<__main__.Singleton object at 0x03101430>
<__main__.Singleton object at 0x03101530>
<__main__.Singleton object at 0x031015B0>
<__main__.Singleton object at 0x031016B0>
<__main__.Singleton object at 0x03101630>
<__main__.Singleton object at 0x03101830>
<__main__.Singleton object at 0x03101730>
<__main__.Singleton object at 0x031017B0>

Process finished with exit code 0

如果在__init__()方法方法中有一些IO操作(此处使用time.sleep(1)来模拟),就会发现此时并不是同一个实例对象,这是因为在一个对象创建的过程中,会先去获取_instance属性,判断之前有没有实例对象,因为IO耗时操作,当他们判断的时候,还没有对象完成实例化,所以就会调用init()方法进行实例化,结果就是调用了多次,然后就创建了多个对象。那要如何解决呢? 答案是加锁,在获取对象属性_instance的时候加锁,如果已经有人在获取对象了,其他的人如果要获取这个对象,就先等一下,因为前面的那个人,可能在创建对象,就是还没创建完成。 代码如下:

class Singleton(object):
    _instance_lock = threading.Lock()  # 线程锁
    
    def __init__(self, *args, **kwargs):
        import time
        time.sleep(1)

    @classmethod
    def get_instance(cls, *args, **kwargs):
        with Singleton._instance_lock:
            # hasattr() 函数用于判断对象是否包含对应的属性 , 这里是看看这个类有没有 _instance 属性
            if not hasattr(Singleton, '_instance'):
                Singleton._instance = Singleton(*args, **kwargs)

            return Singleton._instance

但是为了保证线程安全,在类内部加入锁机制,又会使加锁部分代码串行执行,速度降低。

使用__new__()函数实现

class Singleton(object):

    def __init__(self):
        print( "__init__" )

    def __new__(cls, *args, **kwargs):
        print( "__new__" )
        if not hasattr(Singleton, "_instance" ):
            print( " 创建新实例 " )
            Singleton._instance = object.__new__(cls)
        return Singleton._instance


obj1 = Singleton()
obj2 = Singleton()
print(obj1, obj2)

当python实例化一个对象时,是先执行类的__new__()方法,当我们没写__new__()方法时,默认调用基类object的__new__()方法,然后再执行类的__init__()方法,对这个对象进行初始化,所有我们可以基于这个,去实现单例模式,我们通过hasattr(Singleton,  **"_instance"** )(其中hasattr()的功能是判断一个对象有没有指定的属性)去判断之前有没有实例化过对象,如果有,就直接返回,没有就新创建一个。

附上控制台输出:可以看出,同样实现了单例。

但这样其实有个小问题,看输出其实执行了两遍__init__()方法,既然是同一个对象,初始化两次,这是不太合理的,我们可以改造一下:

class Singleton(object):

    def __init__(self):
        if not hasattr(Singleton, "_first_init"):
            print("__init__")
            Singleton._first_init = True

    def __new__(cls, *args, **kwargs):
        print("__new__")
        if not hasattr(Singleton, "_instance"):
            print("创建新实例")
            Singleton._instance = object.__new__(cls)
        return Singleton._instance


obj1 = Singleton()
obj2 = Singleton()
print(obj1, obj2)

而且__new__()方法是支持多线程的,不需要单独再加线程锁进行规避操作,省时又省力,nice。

总结

本文章虽然是讲单例模式,但在实现单例模式的过程中,用到了挺多高级Python语法,包括装饰器、魔法函数__new__(),with语句块等等,感兴趣的小伙伴可以了解一下,其实Python还有挺魔力的,总是能够用较少的代码实现较多的功能。

最后,感谢女朋友在工作和生活中的包容、理解与支持 !