python---装饰器

前言

在讲装饰器之前，我们需要了解的知识：（1）函数的作用域 （2）高阶函数（3）闭包（闭包=函数块+定义函数是的环境）

一 装饰器简介

1.1 装饰器的概念

　　装饰器本质上是一个函数，该函数用来处理其他函数，它可以让其他函数在不需要修改代码的前提下增加额外的功能，装饰器的返回值也是一个函数对象。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等应用场景。装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。

1.2 装饰器的引入

先来看一个简单例子：

def foo():
    print('i am foo')

现在有一个新的需求，希望可以记录下函数的执行时间，于是在代码中添加：

import time
def foo():
    start=time.time()
    print('i am foo')
    time.sleep(1)
    end=time.time()
    print('代码执行时间：%s'%(end-start))
foo()

>>>i am foo
>>>代码执行时间：1.0009090900421143

注：因为执行语句就一个print函数，时间太短，统计时输出为0，所以加入了time.sleep(1）延时一秒

bar()也有类似的需求，怎么做？再在bar函数里调用时间函数？这样就造成大量雷同的代码，为了减少重复写代码，我们可以这样做，重新定义一个函数：专门设定时间 

import time
def show_time(func):
    start=time.time()
    func()
    end=time.time()
    print('代码执行时间：%s'%(end-start))
def bar():
    print('i am bar')
    time.sleep(1)
show_time(bar)

>>>i am bar
>>>代码执行时间：1.0005669593811035

　　逻辑上不难理解，而且运行正常。 但是这样的话，我们每次都要将一个函数作为参数传递给show_time函数。而且这种方式已经破坏了原有的代码逻辑结构，之前执行业务逻辑时，执行运行bar()，但是现在不得不改成show_time(bar)。那么有没有更好的方式的呢？当然有，答案就是装饰器。

二 简单装饰器

  if  bar()==show_time(bar) :问题解决!  

   所以，我们需要show_time(bar)返回一个函数对象，而这个函数对象内则是核心业务函数:func()与装饰函数：两个时间函数，修改如下：

import time

def show_time(func):
    def inner():
        start=time.time()
        func()
        end=time.time()
        print('代码执行时间：%s'%(end-start))
    return inner

def bar():
    print('i am bar')
    time.sleep(1)

bar=show_time(bar)
bar()

>>>i am bar
>>>代码执行时间：1.0000889301300049

　　函数show_time就是装饰器，它把真正的业务方法func包裹在函数里面，看起来像bar被上下时间函数装饰了。在这个例子中，函数进入和退出时 ，被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。

在更近一步精简代码（@符号是装饰器的语法糖，在定义函数的时候使用，避免再一次赋值操作bar=show_time(bar))

import time

def show_time(func):
    def inner():
        start=time.time()
        func()
        end=time.time()
        print('代码执行时间：%s'%(end-start))
    return inner
@show_time #bar=show_time(bar)
def bar():
    print('i am bar')
    time.sleep(1)

bar()

>>>i am bar
>>>代码执行时间：1.0000882148742676

　　如上所示，这样我们就可以省去bar = show_time(bar)这一句了，直接调用bar()即可得到想要的结果。如果我们有其他的类似函数，我们可以继续调用装饰器来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。

总结：

@show_time帮我们做的事情就是当我们执行业务逻辑bar()时，执行的代码由蓝框部分转到红框部分。

装饰器在Python使用如此方便都要归因于Python的函数能像普通的对象一样能作为参数传递给其他函数，可以被赋值给其他变量，可以作为返回值，可以被定义在另外一个函数内。

三 带参数的被修饰函数

固定参数的函数

import time

def show_time(func):
    def inner(x,y):
        start=time.time()
        func(x,y)
        end=time.time()
        print('代码执行时间：%s'%(end-start))
    return inner

@show_time #bar=show_time(bar)
def add(a,b):
    print(a+b)
    time.sleep(1)

add(1,2)

>>>3
>>>代码执行时间：1.0003349781036377

参数个数可变

import time

def show_time(func):
    def inner(*args,**kwargs):
        start=time.time()
        func(*args,**kwargs)
        end=time.time()
        print('代码执行时间：%s'%(end-start))
    return inner

@show_time #bar=show_time(bar)
def add(*args,**kwargs):
    sums=0
    for i in args:
        sums+=i
        time.sleep(1)
    print(sums)

add(1,2,3,4,5,6)

>>>21
>>>代码执行时间：6.002350091934204

四 带参数的装饰器

　　装饰器还有更大的灵活性，例如带参数的装饰器：在上面的装饰器调用中，比如@show_time，该装饰器唯一的参数就是执行业务的函数。装饰器的语法允许我们在调用时，提供其它参数，比如@decorator(a)。这样，就为装饰器的编写和使用提供了更大的灵活性。

import time

def logger(flag=''):
    def show_time(func):
        def inner(*args,**kwargs):
            start=time.time()
            func(*args,**kwargs)
            end=time.time()
            if flag=='true':
                print('代码执行时间：%s'%(end-start))
        return inner
    return show_time

@logger(flag='true') #add = show_time(add)
def add(*args,**kwargs):
    sums=0
    for i in args:
        sums+=i
        time.sleep(1)
    print(sums)

add(1,2)

>>>3
>>>代码执行时间：2.0012199878692627

注：如果参数不是flag=‘true’，则输出没有：代码执行时间：2.0012199878692627

　　上面的logger是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装，并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我 们使用@logger("true")调用的时候，Python能够发现这一层的封装，并把参数传递到装饰器的环境中。

参考：https://www.cnblogs.com/yuanchenqi/articles/5694897.html