用Python实现单例模式

Posted 2023-03-31 小胖虎*

什么是单例模式

单例模式是指在内存中只会创建且仅创建一次对象的设计模式。在程序中多次使用同一个对象且作用相同时，为了防止频繁地创建对象使得内存飙升，单例模式可以让程序仅在内存中创建一个对象，让所有需要调用的地方都共享这一单例对象。

单例模式的应用场景

单例模式只允许创建一个对象，因此节省内存，加快对象访问速度，因此对象需要被公用的场合适合使用，如多个模块使用同一个数据源连接对象等等。如：

1.需要频繁实例化然后销毁的对象。

2.创建对象时耗时过多或者耗资源过多，但又经常用到的对象。

3.有状态的工具类对象。

4.频繁访问数据库或文件的对象。

以下都是单例模式的经典使用场景：

1.资源共享的情况下，避免由于资源操作时导致的性能或损耗等。如上述中的日志文件，应用配置。

2.控制资源的情况下，方便资源之间的互相通信。如线程池等。

单例模式的优缺点

优点：

1.在单例模式中，活动的单例只有一个实例，对单例类的所有实例化得到的都是相同的一个实例。这样就 防止其它对象对自己的实例化，确保所有的对象都访问一个实例

2.单例模式具有一定的伸缩性，类自己来控制实例化进程，类就在改变实例化进程上有相应的伸缩性。

3.提供了对唯一实例的受控访问。

4.由于在系统内存中只存在一个对象，因此可以 节约系统资源，当 需要频繁创建和销毁的对象时单例模式无疑可以提高系统的性能。

5.允许可变数目的实例。

6.避免对共享资源的多重占用。

缺点：

1.不适用于变化的对象，如果同一类型的对象总是要在不同的用例场景发生变化，单例就会引起数据的错误，不能保存彼此的状态。

2.由于单利模式中没有抽象层，因此单例类的扩展有很大的困难。

3.单例类的职责过重，在一定程度上违背了“单一职责原则”。

4.滥用单例将带来一些负面问题，如为了节省资源将数据库连接池对象设计为的单例类，可能会导致共享连接池对象的程序过多而出现连接池溢出；如果实例化的对象长时间不被利用，系统会认为是垃圾而被回收，这将导致对象状态的丢失。

实现单例模式的几个实例

使用类变量实现单例模式

在 Python 中，可以通过定义一个类变量来实现单例模式，这个类变量可以存储单例实例的引用，如果该变量已经存储了一个实例，就直接返回该实例的引用，否则就创建一个新实例并将其存储在类变量中。

class Singleton:
    __instance = None   # 用于存储单例实例的类变量

    def __new__(cls):
        if cls.__instance is None:
            cls.__instance = super().__new__(cls)
        return cls.__instance

s1 = Singleton()
s2 = Singleton()
print(s1 == s2)   # True，因为 s1 和 s2 引用的是同一个实例

在这个例子中，我们定义了一个名为 `Singleton` 的类，它有一个类变量 `__instance`，用于存储单例实例的引用。在类的构造方法 `__new__` 中，我们首先检查 `__instance` 是否为 None，如果是，则说明还没有创建实例，于是调用父类的 `__new__` 方法创建一个新实例并将其赋值给 `__instance`，然后返回该实例的引用。如果 `__instance` 不为 None，则说明已经存在一个实例，于是直接返回该实例的引用。

最后，我们创建了两个 `Singleton` 类的实例 `s1` 和 `s2`，并将它们分别赋值给变量 `s1` 和 `s2`。由于单例模式的特性，我们期望 `s1` 和 `s2` 引用的是同一个实例，因此打印 `s1 == s2` 的结果应该为 True。除了使用类变量存储单例实例的引用之外，还可以使用装饰器或元类来实现单例模式。

使用装饰器实现单例模式

def singleton(cls):
    instances = 
    def getinstance(*args, **kwargs):
        if cls not in instances:
            instances[cls] = cls(*args, **kwargs)
        return instances[cls]
    return getinstance

@singleton
class MyClass:
    pass

