前言

使用python實(shí)現(xiàn)設(shè)計(jì)模式中的單例模式。單例模式是一種比較常用的設(shè)計(jì)模式，其實(shí)現(xiàn)和使用場(chǎng)景判定都是相對(duì)容易的。本文將簡(jiǎn)要介紹一下python中實(shí)現(xiàn)單例模式的幾種常見(jiàn)方式和原理。一方面可以加深對(duì)python的理解，另一方面可以更加深入的了解該模式，以便實(shí)際工作中能更加靈活的使用單例設(shè)計(jì)模式。

本文將介紹常見(jiàn)的實(shí)現(xiàn)單例模式的幾種方式，這里暫不考慮多線程的情況。

為了準(zhǔn)備該篇博文，之前寫了幾篇相關(guān)的文章依次完整的介紹了相關(guān)的概念，下面會(huì)在需要的時(shí)候給出鏈接。

裝飾器作為python實(shí)現(xiàn)單例模式的一種常用方法，先簡(jiǎn)單了解一下其概念。

1.裝飾器

裝飾器(Decorator)可以用作對(duì)函數(shù)以及類進(jìn)行二次包裹或者封裝，使用方式@wrapper。

def f(...):
  ...
f = staticmethod(f)
@staticmethod
def f(...):
  ...

上面這兩種方式對(duì)函數(shù)的定義在語(yǔ)法上是等價(jià)的。當(dāng)然對(duì)于類也有同樣的用法，類可以作為裝飾器也可以作為被裝飾對(duì)象。唯一的區(qū)別就是經(jīng)過(guò)包裹的類可能不在是一個(gè)類，而是一個(gè)類的對(duì)象或者一個(gè)函數(shù)，這取決于裝飾器返回的值。

經(jīng)過(guò)Decorator裝飾的類或者函數(shù)本質(zhì)上已經(jīng)不再是原來(lái)的類或者函數(shù)了。但是，實(shí)際上在包裹之后得到的新對(duì)象仍然擁有被包裹對(duì)象的特性（這句是不是廢話：-））。

在python中我們經(jīng)常只需要實(shí)現(xiàn)一個(gè)裝飾器，然后使用該裝飾器作用于只能有唯一一個(gè)實(shí)例的類。這樣只需要實(shí)現(xiàn)一個(gè)這樣的裝飾器，便可以作用于任何一個(gè)想要唯一實(shí)例的類。

2.閉包方式

閉包的應(yīng)用很多，單例模式則是其應(yīng)用之一。先看代碼：

def singleton(cls):
  instances = {}  
  def getinstance(*args, **kwargs):
    if cls not in instances:
      instances[cls] = cls(*args, **kwargs)
    return instances[cls]
  return getinstance
@singleton
class my_cls(object):
  pass

這個(gè)實(shí)現(xiàn)單例模式的方式將原來(lái)類的定義隱藏在閉包函數(shù)中，通過(guò)閉包函數(shù)及其中引用的自由變量來(lái)控制類對(duì)象的生成。由于唯一的實(shí)例存放在自由變量中，而且自由變量是無(wú)法直接在腳本層進(jìn)行訪問(wèn)的。這種方式非常隱蔽的保護(hù)實(shí)例不被修改，因此很適合用于單例模式。

這種方式簡(jiǎn)單明了，很容易實(shí)現(xiàn)。但是如果不了解閉包實(shí)現(xiàn)過(guò)程和變量的綁定等概念可能會(huì)不明白其實(shí)現(xiàn)的過(guò)程。建議參考一下我的另一篇博文：理解python閉包概念。

這里一個(gè)很有趣的地方是為什么要使用instances = {}這樣一個(gè)變量？可不可以不用字典，使用instance = None？如果singleton作為裝飾器被多個(gè)不同的類使用，那么instance中會(huì)存在幾個(gè)不同的實(shí)例么？

有時(shí)間可以思考一下這幾個(gè)問(wèn)題，答案也可以在我寫的閉包相關(guān)的博文中找到。

3.元類方式

所謂單例模式，即我們需要控制類實(shí)例的生成過(guò)程，并且保證全局只可能存在一個(gè)唯一的實(shí)例。既然需要在創(chuàng)建類的對(duì)象過(guò)程中做些什么，應(yīng)該很容易想到元類。

