首頁 > 文章 > 後端開發 > Python 實作單例模式的五種寫法

Python 實作單例模式的五種寫法

WBOY轉載: 2023-05-26 22:31:241519瀏覽

Python 实现单例模式的五种写法

單例模式（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

這樣，一個可以支援多線程的單例模式就完成了。

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)

以上是Python 實作單例模式的五種寫法的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述：

本文轉載於：51cto.com。如有侵權，請聯絡admin@php.cn刪除

上一篇：Python eval 函數建立數學表達式計算器下一篇：Python eval 函數建立數學表達式計算器

看更多