python的单例模式

一.单例模式

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

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

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

 

二 .实现单例模式的几种方式

2.1 使用模块

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

mysingleton.py

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

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

from a import singleton

 

2.2 使用装饰器

def Singleton(cls):
    _instance = {}

    def _singleton(*args, **kargs):
        if cls not in _instance:
            _instance[cls] = cls(*args, **kargs)
        return _instance[cls]

    return _singleton


@Singleton
class A(object):
    a = 1

    def __init__(self, x=0):
        self.x = x


a1 = A(2)
a2 = A(3)

 

2.3 使用类

# 推荐
class Singleton(object):
    __instance = None

    def __new__(cls, age, name):
        # 如果类属性__instance的值为None，
        # 那么就创建一个对象，并且赋值为这个对象的引用，保证下次调用这个方法时
        # 能够知道之前已经创建过对象了，这样就保证了只有1个对象
        if not cls.__instance:
            cls.__instance = object.__new__(cls)

a = Singleton(18,'maomao')
b = Singleton(18,'alex')
print(id(a), id(b))
# 140732902316160 140732902316160

或者：

class Singleton(object):

    def __init__(self):
        pass

    @classmethod
    def instance(cls, *args, **kwargs):
        if not hasattr(Singleton, "_instance"):
            Singleton._instance = Singleton(*args, **kwargs)
        return Singleton._instance

a = Singleton.instance()
b = Singleton.instance()
print(id(a), id(b))
注意：

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

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

 

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

import time
import threading

class Singleton(object):

    def __init__(self):
        time.sleep(0.2)

    @classmethod
    def instance(cls, *args, **kwargs):
        if not hasattr(Singleton, "_instance"):
            Singleton._instance = Singleton(*args, **kwargs)
        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 0x0000028723733190>
<__main__.Singleton object at 0x0000028723733C10>
<__main__.Singleton object at 0x0000028723733EB0>
<__main__.Singleton object at 0x0000028723733970>
<__main__.Singleton object at 0x00000287237336D0>
<__main__.Singleton object at 0x0000028723733430>
<__main__.Singleton object at 0x0000028723738970>
<__main__.Singleton object at 0x0000028723738190>
<__main__.Singleton object at 0x0000028723738430>
<__main__.Singleton object at 0x00000287237386D0>

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

import time
import threading
class Singleton(object):
    _instance_lock = threading.Lock()

    def __init__(self):
        time.sleep(0.2)

    @classmethod
    def instance(cls, *args, **kwargs):
        with Singleton._instance_lock:
            if not hasattr(Singleton, "_instance"):
                Singleton._instance = Singleton(*args, **kwargs)
        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 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>
<__main__.Singleton object at 0x00000212855A2190>

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

再进行一些优化，把intance方法，改成下面的这样就行：

import time
import threading
class Singleton(object):
    _instance_lock = threading.Lock()

    def __init__(self):
        time.sleep(1)

    @classmethod
    def instance(cls, *args, **kwargs):
        if not hasattr(Singleton, "_instance"):
            with Singleton._instance_lock:
                if not hasattr(Singleton, "_instance"):
                    Singleton._instance = Singleton(*args, **kwargs)
        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()

 

2.4 基于__new__方法实现（推荐）

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

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

import threading
import time

class Singleton(object):
    _instance_lock = threading.Lock()

    def __init__(self):
        time.sleep(1)


    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


def task(arg):
    obj = Singleton()
    print(obj)

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

 

2.5 基于metaclass实现单例模式

相关知识：

执行顺序：

0. Mytype的__init__
obj = Foo()
1. MyType的__call__
2. Foo的__new__
3. Foo的__init__

 

实现单例模式：

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


obj1 = Foo('name')
obj2 = Foo('name')
print(obj1,obj2)