python装饰器

装饰器本质上是一个 Python 函数或类，它可以让其他函数或类在不需要做任何代码修改的前提下增加额外功能，装饰器的返回值也是一个函数/类对象

Python 中的函数可以像普通变量一样当做参数传递给另外一个函数，也可以把一个函数作为返回值，这类函数被称为高阶（Higher-order）函数

它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景，装饰器是解决这类问题的绝佳设计。有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码到装饰器中并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能

举例说明

def foo():
    print('i am foo')
## 现在有一个新的需求，希望可以记录下函数的执行日志，于是在代码中添加日志代码：
def foo():
    print('i am foo')
    logging.info("foo is running")  

如果函数foo1()、foo2() 也有类似的需求，我们要再写一个 logging 在 bar 函数里？这样就造成大量雷同的代码，为了减少重复写代码，我们可以这样做，重新定义一个新的函数：专门处理日志 ，日志处理完之后再执行真正的业务代码

def use_logging(func):
    logging.warn("%s is running" % func.__name__)
    func()
​
def foo():
    print('i am foo')
​
use_logging(foo)
​

这样做逻辑上是没问题的，功能是实现了，但是我们调用的时候不再是调用真正的业务逻辑 foo 函数，而是换成了 use_logging 函数，这就破坏了原有的代码结构，我们可以采用更好的方式实现，就是装饰器

装饰器

简单装饰器

## 还是上面的例子
def use_logging(func):
​
    def wrapper():
        logging.warn("%s is running" % func.__name__)
        # 把foo当做参数传递进来时，执行func()就相当于执行foo()
        return func()   
    return wrapper
​
def foo():
    print('i am foo')
# 因为装饰器 use_logging(foo) 返回的时函数对象 wrapper，这条语句相当于  foo = wrapper
foo = use_logging(foo) 
 # 执行foo()就相当于执行 wrapper()
foo()             
​
​
## use_logging 就是一个装饰器，它一个普通的函数，它把执行真正业务逻辑的函数 func 包裹在其中，看起来像 foo 被 use_logging 装饰了一样，use_logging 返回的也是一个函数，这个函数的名字叫 wrapper。在这个例子中，函数进入和退出时 ，被称为一个横切面，这种编程方式被称为面向切面的编程

@语法

通过使用@，我们可以省去foo = use_logging(foo)这一句，直接调用 foo() 即可得到想要的结果

def use_logging(func):
​
    def wrapper():
        logging.warn("%s is running" % func.__name__)
        return func()
    return wrapper
​
@use_logging
def foo():
    print("i am foo")
    
foo()
​
## foo() 函数不需要做任何修改，只需在定义的地方加上装饰器，调用的时候还是和以前一样，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性

带参数的装饰器

 

装饰器还有更大的灵活性，比如，因为不同业务函数可能需要的日志级别是不一样的，我们可以在装饰器中指定日志的等级

def use_logging(level):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if level == "warn":
                logging.warn("%s is running" % func.__name__)
            elif level == "info":
                logging.info("%s is running" % func.__name__)
            return func(*args)
        return wrapper
​
    return decorator
​
@use_logging(level="warn")
def foo(name='foo'):
    print("i am %s" % name)
​
foo()

类装饰器

装饰器不仅可以是函数，还可以是类，相比函数装饰器，类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器主要依靠类的—call—方法，当使用 @ 形式将装饰器附加到函数上时，就会调用此方法

class Foo(object):
    def __init__(self, func):
        self._func = func
​
    def __call__(self):
        print ('class decorator runing')
        self._func()
        print ('class decorator ending')
​
@Foo
def bar():
    print ('bar')
​
bar()

functools.wraps

使用装饰器极大地复用了代码，但是他有一个缺点就是原函数的元信息不见了，比如函数的docstring、__name__、参数列表

# 装饰器
def logged(func):
    def with_logging(*args, **kwargs):
        print func.__name__      # 输出 'with_logging'
        print func.__doc__       # 输出 None
        return func(*args, **kwargs)
    return with_logging
​
# 函数
@logged
def f(x):
   """does some math"""
   return x + x * x
​
logged(f)
​
## 可以看到函数 f 被with_logging取代了

可以用functools.wraps，wraps本身也是一个装饰器，它能把原函数的元信息拷贝到装饰器里面的 func 函数中，这使得装饰器里面的 func 函数就有和原函数 foo 一样的元信息

from functools import wraps
def logged(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print func.__name__      # 输出 'f'
        print func.__doc__       # 输出 'does some math'
        return func(*args, **kwargs)
    return with_logging
​
@logged
def f(x):
   """does some math"""
   return x + x * x

装饰器顺序

一个函数还可以同时定义多个装饰器，比如：

@a
@b
@c
def f ():
    pass

它的执行顺序是从里到外，最先调用最里层的装饰器，最后调用最外层的装饰器，它等效于

f = a(b(c(f)))