Python單例模式最佳實踐

今天在群裡討論時討論到了單例模式，這應該是大家最熟悉的一種設計模式了。

簡單而言，單例模式就是保證某個例項在專案的整個生命週期中只存在乙個，在專案的任意位置使用，都是同乙個例項。

單例模式雖然簡單，但還是有些門道的，而少有人知道這些門道。

python中實現單例模式的方法很多，我以前最常使用的應該是下面這種寫法。

class
singleton
(object):
_instance =
none
def__new__
(cls,
*args,
**kw)
:if cls._instance is
none
:            cls._instance =
object
.__new__(cls,
*args,
**kw)
return cls._instance

這種寫法有兩個問題。

1.單例模式對應類例項化時無法傳入引數，將上面的**擴充套件成下面形式。

class
singleton
(object):
_instance =
none
def__new__
(cls,
*args,
**kw)
:if cls._instance is
none
:            cls._instance =
object
.__new__(cls,
*args,
**kw)
return cls._instance
def__init
(self, x, y)
:        self.x = x
self.y = y
s = singleton(1,
2)

此時會丟擲typeerror: object.__new__() takes exactly one argument (the type to instantiate)錯誤

2.多個執行緒例項化singleton類時，可能會出現建立多個例項的情況，因為很有可能多個執行緒同時判斷cls._instance is none，從而進入初始化例項的**中。

先考慮上述實現遇到的第二個問題。

既然多執行緒情況下會出現邊界情況從而引數多個例項，那麼使用同步鎖解決多執行緒的衝突則可。

import threading
# 同步鎖
defsynchronous_lock
(func)
:def
(*args,
**kwargs)
:with threading.lock():
return func(
*args,
**kwargs)
class
singleton
(object):
instance =
none
@synchronous_lock
def__new__
(cls,
*args,
**kwargs)
:if cls.instance is
none
:            cls.instance =
object
.__new__(cls,
*args,
**kwargs)
return cls.instance

上述**中通過threading.lock()將單例化方法同步化，這樣在面對多個執行緒時也不會出現建立多個例項的情況，可以簡單試驗一下。

def
worker()
:    s = singleton(
)print(id
(s))
deftest()
:    task =
for i in
range(10
):t = threading.thread(target=worker)
for i in task:
i.start(
)for i in task:
i.join(
)test(
)

執行後，列印的單例的id都是相同的。

加了同步鎖之後，除了無法傳入引數外，已經沒有什麼大問題了，但是否有更優的解決方法呢？單例模式是否有可以接受引數的實現方式？

閱讀python官方的wiki（可以發現官方建議的單例模式實現方式，**如下。

def
singleton
(cls)
:    cls.__new_original__ = cls.__new__
@functools.wraps(cls.__new__)
defsingleton_new
(cls,
*args,
**kwargs)
:        it = cls.__dict__.get(
'__it__'
)if it is
notnone
:return it
cls.__it__ = it = cls.__new_original__(cls,
*args,
**kwargs)
it.__init_original__(
*args,
**kwargs)
return it
cls.__new__ = singleton_new
cls.__init_original__ = cls.__init__
cls.__init__ =
object
.__init__
return cls
@singleton
class
foo(
object):
def__new__
(cls,
*args,
**kwargs)
:        cls.x =
10return
object
.__new__(cls)
def__init__
(self, x, y)
:assert self.x ==
10        self.x = x
self.y = y

上述**中定義了singleton類裝飾器，裝飾器在預編譯時就會執行，利用這個特性，singleton類裝飾器中替換了類原本的__new__與__init__方法，使用singleton_new方法進行類的例項化，在singleton_new方法中，先判斷類的屬性中是否存在__it__屬性，以此來判斷是否要建立新的例項，如果要建立，則呼叫類原本的__new__方法完成例項化並呼叫原本的__init__方法將引數傳遞給當前類，從而完成單例模式的目的。

這種方法讓單例類可以接受對應的引數但面對多執行緒同時例項化還是可能會出現多個例項，此時加上執行緒同步鎖則可。

def
singleton
(cls)
:    cls.__new_original__ = cls.__new__
@functools.wraps(cls.__new__)
defsingleton_new
(cls,
*args,
**kwargs)
:# 同步鎖
with threading.lock():
it = cls.__dict__.get(
'__it__'
)if it is
notnone
:return it
cls.__it__ = it = cls.__new_original__(cls,
*args,
**kwargs)
it.__init_original__(
*args,
**kwargs)
return it
cls.__new__ = singleton_new
cls.__init_original__ = cls.__init__
cls.__init__ =
object
.__init__
return cls

如果乙個專案不需要使用執行緒相關機制，只是在單例化這裡使用了執行緒鎖，這其實不是必要的，它會拖慢專案的執行速度。

閱讀cpython執行緒模組相關的原始碼，你會發現，python一開始時並沒有初始化執行緒相關的環境，只有當你使用theading庫相關功能時，才會呼叫pyeval_initthreads方法初始化多執行緒相關的環境，**片段如下（我省略了很多不相關**）。

static pyobject *
thread_pythread_start_new_thread
(pyobject *self, pyobject *fargs)

為什麼會這樣？

因為多執行緒環境會啟動gil鎖相關的邏輯，這會影響python程式執行速度。很多簡單的python程式並不需要使用多執行緒，此時不需要初始化執行緒相關的環境，python程式在沒有gil鎖的情況下會執行的更快。

如果你的專案中不會涉及多執行緒操作，那麼就沒有使用有同步鎖來實現單例模式。

網際網路中有很多python實現單例模式的文章，你只需要從多執行緒下是否可以保證單例項以及單例化時是否可以傳入初始引數兩點來判斷相應的實現方法則可。

歡迎關注「懶程式設計」，一起探索技術的本質。

Python單例模式最佳實踐

單例模式的最佳實現

python單例模式繼承 python單例模式

單例模式 python

Python單例模式最佳實踐

單例模式的最佳實現

python單例模式繼承 python單例模式

單例模式 python

相關推薦