python 装饰器理解

在理解装饰器之前，先应该对闭包有个概念：所谓闭包，就是将组成函数的语句和这些语句的执行环境打包在一起时得到的对象，它的主要作用是封存上下文。这一特性可以巧妙的被用于现有函数的包装，从而为现有函数添加功能，这就是装饰器。

装饰器的本质与作用

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

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

我们先看一个例子，代码如下：

1 2 3 4

#!/usr/bin python   def foo(): print('i am foo')

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

1 2 3

def foo(): print('i am foo') logging.info("foo is running")

此时bar()、bar2()也有类似的需求，再写一个logging在bar函数里？为了提高代码的复用，我们重新定义一个函数：专门处理日志，日志处理完后再执行真正的业务代码：

1 2 3 4 5 6 7 8 9 10

#!/usr/bin python   def use_logging(func): logging.warn("%s is running" % func.__name__) func()   def bar(): print('i am bar')   use_logging(bar)

上述代码虽然解决了，但是我们每次都要将一个函数作为参数传递给use_logging函数，而且这种方式以已经破坏了原有的代码逻辑结构，本来的业务逻辑是执行bar()，但是现在不得已改成执行use_logging(bar)。鉴于这个弊端，Python装饰器应运而生。

简单装饰器

函数use_logging就是装饰器，它把执行真正业务方法的func包裹在函数里面，看起来像bar被use_logging装饰了。

1 2 3 4 5 6 7 8 9 10 11

def use_logging(func): def wrapper(*args,**kwargs): logging.warn("%s is running" % func.__name__) return func(*args,**kwargs) return wrapper   def bar(): print('i am bar')   bar = use_logging(func) bar()

在这个例子中，函数进入和退出时，被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。

但是bar = use_logging(func)这样的写法未免太过麻烦，于是Python提供了一种更优雅的写法：语法糖。@符号是装饰器的语法糖，在定义函数时使用，避免了再一次赋值操作。

1 2 3 4 5 6 7 8 9 10 11 12 13 14

def use_logging(func): def wrapper(*args,**kwargs): logging.warn("%s is running" % func.__name__) return func(*args) return wrapper   @use_logging # 语法糖,等价于:bar=use_logging(bar) def foo(): print('i am foo')   @use_logging def bar(): print('i am bar') bar()

如上所示，直接调用bar()就可以获得结果。如果有其他类似函数，也可以继续调用装饰函数，而不用重复修改或增加新的封装。

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

带参数的装饰器

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14

def use_logging(level): def decorator(func): def wrapper(*args,**kwargs): if level == "warn": logging.warn("%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()

上述的use_logging是允许带参数的装饰器，是对原有装饰器的一次函数封装，并返回一个装饰器。我们可以将它理解为一个含有参数的闭包，当我们调研这个语法糖的时候，Python会发现这一层的封装，并将参数传递到装饰器的环境中。

总结：无参的装饰器参数是要装饰的函数；有参装饰器参数是函数的参数，最后返回的是内部函数。

类装饰器

相比函数装饰器，类装饰器具有高内聚、灵活性大、高封装等优点。使用类装饰器还可以依靠类内部的__call__方法，当使用@将装饰器附加到函数上时 ，就会调用此方法。

1 2 3 4 5 6 7 8 9 10 11 12 13

class foo(object): def __init__(self,func): self._func = func   def __call__(self): print('class decorator running') self._func() print('class decorator ending') @foo def bar(): print('i am bar')   bar()

使用类装饰器极大地复用了代码，但是它也存在缺陷：原函数的元信息不见了，比如函数的docstring、__name__、参数列表，我们先写一个装饰器：

1 2 3 4 5

def logged(func): def with_logging(*args,**kwargs): print func.__name__+"was called" return func(*args,**kwargs) return with_logging

定义一个函数来调用该装饰器：

1 2 3 4

@logged def f(x): """does some math""" return x+x*x

上述函数完全等价于：

1 2 3 4

def f(x): """does some math""" return x+x*x f = logged(f)

可以看出，函数f被with_logging取代了，因此它的docstring、__name__也就变成了with_logging函数的信息了：

1 2	print f.__name__   # print 'with_logging' print f.__doc__    # print None

好在我们有functools.wraps（Python的一个模块），wraps本身就是一个装饰器，它能把原函数的元信息拷贝到装饰器函数中，使得装饰器函数也有和原函数一样的元信息。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

# 导入functools模块中的wraps装饰器 from functools import wraps def logged(func): @wraps(func) def with_logging(*args,**kwagrs): print func.__name__+"was called" return func(*args,**kwargs) return with_logging   @logged def f(x): """does some math""" return x+x*x print f.__name__  # print 'f' print f.__doc__   # print 'does some math'

内置装饰器

在Python中有三个内置的装饰器，都与class相关：

1）staticmethod：类静态方法，其根跟成员方法的区别是没有self参数，并且可以在类不进行实例化的情况下调用。

2）classmethod：与成员方法的区别在于所接收的第一个参数不是self（类实例的指针），而是cls（当前类的具体类型）。

3）property：属性的意思，表示可以通过类实例直接访问的信息。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

class Test(object): def __init__(self,name): self._name = name   @staticmethod def newTest1(name): return Test(name)   @classmethod def newTest2(cls): return Test('')   @property def name(self): return self._name

装饰器的调用顺序

装饰器是可以叠加使用的，那么这就涉及到装饰器的调用顺序。对于Python中的“@”语法糖，装饰器的调用顺序与使用@语法糖的声明顺序相反。

1 2 3 4 5 6 7 8 9

# 装饰器的声明顺序   @a @b @c def f():     pass # 等效于 f = a(b(c(f)))    # 以c、b、a的顺序调用