装饰器（python）

装饰器

装饰器(Decorators)是 Python 的一个重要部分。

python装饰器本质上就是一个函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外的功能，装饰器的返回值也是一个函数对象（函数的指针）。

​ Python中装饰器采用的是类似java语言中的AOP(面向切面编程)思想。是属于python语法糖规则。

​ 装饰器函数的外部函数传入我要装饰的函数名字，返回经过修饰后函数的名字；内层函数（闭包）负责修饰被修饰函数。

装饰器本质

是一个函数

参数：是你要装饰的函数名（并非函数调用）

返回：是装饰完的函数名（也非函数调用）

作用：为已经存在的对象添加额外的功能

特点：不需要对对象做任何的代码上的变动

装饰器(decorator)功能

1. 引入日志
2. 函数执行时间统计
3. 执行函数前预备处理
4. 执行函数后清理功能
5. 权限校验等场景
6. 缓存

首先看一个例子：

def hi(name="andy"):
    return "hi " + name

print(hi())

从函数中返回函数

其实并不需要在一个函数里去执行另一个函数，我们也可以将其作为输出返回出来：

def say_hello(name="andy"):
    def greet():
        return "now you are in the greet() function"

    def welcome():
        return "now you are in the welcome() function"

    if name == "dehua":
        return greet
    else:
        return welcome


a = say_hello()
print(a)
# outputs: <function greet at 0x7f2143c01500>

# 上面清晰地展示了`a`现在指向到hi()函数中的greet()函数

​ 再次看看这个代码。在 if/else 语句中我们返回 greet 和 welcome，而不是 greet() 和 welcome()。为什么那样？这是因为当你把一对小括号放在后面，这个函数就会执行

提出问题

我们直接采用返回函数本身就行了啊，为什么还要引入装饰器呢？

比如如下一段代码：

# -*- coding: utf-8 -*-
__author__ = 'sunnychou'
__date__ = '2019/5/18 13:52'

def decorate(func):
    print("before myfunc() called.")
    func()
    print("  after myfunc() called.")
    return func

@decorate
def myfunc():
    print(" myfunc() called.")

myfunc()
myfunc()

​ 这是一个最简单的装饰器的例子，但是这里有一个问题，就是当我们两次调用myfunc()的时候，发现装饰器函数只被调用了一次。为什么会这样呢？

​ 要解释这个就要给出破解装饰器的关键钥匙了。

注意：

这里@decorate这一句，和myfunc = decorate(myfunc)其实是完全等价的，只不过是换了一种写法而已

在Python中函数名是一个指向函数首地址的函数指针

而decorate(myfunc)的返回值就是函数myfunc()的地址，两次调用，第一次被执行，第二次不会进入装饰内部函数执行。

问题：

如何保证两次调用myfunc(), 装饰器都能被调用呢？

解决方案：

采用装饰器

引入装饰器

# -*- coding: utf-8 -*-
__author__ = 'sunnychou'
__date__ = '2019/5/18 13:52'
'''示例2: 使用内嵌包装函数来确保每次新函数都被调用，
内嵌包装函数的形参和返回值与原函数相同，装饰函数返回内嵌包装函数对象'''

def deco(func):
    def _deco():
        print("before myfunc() called.")
        func()
        print("  after myfunc() called.")
        # 不需要返回func，实际上应返回原函数的返回值
    return _deco


@deco
def myfunc():
    print(" myfunc() called.")
    return 'ok'


myfunc()
myfunc()
   #两次调用myfunc()的时候，发现装饰器函数只被调用了一次。为什么会这样呢？
# 要解释这个就要给出破解装饰器的关键钥匙了。

执行此代码，就会发现调用两次myfunc()， 装饰器都会进入，结果正确。

带参数装饰器

让装饰器带参数，和上一示例相比在外层多了一层包装

# -*- coding: utf-8 -*-
__author__ = 'sunnychou'
__date__ = '2019/5/18 13:52'

def deco(arg):
    print(f"1,outer, ######################")
    def _deco(func):
        print("2, inner,#######################")
        def __deco():
            print("before %s called [%s]." % (func.__name__, arg))
            func()
            print("after %s called [%s]." % (func.__name__, arg))
        return __deco
    return _deco

@deco("mymodule")
def myfunc():
    print(" myfunc() called.")

@deco("module2")
def myfunc2():
    print(" myfunc2() called.")


print("start....")
myfunc()
print("$$$$$$$$$$$$$$$$$")
myfunc2()
print("end....")

运行结果如下：

1,outer, ######################
2, inner,#######################
1,outer, ######################
2, inner,#######################
start....
before myfunc called [mymodule].
 myfunc() called.
after myfunc called [mymodule].
$$$$$$$$$$$$$$$$$
before myfunc2 called [module2].
 myfunc2() called.
after myfunc2 called [module2].
end....

通过以上运行结果分析可知：

1. 先执行装饰器外层和中间层逻辑。
2. 通过参数可以控制装饰器里面函数流程是否往下走
3. 装饰器可以在原有函数基础上加上特定逻辑。

案例分析：

通过装饰器统计函数耗时时间