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)