python实现单例模式详解

一、单例模式

意图:保证一个类仅有一个实例,并提供一个访问它的全局访问点。

主要解决:一个全局使用的类频繁地创建与销毁。

何时使用:当您想控制实例数目,节省系统资源的时候。

如何解决:判断系统是否已经有这个单例,如果有则返回,如果没有则创建。

关键代码:构造函数是私有的。

应用实例:

  • 1、一个班级只有一个班主任。
  • 2、Windows 是多进程多线程的,在操作一个文件的时候,就不可避免地出现多个进程或线程同时操作一个文件的现象,所以所有文件的处理必须通过唯一的实例来进行。
  • 3、一些设备管理器常常设计为单例模式,比如一个电脑有两台打印机,在输出的时候就要处理不能两台打印机打印同一个文件。

优点:

  • 1、在内存里只有一个实例,减少了内存的开销,尤其是频繁的创建和销毁实例(比如管理学院首页页面缓存)。
  • 2、避免对资源的多重占用(比如写文件操作)。

缺点:没有接口,不能继承,与单一职责原则冲突,一个类应该只关心内部逻辑,而不关心外面怎么样来实例化。

使用场景:

  • 1、要求生产唯一序列号。
  • 2、WEB 中的计数器,不用每次刷新都在数据库里加一次,用单例先缓存起来。
  • 3、创建的一个对象需要消耗的资源过多,比如 I/O 与数据库的连接等。

二、python实现单例模式错误的示范

在网上看到的一个例子是使用双检锁实现单例模式,这个方法通过重载python对象的__new__ 方法,使得每个类只能被new一次。代码如下:

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)

上面的代码看似实现了单例模式,但是只是实现了一个单例模式的外壳,为什么这么说呢,我们在__init__函数里加一个打印语句看看。

import threading


class Singleton(object):
    _instance_lock = threading.Lock()

    def __init__(self):
        ptint('__init__ is called.')

    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)

运行一下我们就会发现 __init__ 函数调用了两次,这是这段代码最大的问题,每次调用类时 __init__ 函数都会调用一次。虽然类只会被new一次,但是类的属性却会在类的使用过程中被不断覆盖,所以上面的代码只做到了类的单例,但是不能做到属性的单例。

有人说既然这样我把属性全部放在 __new__ 函数里初始化不就行了,这个做法在功能上没有问题,但是却违反了单一职责原则,__new__ 函数并不是负责初始化属性的功能,__init__ 函数才是。

另外上面的代码中将 Singleton 硬编码到了代码中,使得这个类不能被继承,因为当子类调用父类的 __new__ 函数时返回的不是子类的类型。所以我们需要将 Singleton 改成 cls__new__ 函数接受的类的type对象。

三、正确的示范

上面我们提到了 __init__ 函数调用多次的问题,也说明了直接在 __new__ 函数里初始化属性的问题,现在我们就来讨论一下如何正确的用 python实现单例模式。

我们现在面临的问题就是如何让 __init__ 函数只调用一次,最简单的思路就是让 __init__ 函数和 __new__ 函数一样,也使用一个标志和双检锁来确保线程安全和只调用一次,修改后的代码如下:

import threading


class Singleton(object):
    _lock = threading.Lock()

    def __init__(self):
        if not hasattr(self, '_init_flag'):
            with self._lock:
                if not hasattr(self, '_init_flag'):
                    self._init_falg = True
                    # 初始化属性
                    ptint('__init__ is called.')

    def __new__(cls, *args, **kwargs):
        if not hasattr(cls, "_instance"):
            with cls._instance_lock:
                if not hasattr(cls, "_instance"):
                    cls._instance = object.__new__(cls)  
        return cls._instance


obj1 = Singleton()
obj2 = Singleton()
print(obj1,obj2)

现在我们的单例模式总算有点样子了,Singleton 类的 __new____init__ 函数都只会调用一次,并且这些都是线程安全的。

但是这样还不够,按照现在的方法,我们每次要定义一个单例模式的类时都需要手动去修改 __init__ 函数和 __new__ 函数,这有点麻烦。如果我们用的是 Java的话那就没办法了,这些麻烦事必要的,但我们使用的语言是python!

四、使用装饰器实现单例模式

从上一步单例模式的实现来看,我们每次要做到就是修改 __init__ 函数和 __new__ 函数,这简直就是为装饰器量身定做的应用场景。我们可以使用装饰器来替换类的 __init__ 函数和 __new__ 函数,将类原来的函数放在双检锁内部执行。代码如下:

from functools import wraps
import threading


def singleton():
    """
    单例模式装饰器
    :return:
    """
    # 闭包绑定线程锁
    lock = threading.Lock()
    def decorator(cls):
        # 替换 __new__ 函数
        instance_attr = '_instance'
        # 获取原来的__new__函数 防止无限递归
        __origin_new__ = cls.__new__
        @wraps(__origin_new__)
        def __new__(cls_1, *args, **kwargs):
            if not hasattr(cls_1, instance_attr):
                with lock:
                    if not hasattr(cls_1, instance_attr):
                        setattr(cls_1, instance_attr, __origin_new__(cls_1, *args, **kwargs))
            return getattr(cls_1, instance_attr)
        cls.__new__ = __new__
        
        # 替换 __init__函数 原理同上
        init_flag = '_init_flag'
        __origin_init__ = cls.__init__
        @wraps(__origin_init__)
        def __init__(self, *args, **kwargs):
            if not hasattr(self, init_flag):
                with lock:
                    if not hasattr(self, init_flag):
                        __origin_init__(self, *args, **kwargs)
                        setattr(self, init_flag, True)
        cls.__init__ = __init__
        return cls
    return decorator

使用方法非常简单:

@singleton()
class Test:
    def __init__(self):
        # do something
        pass

需要注意的是装饰器要加括号,这是为了给每个类绑定一个线程锁,具体原理与单例模式无关,这里就不赘述了。另外使用了装饰器的类不需要修改 __new__ 函数,和普通的类一样使用就行。关于这个装饰器的具体实现原理我会找时间再写一篇博客。

参考

菜鸟教程-单例模式:https://www.runoob.com/design-pattern/singleton-pattern.html

博客园-听风。-Python中的单例模式的几种实现方式的及优化:https://www.cnblogs.com/huchong/p/8244279.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355