a = MyClass()
b = MyClass()
print(a == b)   # True，因为 a 和 b 引用的是同一个实例

在这个例子中，我们定义了一个名为 `singleton` 的装饰器，它会接受一个类作为参数，返回一个新的函数 `getinstance`。在 `getinstance` 函数中，我们首先检查 `cls` 是否在 `instances` 字典中，如果不在，则说明还没有创建实例，于是调用 `cls` 的构造方法创建一个新实例并将其存储在 `instances` 中，然后返回该实例的引用。如果 `cls` 已经在 `instances` 中，则直接返回该实例的引用。最后，我们用 `@singleton` 装饰器修饰了一个名为 `MyClass` 的类，使其成为单例类。

使用元类实现单例模式

class Singleton(type):
    _instances = 
    def __call__(cls, *args, **kwargs):
        if cls not in cls._instances:
            cls._instances[cls] = super().__call__(*args, **kwargs)
        return cls._instances[cls]

class MyClass(metaclass=Singleton):
    pass

a = MyClass()
b = MyClass()
print(a == b)   # True，因为 a 和 b 引用的是同一个实例

在这个例子中，我们定义了一个名为 `Singleton` 的元类，它会在每次创建类时被调用。在 `Singleton` 的 `__call__` 方法中，我们首先检查 `cls` 是否在 `_instances` 字典中，如果不在，则说明还没有创建实例，于是调用父类的 `__call__` 方法创建一个新实例并将其存储在 `_instances` 中，然后返回该实例的引用。如果 `cls` 已经在 `_instances` 中，则直接返回该实例的引用。最后，我们用 `metaclass=Singleton` 指定了一个元类，使其成为 `MyClass` 的元类，从而使 `MyClass` 成为单例类。除了上述的几种实现方式外，还有其他的一些实现单例模式的方法。

使用模块实现单例模式

在 Python 中，模块在导入时只会被执行一次，因此可以使用模块来实现单例模式。例如，我们可以创建一个名为 `mysingleton.py` 的模块，并在其中定义一个单例类：

class MySingleton:
    def __init__(self):
        self.name = "Singleton"

my_singleton = MySingleton()

在另一个文件中，我们可以导入 `mysingleton` 模块，并使用其中的单例对象 `my_singleton`：

from mysingleton import my_singleton
print(my_singleton.name)   # "Singleton"

在这个例子中，我们在 `mysingleton.py` 模块中定义了一个名为 `MySingleton` 的单例类，并在该类的构造方法中定义了一个名为 `name` 的实例变量。在该模块中，我们还创建了一个名为 `my_singleton` 的 `MySingleton` 类的实例，并将其赋值给一个全局变量。在另一个文件中，我们通过 `from mysingleton import my_singleton` 导入了 `my_singleton` 对象，并打印了它的 `name` 变量。

使用闭包实现单例模式

在 Python 中，闭包是一种可以捕获其定义域中的变量并将其封装在函数对象中的方法。可以使用闭包来实现单例模式。例如，我们可以创建一个函数 `singleton`，它会返回一个内部函数 `get_instance`，该函数用于创建并返回单例对象：

def singleton(cls):
    instance = None
    def get_instance(*args, **kwargs):
        nonlocal instance
        if instance is None:
            instance = cls(*args, **kwargs)
        return instance
    return get_instance

@singleton
class MyClass:
    pass

a = MyClass()
b = MyClass()
print(a == b)   # True，因为 a 和 b 引用的是同一个实例

在这个例子中，我们定义了一个名为 `singleton` 的函数，它接受一个类作为参数，并返回一个内部函数 `get_instance`。在 `get_instance` 函数中，我们首先声明一个名为 `instance` 的变量，并将其初始化为 None。然后，我们检查 `instance` 是否为 None，如果是，则说明还没有创建实例，于是调用 `cls` 的构造方法创建一个新实例并将其赋值给 `instance`，然后返回该实例的引用。如果 `instance` 不为 None，则说明已经存在一个实例，直接返回该实例的引用。最后，我们用 `@singleton` 装饰器修饰了一个名为 `MyClass` 的类，使其成为单例类。

