用Python實(shí)現(xiàn)設(shè)計(jì)模式——單例模式

CollinPeng 發(fā)布于2019-07-30 15:31 / 942人閱讀

摘要：前言單例模式是設(shè)計(jì)模式中最簡單最容易理解的一種，維基百科的定義如下單例模式，也叫單子模式，是一種常用的軟件設(shè)計(jì)模式。

前言

單例模式是設(shè)計(jì)模式（Design Pattern）中最簡單、最容易理解的一種，維基百科[1]的定義如下：

單例模式，也叫單子模式，是一種常用的軟件設(shè)計(jì)模式。在應(yīng)用這個(gè)模式時(shí)，單例對象的類 "類 (計(jì)算機(jī)科學(xué))")必須保證只有一個(gè)實(shí)例存在。許多時(shí)候整個(gè)系統(tǒng)只需要擁有一個(gè)的全局對象，這樣有利于我們協(xié)調(diào)系統(tǒng)整體的行為。

單例模式的主要優(yōu)點(diǎn)是共享資源和減少資源消耗，主要應(yīng)用于IO或數(shù)據(jù)庫的線程池,緩存,日志,對話和需共享數(shù)據(jù)的資源等，但是在實(shí)現(xiàn)情況中濫用單例模式會帶來很多意想不到的問題，本文重點(diǎn)在于介紹幾種Python實(shí)現(xiàn)單例模式的方法，這里就不再展開論述了。文中所演示的代碼都會托管在Github上。

簡單實(shí)現(xiàn)

首先，我們先嘗試用Python內(nèi)部類（嵌套類）來實(shí)現(xiàn)單例模式：

#coding=utf-8
class Singleton:
    """單列類
    """
    class __MyClass:
        """實(shí)際生成實(shí)例的類
        """
        def __init__(self, arg):
            """初始化并賦值"""
            self.foo = arg

        def display(self):
            """返回實(shí)例的id和屬性值"""
            return (id(self), self.foo)

    # 類屬性
    _instance = None
    def __init__(self, arg):
        if not Singleton._instance:
            Singleton._instance = Singleton.__MyClass(arg)
        else:
            Singleton._instance.foo = arg

    def __getattr__(self, attr):
        return getattr(self._instance, attr)

注意實(shí)際生成實(shí)例的類是內(nèi)部的“__MyClass”類，前面的雙下劃線代表這是一個(gè)私有的類，用戶不能再外面直接訪問它。而在"__MyClass"類外封裝了一個(gè)“Singleton”類，這個(gè)類的任務(wù)就是在初始化時(shí)保證整個(gè)上下文中只有一個(gè)實(shí)例，實(shí)現(xiàn)的方式很簡單。用一個(gè)私有屬性__instance_保存當(dāng)前生成的實(shí)例，在初始化時(shí)判斷實(shí)例是否為_None_，如果是就用“__MyClass”類生成一個(gè)新實(shí)例并賦值給__instance_，否就直接返回或調(diào)用當(dāng)前__instance_的實(shí)例。最后用"__MyClass"里的實(shí)現(xiàn)的方法測試一下:

if __name__ == "__main__":
    """測試"""
    s1 = Singleton("bar")
    s2 = Singleton("zoo")
    print(s1.display())
    print(s2.display())

# output
>(41706760L, "zoo")
>(41706760L, "zoo")

基類

現(xiàn)在我們考慮將inner class拆分出來，因?yàn)樵赑ython類實(shí)例化時(shí)會調(diào)用___new___方法[2]來生成實(shí)例，所以我們可以先繼承“Singleton”類，然后通過重寫基類的___new___方法讓其實(shí)現(xiàn)單例模式：

#coding=utf-8
class Singleton(object):
    """單例類
    """
    _instance = None

    def __new__(cls, *args, **kwargs):
        if not cls._instance:
            cls._instance = super(Singleton, cls).__new__(cls, *args, **kwargs)
        return cls._instance

class MyClass(Singleton):
    """實(shí)際生成實(shí)例的類
    """
    def __init__(self, arg):
        self.foo = arg

    def display(self):
        return (id(self), self.foo)

測試結(jié)果：

if __name__ == "__main__":
    s1 = MyClass("bar")
    s2 = MyClass("zoo")
    print(s1.display())
    print(s2.display())
    assert s1 is s2

# output
>(40882416L, "zoo")
>(40882416L, "zoo")

裝飾器

第三種就是最常見的用裝飾器來實(shí)現(xiàn)單列模式：

#coding=utf-8
def singleton(cls):
    instances = {}
    def wrapper(*args, **kwargs):
        if cls not in instances:
            instances[cls] = cls(*args, **kwargs)
        return instances[cls]
    return wrapper

@singleton
class MyClass:
    """實(shí)際生成實(shí)例的類
    """
    foo = "foo"
    def display(self):
        return (id(self))

@singleton
class OtherClass:
    """另一個(gè)類
    """
    pass

裝飾器的實(shí)現(xiàn)過程是將生成的實(shí)例都放到一個(gè)名為_instances_的Dict中映射好，這樣每次在類初始化時(shí)先檢查_instances_中是否已經(jīng)包含有例化好的實(shí)例，有就直接返回是咧，沒有則調(diào)用類初始化一個(gè)并賦值給_instances_列表。裝飾器的好處在于用一個(gè)Dict列表來管理所有需要實(shí)現(xiàn)單例模式的類，更簡便和通用化。代碼的測試結(jié)果如下：

if __name__ == "__main__":
    s1 = MyClass()
    s1.foo = "bar"
    print(s1.display(), s1.foo)
    s2 = MyClass()
    s2.foo = "zoo"
    print(s2.display(), s2.foo)
    assert s1 is s2
    s3 = OtherClass()
    s4 = OtherClass()
    assert s3 is s4

元類

如果希望不僅僅是通過限制而是在源頭上就創(chuàng)建一個(gè)單例類，我們需要用到元類來實(shí)現(xiàn)，元類可以參考Stackoverflow[3]上的一個(gè)解答。簡單的說就是Python中的類也是一種對象，被稱為類對象。類對象可以通過元類type來創(chuàng)建，而在此過程中會調(diào)用type的 __call__ 方法。所以我們只要在type創(chuàng)建類對象的過程中重寫 __call__ 方法，在其中加入相應(yīng)的創(chuàng)建單例的邏輯即可實(shí)現(xiàn)單例模式，具體代碼實(shí)現(xiàn)如下：

#coding=utf-8
class Singleton(type):
    def __call__(cls, *args, **kwargs):
        """重寫，實(shí)現(xiàn)單例模式"""
        if not hasattr(cls, "_instance"):
            cls._instance = super(Singleton, cls).__call__(*args, **kwargs)
        return cls._instance

class MyClass(object):
    # 指定元類
    __metaclass__ = Singleton

    def display(self):
        return (id(self))

代碼的測試與前面類似，這里就不再累述了。

線程安全

最后，需要注意的是單例模式在多線程下可能會出現(xiàn)線程安全的問題，這時(shí)候就需要在單例的初始化過程中加上線程同步鎖來避免，但這樣又會降低整體的性能，具體可以參考這篇文檔。

參考

[1]維基百科
[2]Python官方文檔
[3]Stackoverflow