如何理解python的装饰器

先来个形象比方
内裤可以用来遮羞,但是到了冬天它没法为我们防风御寒,聪明的人们发明了长裤,有了长裤后宝宝再也
不冷了,装饰器就像我们这里说的长裤,在不影响内裤作用的前提下,给我们的身子提供了保暖的功效。
再回到我们的主题
装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装
饰器的返回值也是一个函数对象。它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处
理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量与
函数功能本身无关的雷同代码并继续重用。概括的讲,装饰器的作用就是为已经存在的对象添加额外的功
能。
先来看一个简单例子:

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

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

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

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

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)。那么有没有更好的方式的呢?当然有,答案就是装饰器。

使用装饰器

假设decorator是定义好的装饰器。
方法一:不用语法糖@符号

#装饰器不传入参数时
f = decorator(函数名)
#装饰器传入参数时
f = (decorator(参数))(函数名)

方法二:采用语法糖@符号

#已定义的装饰器
@decorator 
def f(): 
 pass
#执行被装饰过的函数
f(

简单装饰器

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(bar)
bar()

函数use_logging就是装饰器,它把执行真正业务方法的func包裹在函数里面,看起来像bar被
use_logging装饰了。在这个例子中,函数进入和退出时 ,被称为一个横切面(Aspect),这种编程方式被
称为面向切面的编程(Aspect-Oriented Programming)。
@符号是装饰器的语法糖,在定义函数的时候使用,避免再一次赋值操作

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

如上所示,这样我们就可以省去bar = use_logging(bar)这一句了,直接调用bar()即可得到想要的结果。
如果我们有其他的类似函数,我们可以继续调用装饰器来修饰函数,而不用重复修改函数或者增加新的封
装。这样,我们就提高了程序的可重复利用性,并增加了程序的可读性。
装饰器在Python使用如此方便都要归因于Python的函数能像普通的对象一样能作为参数传递给其他函数,
可以被赋值给其他变量,可以作为返回值,可以被定义在另外一个函数内。

带参数的装饰器

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

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是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装,并返回一个装饰
器。我们可以将它理解为一个含有参数的闭包。当我 们使用@use_logging(level=“warn”)调用的时候,
Python能够发现这一层的封装,并把参数传递到装饰器的环境中。

类装饰器

再来看看类装饰器,相比函数装饰器,类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器还
可以依靠类内部的__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__ + " was called"
 	return func(*args, **kwargs)
 return with_logging

函数

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

该函数完成等价于:

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

不难发现,函数f被with_logging取代了,当然它的docstring,__name__就是变成了with_logging函数的
信息了。

print f.__name__ # prints 'with_logging'
print f.__doc__ # prints None

这个问题就比较严重的,好在我们有functools.wraps,wraps本身也是一个装饰器,它能把原函数的元信
息拷贝到装饰器函数中,这使得装饰器函数也有和原函数一样的元信息了。

from functools import wraps
def logged(func):
	@wraps(func)
	def with_logging(*args, **kwargs):
		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__ # prints 'f'
print f.__doc__ # prints 'does some math'

内置装饰器

@staticmathod、@classmethod、@property

装饰器的顺序

@a
@b
@c
def f ():

等效于

f = a(b(c(f))
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值