使用单例模式的注意事项

在使用单例模式时，需要注意以下几点：

1. 确保单例类的唯一性：单例类应该只有一个实例，并且该实例应该在整个程序中都可用。因此外，还需要注意以下几点：

2. 线程安全：如果多个线程同时调用单例类的构造方法，可能会创建多个实例。因此，需要采取线程安全的措施，如使用锁或原子操作。

3. 生命周期管理：由于单例对象在整个程序中都可用，因此需要考虑它的生命周期。单例对象可能需要在程序退出时进行清理操作，例如关闭数据库连接或保存缓存数据。

4. 依赖管理：如果单例对象依赖于其他对象，则需要确保这些依赖对象也是单例对象。否则，可能会出现多个实例之间的状态不一致的问题。

总之，单例模式是一种非常有用的设计模式，它可以确保一个类只有一个实例，并且该实例在整个程序中都可用。在 Python 中，可以使用多种方式实现单例模式，如使用类装饰器、元类、模块、闭包等。在实现单例模式时，需要考虑线程安全、生命周期管理和依赖管理等问题，以确保单例对象的正确性和可靠性。

设计模式(Python)-单例模式

本系列文章是希望将软件项目中最常见的设计模式用通俗易懂的语言来讲解清楚，并通过Python来实现，每个设计模式都是围绕如下三个问题：

1. 为什么？即为什么要使用这个设计模式，在使用这个模式之前存在什么样的问题？
2. 是什么？通过Python语言来去实现这个设计模式，用于解决为什么中提到的问题。
3. 怎么用？理解了为什么我们也就基本了解了什么情况下使用这个模式，不过在这里还是会细化使用场景，阐述模式的局限和优缺点。

这一篇我们先来看看单例模式。单例模式是设计模式中逻辑最简单，最容易理解的一个模式，简单到只需要一句话就可以理解，即“保证只有一个对象实例的模式”。问题的关键在于实现起来并没有想象的那么简单。不过我们还是先来讨论下为什么需要这个模式吧。

为什么

我们首先来看看单例模式的使用场景，然后再来分析为什么需要单例模式。

• Python的logger就是一个单例模式，用以日志记录
• Windows的资源管理器是一个单例模式
• 线程池，数据库连接池等资源池一般也用单例模式
• 网站计数器

从这些使用场景我们可以总结下什么情况下需要单例模式：

1. 当每个实例都会占用资源，而且实例初始化会影响性能，这个时候就可以考虑使用单例模式，它给我们带来的好处是只有一个实例占用资源，并且只需初始化一次；
2. 当有同步需要的时候，可以通过一个实例来进行同步控制，比如对某个共享文件（如日志文件）的控制，对计数器的同步控制等，这种情况下由于只有一个实例，所以不用担心同步问题。

当然所有使用单例模式的前提是我们的确用一个实例就可以搞定要解决的问题，而不需要多个实例，如果每个实例都需要维护自己的状态，这种情况下单例模式肯定是不适用的。
接下来看看如何使用Python来实现一个单例模式。

是什么

最开始的想法很简单，实现如下：

class Singleton(object):
    __instance = None
    def __new__(cls, *args, **kwargs):  # 这里不能使用__init__，因为__init__是在instance已经生成以后才去调用的
        if cls.__instance is None:
            cls.__instance = super(Singleton, cls).__new__(cls, *args, **kwargs)
        return cls.__instance

s1 = Singleton()
s2 = Singleton()
print s1
print s2

 

打印结果如下：

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

可以看出两次创建对象，结果返回的是同一个对象实例，我们再让我们的例子更接近真实的使用场景来看看

class Singleton(object):
    __instance = None

    def __new__(cls, *args, **kwargs):
        if cls.__instance is None:
            cls.__instance = super(
                Singleton, cls).__new__(cls, *args, **kwargs)
        return cls.__instance

    def __init__(self, status_number):
        self.status_number = status_number


