装饰器

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

前言

为何要用装饰器？软件设计应该遵循“开放封闭”原则，即对扩展是开放的，而对修改则是封闭的。对扩展开放，意味着有新的需求或变化时，可以对现有代码进行扩展，以适应新的情况。对修改封闭，意味着对象一旦设计完成，就可以独立工作，而不要对其进行修改。
这里的封闭，避免修改有两层意思，即：功能的源代码以及调用方式，都应该避免修改，否则一旦改错，则极有可能产生连锁反应，最终导致程序崩溃，而对于上线后的软件，新需求或者变化又层出不穷，我们必须为程序提供扩展的可能性，这就用到了装饰器。

一、什么是装饰器

“装饰”代指为被装饰对象添加新的功能，“器”代指器具或者工具，装饰器与被装饰对象均可以是任意可调用对象。
概括地讲，装饰器的作用就是在不修改被装饰对象源代码和调用方式的前提下为被装饰对象添加额外的功能。装饰器经常用于有切面需求的场景，比如：插入日志、性能测试、缓存、权限校验等应用场景，装饰器是解决这类问题的绝佳设计，有了装饰器，就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。

二、装饰器的实现

函数装饰器分为：无参装饰器和有参装饰器两种，二者的实现原理一样，都是“函数嵌套+闭包+函数对象”的组合使用的产物。

2.1 无参装饰器的实现

如果想为下述函数添加统计其执行时间的功能

import time

def index():
    time.sleep(3)
    print("welcome to the index page")
    return 200
index()

在不修改源代码的前提下，直接想法可能是：

start = time.time()
index()
end = time.time()
print("run time is %s"%(end-start))

但如果有很多函数都需要调用的时候，每次都需要写入雷同的代码，是否可以做个独立的工具呢？

def wrapper(func):
    start = time.time()
    func()
    end = time.time()
    print("run time is %s"%(end-start))

调用方式：

wrapper(index)
wrapper(other)

从调用方式可以看到虽然没有改变源代码，但修改了调用方式，依然违背了封闭原则。那怎么办呢？这里我们就可以用到闭包的技巧，除了直接给函数传值以外，还可以将值包给函数，如下：

def timer(func):
    def wrapper():
        start = time.time()
        res = func()
        end = time.time()
        print("run time is %s"%(end-start))
        return res
    return wrapper

这样我们便可以在不修改被装饰函数源代码和调用方式的前提下为其加上统计时间的功能，只不过需要事先执行一次timer将被装饰的函数传入，返回一个闭包函数wrapper重新赋值给变量名/函数名index,如下：

index = timer(index)  #得到index=wrapper,wrapper携带对外作用域的引用，func=原始的index
index()  # 执行的是wrapper(),在wrapper的函数体内再执行最原始的index

至此我们便实现了一个无参装饰器timer，可以在不修改该被装饰对象index源代码和调用方式的前提下为其加上新功能。但若被装饰的函数是一个有参函数，便会抛出异常。

def home(name):
    time.time(2)
    print("welcome to %s page"%name)

home=home("alex")
home()

# TypeError: time() takes no arguments (1 given)

之所以会抛出异常，是因为home(“alex”)调用的其实是wrapper(“alex”),而函数wrapper没有参数。wrapper函数接收的参数其实是给最原始的func用的，为了能满足被装饰函数参数的所有情况，可以使用*args+**kwargs的组合，代码如下：

def timer(func):
    def wrapper(*args,**kwargs):
        start = time.time()
        res = func(*args,**kwargs)
        end = time.time()
        print("run time is %s"%(end-start))
        return res
    return wrapper

此时我们就可以用timer来装饰带参数或者不带参数的函数了，但是为了简洁而优雅地使用装饰器，python提供了专门的装饰器语法来取代index = timer(index)的形式，需要在被装饰对象的正上方单独添加@timer,当解释器解释@timer时就会调用timer函数，且把它正下方的函数名当做实参传入，然后将返回的结果重新赋值给原函数名

@timer
def index():
    time.sleep(3)
    print("welcome to the index page")
    return 200

index()

如果我们有多个装饰器，可以叠加多个

@deco3
@deco2
@deco1
def index():
    pass

叠加多个装饰器也无特殊之处，上述代码含义如下：

index = deco3(deco2(deco1(index)))

2.2 有参装饰器的实现

了解无参装饰器的实现原理后，我们可以再实现一个用来为被装饰对象添加认证功能的装饰器，实现的基本形式如下：

def deco():
    def wrapper():
        #编写基于文件的认证，认证通过则执行 res = func(*args,**kwargs),并返回res
    return wrapper