首頁 > 軟體

Python 中用多種方式實現單例模式

2022-11-13 14:00:51

單例模式（Singleton Pattern） 是一種常用的軟體設計模式，該模式的主要目的是確保某一個類只有一個範例存在。當你希望在整個系統中，某個類只能出現一個範例時，單例物件就能派上用場。

比如，某個伺服器程式的設定資訊存放在一個檔案中，使用者端通過一個 AppConfig 的類來讀取組態檔的資訊。如果在程式執行期間，有很多地方都需要使用組態檔的內容，也就是說，很多地方都需要建立 AppConfig 物件的範例，這就導致系統中存在多個 AppConfig 的範例物件，而這樣會嚴重浪費記憶體資源，尤其是在組態檔內容很多的情況下。

事實上，類似 AppConfig 這樣的類，我們希望在程式執行期間只存在一個範例物件。

在 Python 中，我們可以用多種方法來實現單例模式：

  • 使用模組
  • 使用裝飾器
  • 使用類
  • 基於 __new__ 方法實現
  • 基於 metaclass 方式實現

下面來詳細介紹：

使用模組

其實，Python 的模組就是天然的單例模式，因為模組在第一次匯入時，會生成 .pyc 檔案，當第二次匯入時，就會直接載入 .pyc 檔案，而不會再次執行模組程式碼。

因此，我們只需把相關的函數和資料定義在一個模組中，就可以獲得一個單例物件了。

如果我們真的想要一個單例類，可以考慮這樣做：

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

將上面的程式碼儲存在檔案 mysingleton.py 中，要使用時，直接在其他檔案中匯入此檔案中的物件，這個物件即是單例模式的物件

from mysingleton import singleton

使用裝飾器

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)

使用類

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

一般情況，大家以為這樣就完成了單例模式，但是當使用多執行緒時會存在問題：

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
 
import threading
 
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 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>
<__main__.Singleton object at 0x02C933D0>

看起來也沒有問題，那是因為執行速度過快，如果在 __init__ 方法中有一些 IO 操作，就會發現問題了。

下面我們通過 time.sleep 模擬，我們在上面 __init__ 方法中加入以下程式碼：

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

重新執行程式後，結果如下：

<__main__.Singleton object at 0x034A3410>
<__main__.Singleton object at 0x034BB990>
<__main__.Singleton object at 0x034BB910>
<__main__.Singleton object at 0x034ADED0>
<__main__.Singleton object at 0x034E6BD0>
<__main__.Singleton object at 0x034E6C10>
<__main__.Singleton object at 0x034E6B90>
<__main__.Singleton object at 0x034BBA30>
<__main__.Singleton object at 0x034F6B90>
<__main__.Singleton object at 0x034E6A90>

問題出現了！按照以上方式建立的單例，無法支援多執行緒。

解決辦法：加鎖！未加鎖部分並行執行，加鎖部分序列執行，速度降低，但是保證了資料安全。

import time
import threading
class Singleton(object):
    _instance_lock = threading.Lock()
 
    def __init__(self):
        time.sleep(1)
 
    @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()
time.sleep(20)
obj = Singleton.instance()
print(obj)

列印結果如下：

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

這樣就差不多了，但是還是有一點小問題，就是當程式執行時，執行了 time.sleep(20) 後，下面範例化物件時，此時已經是單例模式了。

但我們還是加了鎖，這樣不太好，再進行一些優化，把 intance 方法，改成下面這樣就行：

@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
@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

這樣，一個可以支援多執行緒的單例模式就完成了。+

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()
    
    
time.sleep(20)
obj = Singleton.instance()
print(obj)

這種方式實現的單例模式，使用時會有限制，以後範例化必須通過 obj = Singleton.instance()

如果用 obj = Singleton()，這種方式得到的不是單例。

基於 __new__ 方法實現

通過上面例子，我們可以知道，當我們實現單例時，為了保證執行緒安全需要在內部加入鎖。

我們知道，當我們範例化一個物件時，是先執行了類的 __new__ 方法（我們沒寫時，預設呼叫 object.__new__），範例化物件；然後再執行類的 __init__ 方法，對這個物件進行初始化，所有我們可以基於這個，實現單例模式。

import threading
class Singleton(object):
    _instance_lock = threading.Lock()
 
    def __init__(self):
        pass
 
 
    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
 
obj1 = Singleton()
obj2 = Singleton()
print(obj1,obj2)
 
def task(arg):
    obj = Singleton()
    print(obj)
 
for i in range(10):
    t = threading.Thread(target=task,args=[i,])
    t.start()

列印結果如下：

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

採用這種方式的單例模式，以後範例化物件時，和平時範例化物件的方法一樣 obj = Singleton() 。