s1 = Singleton(2)
s2 = Singleton(5)
print s1
print s2

print s1.status_number
print s2.status_number

 

这里我们使用了_init_方法，下面是打印结果，可以看出确实是只有一个实例，共享了实例的变量

<__main__.Singleton object at 0x7f5116865490>
<__main__.Singleton object at 0x7f5116865490>
5
5

不过这个例子中有一个问题我们没有解决，那就是多线程的问题，当有多个线程同时去初始化对象时，就很可能同时判断__instance is None，从而进入初始化instance的代码中。所以为了解决这个问题，我们必须通过同步锁来解决这个问题。以下例子来自xiaorui

import threading
try:
    from synchronize import make_synchronized
except ImportError:
    def make_synchronized(func):
        import threading
        func.__lock__ = threading.Lock()

        def synced_func(*args, **kws):
            with func.__lock__:
                return func(*args, **kws)

        return synced_func


class Singleton(object):
    instance = None

    @make_synchronized
    def __new__(cls, *args, **kwargs):
        if cls.instance is None:
            cls.instance = object.__new__(cls, *args, **kwargs)
        return cls.instance

    def __init__(self):
        self.blog = "xiaorui.cc"

    def go(self):
        pass


def worker():
    e = Singleton()
    print id(e)
    e.go()


def test():
    e1 = Singleton()
    e2 = Singleton()
    e1.blog = 123
    print e1.blog
    print e2.blog
    print id(e1)
    print id(e2)


if __name__ == "__main__":
    test()
    task = []
    for one in range(30):
        t = threading.Thread(target=worker)
        task.append(t)

    for one in task:
        one.start()

    for one in task:
        one.join()

 

至此我们的单例模式实现代码已经接近完美了，不过我们是否可以更简单地使用单例模式呢？答案是有的，接下来就看看如何更简单地使用单例模式。

怎么用

在Python的官方网站给了两个例子是用装饰符来修饰类，从而使得类变成了单例模式，使得我们可以通过更加简单的方式去实现单例模式
例子：（这里只给出一个例子，因为更简单，另外一个大家可以看官网Singleton

def singleton(cls):
    instance = cls()
    instance.__call__ = lambda: instance
    return instance

#
# Sample use
#

@singleton
class Highlander:
    x = 100
    # Of course you can have any attributes or methods you like.

Highlander() is Highlander() is Highlander #=> True
id(Highlander()) == id(Highlander) #=> True
Highlander().x == Highlander.x == 100 #=> True
Highlander.x = 50
Highlander().x == Highlander.x == 50 #=> True

 

这里简单解释下：

1. 在定义class Highlander的时候已经执行完所有singleton装饰器中的代码，得到了一个instance，所以这之后所有对Highlander的调用实际上是在调用instance的_call_ 方法。
2. 我们通过lambda函数定义了_call_方法让它始终返回instance，因此Highlander()和Highlander都返回instance
3. 同时由于在类定义代码执行时就已经创建了instance，所以后续不论是多线程还是单线程，在调用Highlander时都是在调用instance的_call_方法，也就无需同步了。
   最后我想说的是这种方法简直碉堡了～～～
   附上我用于多线程的测试代码

import threading

def singleton(cls):
    instance = cls()
    instance.__call__ = lambda: instance
    return instance


@singleton
class Highlander:
    x = 100
    # Of course you can have any attributes or methods you like.


def worker():
    hl = Highlander()
    hl.x += 1
    print hl
    print hl.x


def main():
    threads = []
    for _ in xrange(50):
        t = threading.Thread(target=worker)
        threads.append(t)

    for t in threads:
        t.start()

    for t in threads:
        t.join()


if __name__ == ‘__main__‘:
    main()

 

这里的代码有一点小问题，就是在打印的时候有可能x属性已经被别的线程+1了，所以有可能导致同一个数打印多次，而有的数没有打印，但是不影响最终x属性的结果，所以当所有线程结束之后，属性x最终的值是可以保证正确的。

Reference:

• Python官网Singleton装饰器
• Xiaorui Blog
• static未央