函数装饰器和类装饰器实现单例类

Posted 2021-03-07

单例类，指的是这个类只能创建一个实例，创建完成后，其他类实例都无法再创建。今天我们来看一下，使用函数装饰器和类装饰器怎么实现这种特殊一点的类。

函数装饰器实现

装饰器算是类里面比较难的内容之一，但是实际上它的思想并不复杂。简单点说，就是在你原来内容的基础上，在外面给你加点东西，实现类似装饰的效果。但是它是怎么实现的呢？一般来说，都是通过拦截函数调用来实现的，比如：用装饰器装饰函数的时候，它拦截函数调用，装饰类的时候，它拦截类实例的创建调用，即拦截类初始化__init__函数。
知道这个原理以后，我们就可以来尝试实现了。

首先来看通过函数装饰器拦截类的创建过程，代码如下：

instance = {}
def createInstance(cls, *args):
    if cls not in instance:
        instance[cls] = cls(*args)
    return instance[cls]

def singleIns(cls):
    def onCall(*args):
        return createInstance(cls, *args)
    return onCall

上面就是这个函数装饰器singleIns的实现，它返回一个函数调用，当用它来装饰一个类，创建类实例的时候，就会用onCall方法拦截类的__init__方法。我们再来看一下它怎么使用的。

@singleIns
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    def __str__(self):
        return "{} 的年龄是{}".format(self.name, self.age)
zhangsan = Person(‘zhangsan‘, 30)
lisi = Person(‘lisi‘, 29)
print(zhangsan)
print(lisi)

最终的输出结果是：

zhangsan 的年龄是30
zhangsan 的年龄是30

为什么结果是一样的？因为在创建实例的过程中，__init__函数被onCall函数拦截，此时会进入到createInstance函数的流程中，会对这个类实例进行判断，如果不存在这个类的实例，那么就初始化一个后返回，如果存在，直接返回第一个创建的类实例。因此最终只有一个类实例存在，就实现类单例类。

类装饰器实现

上面最开始的位置我们说了，函数装饰器和类装饰器都是拦截函数调用，在函数装饰器实现类调用拦截的地方我们看到，它是通过函数装饰器内部的函数来实现拦截的。如果是类装饰器呢，它通过什么来拦截呢？
答案是call函数来拦截，我们来看一下类装饰器的实现代码：

class singleIns:
    def __init__(self, cls):
        self.cls = cls
        self.ins = None
    def __call__(self, *args):
        if self.ins is None:
            self.ins = self.cls(*args)
        return self.ins

代码和函数装饰器相比，其实功能没有太多变化，通过__call__方法来接收被拦截类的初始化函数参数args，然后用args来初始化类实例。但是只在这个类还没有实例的情况下进行初始化，否则直接返会初始化好的类。
我们来看一下应用的代码：

@singleIns
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    def __str__(self):
        return "{} 的年龄是{}".format(self.name, self.age)
zhangsan = Person(‘zhangsan‘, 30)
lisi = Person(‘lisi‘, 29)
print(zhangsan)
print(lisi)

最终的结果和上面函数装饰器的一样，如下所示:

zhangsan 的年龄是30
zhangsan 的年龄是30

以上就是通过函数装饰器和类装饰器实现单例类的两个简单实例，仅做抛砖引玉之说，如果有其他想法或者疑问，可以给我留言一起探讨。