基於 metaclass 方式實現

相關知識:

類由 type 建立，建立類時，type 的 __init__ 方法自動執行，類() 執行 type 的 __call__ 方法(類的 __new__ 方法，類的 __init__ 方法)

物件由類建立，建立物件時，類的 __init__ 方法自動執行，物件()執行類的 __call__ 方法

例子：

class Foo:
    def __init__(self):
        pass
 
    def __call__(self, *args, **kwargs):
        pass
 
obj = Foo()
# 執行type的 __call__ 方法，呼叫 Foo類（是type的物件）的 __new__方法，用於建立物件，然後呼叫 Foo類（是type的物件）的 __init__方法，用於對物件初始化。
 
obj()    # 執行Foo的 __call__ 方法

元類的使用：

class SingletonType(type):
    def __init__(self,*args,**kwargs):
        super(SingletonType,self).__init__(*args,**kwargs)
 
    def __call__(cls, *args, **kwargs): # 這裡的cls，即Foo類
        print('cls',cls)
        obj = cls.__new__(cls,*args, **kwargs)
        cls.__init__(obj,*args, **kwargs) # Foo.__init__(obj)
        return obj
 
class Foo(metaclass=SingletonType): # 指定建立Foo的type為SingletonType
    def __init__(self，name):
        self.name = name
    def __new__(cls, *args, **kwargs):
        return object.__new__(cls)
 
obj = Foo('xx')

實現單例模式：

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)

 


相關文章

  • 德漢姆中學就讀條件 德漢姆中學就讀條件

    <em>Mac</em>Book项目 2009年学校开始实施<em>Mac</em>Book项目,所有师生配备一本<em>Mac</em>Book,并同步更新了校园无线网络。学校每周进行电脑技术更新,每月发送技术支持资料,极大改变了教学及学习方式。因此2011

    2021-06-01 09:32:01

  • 黑科技的輕簡出行，告別「電量焦慮症」：Anker氮化鎵超能充系列 黑科技的輕簡出行，告別「電量焦慮症」：Anker氮化鎵超能充系列

    综合看Anker超能充系列的性价比很高，并且与不仅和iPhone12/苹果<em>Mac</em>Book很配，而且适合多设备充电需求的日常使用或差旅场景，不管是安卓还是Switch同样也能用得上它，希望这次分享能给准备购入充电器的小伙伴们有所

    2021-06-01 09:31:42

  • 吳亦凡廠牌首秀，L4WUDU居然忘詞了，Rapper和明星比還是有差距！ 吳亦凡廠牌首秀，L4WUDU居然忘詞了，Rapper和明星比還是有差距！

    除了L4WUDU与吴亦凡已经多次共事，成为了明面上的厂牌成员，吴亦凡还曾带领20XXCLUB全队参加2020年的一场音乐节，这也是20XXCLUB首次全员合照，王嗣尧Turbo、陈彦希Regi、<em>Mac</em> Ova Seas、林渝植等人全部出场。然而让

    2021-06-01 09:31:34

  • IPFS、Chia、Bzz和ICP挖礦該怎麼選？哪一個更有優勢？ IPFS、Chia、Bzz和ICP挖礦該怎麼選？哪一個更有優勢？

    目前应用IPFS的机构：1 谷歌<em>浏览器</em>支持IPFS分布式协议 2 万维网 (历史档案博物馆)数据库 3 火狐<em>浏览器</em>支持 IPFS分布式协议 4 EOS 等数字货币数据存储 5 美国国会图书馆，历史资料永久保存在 IPFS 6 加

    2021-06-01 09:31:24

  • 有哪些事是買了雪佛蘭後才知道的？美事偷著樂，開拓者車主隨聊 有哪些事是買了雪佛蘭後才知道的？美事偷著樂，開拓者車主隨聊

    开拓者的车机是兼容苹果和<em>安卓</em>，虽然我不怎么用，但确实兼顾了我家人的很多需求：副驾的门板还配有解锁开关，有的时候老婆开车，下车的时候偶尔会忘记解锁，我在副驾驶可以自己开门：第二排设计很好，不仅配置了一个很大的

    2021-06-01 09:30:48

  • iPhone12在618最新定價，跌價幅度超過1400元，還等iPhone13嗎？ iPhone12在618最新定價，跌價幅度超過1400元，還等iPhone13嗎？

    不仅是<em>安卓</em>手机，苹果手机的降价力度也是前所未有了，iPhone12也“跳水价”了，发布价是6799元，如今已经跌至5308元，降价幅度超过1400元，最新定价确认了。iPhone12是苹果首款5G手机，同时也是全球首款5nm芯片的智能机，它

    2021-06-01 09:30:45

IT145.com E-mail:sddin#qq.com