class Singleton(type):
  def __init__(cls, name, bases, dic):
    super(Singleton, cls).__init__(name, bases, dic)
    cls._instance = None
  def __call__(cls, *args, **kwargs):
    if cls._instance is None:
      cls._instance = super(Singleton, cls).__call__(*args, **kwargs)
      # cls._instance = cls(*args, **kwargs)  # Error! Lead to call this function recursively
    return cls._instance

class my_cls(object):
  __metaclass__ = Singleton

這個(gè)例子中我們使用元類Singleton替代默認(rèn)使用type方式創(chuàng)建類my_cls?？梢詫㈩恗y_cls看做是元類Singleton的一個(gè)對(duì)象，當(dāng)我們使用my_cls(...)的方式創(chuàng)建類my_cls的對(duì)象時(shí)，實(shí)際上是在調(diào)用元類Singleton的對(duì)象my_cls。

對(duì)象可以以函數(shù)的方式被調(diào)用，那么要求類中定義__call__函數(shù)。不過(guò)此處被調(diào)用的是類，因此我們?cè)谠愔卸x函數(shù)__call__來(lái)控制類my_cls對(duì)象創(chuàng)建的唯一性。

這種方式的弊端之一就是類唯一的對(duì)象被存放在類的一個(gè)靜態(tài)數(shù)據(jù)成員中，外部可以通過(guò)class_name._instance的方式修改甚至刪除這個(gè)實(shí)例(該例中my_cls._instance = None完全合法)。

4.類作為裝飾器之__call__方式

不僅函數(shù)可以作為裝飾器，類也可以作為裝飾器。

下面簡(jiǎn)單的介紹一下使用類作為裝飾器實(shí)現(xiàn)單例模式的另一種方式。

class Singleton(object):
  _INSTANCE = {}
  def __init__(self, cls):
    self.cls = cls    
  def __call__(self, *args, **kwargs):
    instance = self._INSTANCE.get(self.cls, None)
    if not instance:
      instance = self.cls(*args, **kwargs)
      self._INSTANCE[self.cls] = instance
    return instance  
  def __getattr__(self, key):
    return getattr(self.cls, key, None)
@Singleton
class my_cls(object):
  pass

函數(shù)作為裝飾器返回的是一個(gè)函數(shù)，函數(shù)被調(diào)用過(guò)程中實(shí)際上是間接地調(diào)用其內(nèi)部包裹的被裝飾的對(duì)象。

類作為裝飾器要想達(dá)到相同的效果只需要將類的對(duì)象返回，并且其對(duì)象是可以調(diào)用的。這是上面這個(gè)例子表達(dá)的一個(gè)核心思想。

這種方式寫法很多，也很靈活，其思想基本上就是對(duì)被包裹對(duì)象的調(diào)用實(shí)際上調(diào)用的是類對(duì)象的__call__函數(shù)，該函數(shù)實(shí)際上是對(duì)被裝飾對(duì)象的一次封裝。

5.類本身實(shí)現(xiàn)方式

上面的例子中我們都是使用的裝飾器或者元類的方式間接的通過(guò)控制類對(duì)象生成的方式來(lái)保證對(duì)象的唯一性，那么有沒(méi)有辦法直接在類中通過(guò)某種方式保證類對(duì)象的唯一性？

答案是肯定的。參考我之前寫的一篇介紹元類的文章，可知生成對(duì)象前會(huì)調(diào)用函數(shù)__new__，如果__new__函數(shù)返回被創(chuàng)建的對(duì)象，那么會(huì)自動(dòng)調(diào)用類中定義的__init__函數(shù)進(jìn)行對(duì)象的初始化操作。

相信讀了上面這句話，應(yīng)該知道我們接下來(lái)要干什么了？沒(méi)錯(cuò)，我們的目標(biāo)就是__new__。

class MSC(object):
  _INSTANCE = None
  def __new__(cls, *args, **kwargs):
    if not cls._INSTANCE:
      cls._INSTANCE = super(MSC, cls).__new__(cls, *args, **kwargs)
      # cls._INSTANCE.args = args
      # cls._INSTANCE.kwargs = kwargs
    return cls._INSTANCE
  def __init__(self, *args, **kwargs):
    pass

在這個(gè)例子中，我們完全可以理解為什么只會(huì)有一個(gè)類的對(duì)象會(huì)被創(chuàng)建。這種方式的定義決定了類本身只能被創(chuàng)建一個(gè)對(duì)象。

