1. 程式人生 > >詳解python中的單例模式以及其實現方法

詳解python中的單例模式以及其實現方法

原文出處單例模式

單例模式

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

比如,某個伺服器程式的配置資訊存放在一個檔案中,客戶端通過一個 AppConfig 的類來讀取配置檔案的資訊。如果在程式執行期間,有很多地方都需要使用配置檔案的內容,也就是說,很多地方都需要建立 AppConfig 物件的例項,這就導致系統中存在多個 AppConfig 的例項物件,而這樣會嚴重浪費記憶體資源,尤其是在配置檔案內容很多的情況下。事實上,類似 AppConfig 這樣的類,我們希望在程式執行期間只存在一個例項物件。

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

  • 使用模組
  • 使用 __new__
  • 使用裝飾器(decorator)
  • 使用元類(metaclass)

使用模組

其實,Python 的模組就是天然的單例模式,因為模組在第一次匯入時,會生成 .pyc 檔案,當第二次匯入時,就會直接載入 .pyc 檔案,而不會再次執行模組程式碼。因此,我們只需把相關的函式和資料定義在一個模組中,就可以獲得一個單例物件了。如果我們真的想要一個單例類,可以考慮這樣做:

1

2

3

4

5

6

# mysingleton.py

class My_Singleton(object):

    def foo(self):

        pass

my_singleton = My_Singleton()

將上面的程式碼儲存在檔案 mysingleton.py 中,然後這樣使用:

1

2

3

from mysingleton import my_singleton

my_singleton.foo()

使用 __new__

為了使類只能出現一個例項,我們可以使用 __new__ 來控制例項的建立過程,程式碼如下:

1

2

3

4

5

6

7

8

9

class Singleton(object):

    _instance = None

    def __new__(cls, *args, **kw):

        if not cls._instance:

            cls._instance = super(Singleton, cls).__new__(cls, *args, **kw)  

        return cls._instance  

class MyClass(Singleton):  

    a = 1

在上面的程式碼中,我們將類的例項和一個類變數 _instance 關聯起來,如果 cls._instance 為 None 則建立例項,否則直接返回 cls._instance

執行情況如下:

1

2

3

4

5

6

7

8

>>> one = MyClass()

>>> two = MyClass()

>>> one == two

True

>>> one is two

True

>>> id(one), id(two)

(4303862608, 4303862608)

使用裝飾器

我們知道,裝飾器(decorator)可以動態地修改一個類或函式的功能。這裡,我們也可以使用裝飾器來裝飾某個類,使其只能生成一個例項,程式碼如下:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

from functools import wraps

def singleton(cls):

    instances = {}

    @wraps(cls)

    def getinstance(*args, **kw):

        if cls not in instances:

            instances[cls] = cls(*args, **kw)

        return instances[cls]

    return getinstance

@singleton

class MyClass(object):

    a = 1

在上面,我們定義了一個裝飾器 singleton,它返回了一個內部函式 getinstance,該函式會判斷某個類是否在字典 instances 中,如果不存在,則會將 cls 作為 key,cls(*args, **kw) 作為 value 存到 instances 中,否則,直接返回 instances[cls]

使用 metaclass

元類(metaclass)可以控制類的建立過程,它主要做三件事:

  • 攔截類的建立
  • 修改類的定義
  • 返回修改後的類

使用元類實現單例模式的程式碼如下:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

class Singleton(type):

    _instances = {}

    def __call__(cls, *args, **kwargs):

        if cls not in cls._instances:

            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)

        return cls._instances[cls]

# Python2

class MyClass(object):

    __metaclass__ = Singleton

# Python3

# class MyClass(metaclass=Singleton):

#    pass

小結

  • Python 的模組是天然的單例模式,這在大部分情況下應該是夠用的,當然,我們也可以使用裝飾器、元類等方法

本文由 funhacks 發表於個人部落格,採用 Creative Commons BY-NC-ND 4.0(自由轉載-保持署名-非商用-禁止演繹)協議釋出。
非商業轉載請註明作者及出處。商業轉載請聯絡作者本人。
本文標題為: Python 中的單例模式
本文連結為: https://funhacks.net/2017/01/…

參考資料