但是這里有一點(diǎn)需要注意，那就是不管創(chuàng)建多少M(fèi)SC的對(duì)象，至始至終只會(huì)有一個(gè)對(duì)象，但是如果每次創(chuàng)建的時(shí)候傳入的參數(shù)都不同，也就是__init__函數(shù)中參數(shù)不同，會(huì)導(dǎo)致同一個(gè)對(duì)象被多次初始化。

這種方式的弊端顯然很明顯，那就是該方法只能作用于單個(gè)類的定義。不能像上面的裝飾器和元類，一次實(shí)現(xiàn)，可以到處使用。

那能不能將這個(gè)控制類生成過(guò)程的結(jié)構(gòu)單獨(dú)抽象出來(lái)呢？而且有沒(méi)有什么方法能防止同一個(gè)對(duì)象多次被__init__初始化。下面我們看一種能被不同的類使用的更加抽象的結(jié)構(gòu)。

6.替換__new__方式

我們定義的類作為一個(gè)對(duì)象，通過(guò)替換其部分屬性可以達(dá)到控制類對(duì)象生成的目的。

def Singleton(cls):
  _instance = {}
  cls._origin_new = cls.__new__
  cls._origin_init = cls.__init__
  @functools.wraps(cls.__new__)
  def _singleton_new(cls, *args, **kwargs):
    if cls not in _instance:
      sin_instance = cls._origin_new(cls, *args, **kwargs)
      sin_instance._origin_init(*args, **kwargs)
      _instance[cls] = sin_instance
    return _instance[cls]
  # As a special case,__new__ is a staticmethod, need convert function to staticmethod by self 
  cls.__new__ = staticmethod(_singleton_new)
  # setattr(cls, '__new__', staticmethod(_singleton_new))
  cls.__init__ = lambda self, *args, **kwargs: None
  # setattr(cls, '__init__', lambda self, *args, **kwargs: None)
  return cls
@Singleton
class my_cls(object):
  pass

上面我們通過(guò)替換類的__new__函數(shù)和__init__函數(shù)的方式，保證被Singleton裝飾的類只有一個(gè)對(duì)象會(huì)被原來(lái)的__new__和__init__生成和初始化。

這里必須要替換類的__init__函數(shù)，而且該函數(shù)應(yīng)該什么都不做。原因在于替換之后的__new__返回唯一的對(duì)象后，會(huì)自動(dòng)調(diào)用現(xiàn)在的__init__函數(shù)。

原來(lái)的__init__函數(shù)已經(jīng)在創(chuàng)建唯一一個(gè)對(duì)象時(shí)被調(diào)用過(guò)。而且只能被調(diào)用一次。

這里返回的并不是閉包結(jié)構(gòu)，只是使用裝飾器修改了類的部分屬性，返回的仍是傳入的類。但是類的__new__函數(shù)引用了Singleton中的local variable _instance。

my_cls.__new__.func_closure[0].cell_contents 
== 
{<class '__main__.my_cls'>: <__main__.my_cls object at 0x02954810>}
==
_instance

Cell 對(duì)象my_cls.__new__.func_closure[0]中存放的便是類my_cls唯一的實(shí)例。

當(dāng)然我們可以將my_cls唯一的對(duì)象作為類的一個(gè)靜態(tài)數(shù)據(jù)成員放入cls.__dict__中來(lái)替代_instance = {}，但是顯然閉包結(jié)構(gòu)更適合。

7.注意事項(xiàng)

文中借助python語(yǔ)言的類創(chuàng)建對(duì)象過(guò)程的相關(guān)原理，介紹了幾種不同的單例模式實(shí)現(xiàn)方式。

為了保留被裝飾對(duì)象的一些屬性，可以使用@functools.wraps的方式對(duì)返回的閉包進(jìn)行裝飾。

平時(shí)建議使用前兩種實(shí)現(xiàn)方式，也就是閉包方式和元類方式。其他情況多少有點(diǎn)玩弄python語(yǔ)法技巧的一些嫌疑，當(dāng)然了，作為學(xué)習(xí)python來(lái)說(shuō)還是比較有意義的。

建議多關(guān)注語(yǔ)言特性的應(yīng)用以及如何的解決實(shí)際的問(wèn)題，不要沉迷于語(yǔ)言實(shí)現(xiàn)的一些細(xì)枝末節(jié)。本末倒置總會(huì)有些得不償失嘛。尤其是python作為一種非常實(shí)用的語(yǔ)言。

本文介紹中如果有什么不當(dāng)之處歡迎指正，如果有其他的更好的實(shí)現(xiàn)方式也請(qǐng)不吝賜教。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論