商业网站开发模式,wordpress评论删除站点,企业官网,什么是电商直播在理解装饰器之前#xff0c;先应该对闭包有个概念#xff1a;所谓闭包#xff0c;就是将组成函数的语句和这些语句的执行环境打包在一起时得到的对象#xff0c;它的主要作用是封存上下文。这一特性可以巧妙的被用于现有函数的包装#xff0c;从而为现有函数添加功能先应该对闭包有个概念所谓闭包就是将组成函数的语句和这些语句的执行环境打包在一起时得到的对象它的主要作用是封存上下文。这一特性可以巧妙的被用于现有函数的包装从而为现有函数添加功能这就是装饰器。
装饰器的本质与作用
装饰器(Decorator)的本质是一个Python函数它可以让其他函数在不需要做任何代码变动的前提下增加额外的功能装饰器的返回值也是一个函数对象。
它经常用于有切面需求的场景 比如插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计有了装饰器我们就可以抽离出大量与函数功能本身无关的雷同代码并继续复用。
我们先看一个例子代码如下1
2
3
4#!/usr/bin python
deffoo():
print(i am foo)
现在有一个新的需求希望可以记录下函数的执行日志于是在代码中添加了日志代码1
2
3deffoo():
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
defuse_logging(func):
logging.warn(%s is running%func.__name__)
func()
defbar():
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
11defuse_logging(func):
defwrapper(*args,**kwargs):
logging.warn(%s is running%func.__name__)
returnfunc(*args,**kwargs)
returnwrapper
defbar():
print(i am bar)
baruse_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
14defuse_logging(func):
defwrapper(*args,**kwargs):
logging.warn(%s is running%func.__name__)
returnfunc(*args)
returnwrapper
use_logging# 语法糖,等价于:baruse_logging(bar)
deffoo():
print(i am foo)
use_logging
defbar():
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
14defuse_logging(level):
defdecorator(func):
defwrapper(*args,**kwargs):
iflevelwarn:
logging.warn(%s is running%func.__name__)
returnfunc(*args)
returnwrapper
returndecorator
use_logging(levelwarn)
deffoo(namefoo)
print(i am %s%name)
foo()
上述的use_logging是允许带参数的装饰器是对原有装饰器的一次函数封装并返回一个装饰器。我们可以将它理解为一个含有参数的闭包当我们调研这个语法糖的时候Python会发现这一层的封装并将参数传递到装饰器的环境中。
总结无参的装饰器参数是要装饰的函数有参装饰器参数是函数的参数最后返回的是内部函数。
类装饰器
相比函数装饰器类装饰器具有高内聚、灵活性大、高封装等优点。使用类装饰器还可以依靠类内部的__call__方法当使用将装饰器附加到函数上时 就会调用此方法。1
2
3
4
5
6
7
8
9
10
11
12
13classfoo(object):
def__init__(self,func):
self._funcfunc
def__call__(self):
print(class decorator running)
self._func()
print(class decorator ending)
foo
defbar():
print(i am bar)
bar()
使用类装饰器极大地复用了代码但是它也存在缺陷原函数的元信息不见了比如函数的docstring、__name__、参数列表我们先写一个装饰器1
2
3
4
5deflogged(func):
defwith_logging(*args,**kwargs):
printfunc.__name__was called
returnfunc(*args,**kwargs)
returnwith_logging
定义一个函数来调用该装饰器1
2
3
4logged
deff(x):
does some math
returnxx*x
上述函数完全等价于1
2
3
4deff(x):
does some math
returnxx*x
flogged(f)
可以看出函数f被with_logging取代了因此它的docstring、__name__也就变成了with_logging函数的信息了1
2printf.__name__# print with_logging
printf.__doc__# print None
好在我们有functools.wrapsPython的一个模块wraps本身就是一个装饰器它能把原函数的元信息拷贝到装饰器函数中使得装饰器函数也有和原函数一样的元信息。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15# 导入functools模块中的wraps装饰器
fromfunctoolsimportwraps
deflogged(func):
wraps(func)
defwith_logging(*args,**kwagrs):
printfunc.__name__was called
returnfunc(*args,**kwargs)
returnwith_logging
logged
deff(x):
does some math
returnxx*x
printf.__name__# print f
printf.__doc__# print does some math
内置装饰器
在Python中有三个内置的装饰器都与class相关
1staticmethod类静态方法其根跟成员方法的区别是没有self参数并且可以在类不进行实例化的情况下调用。
2classmethod与成员方法的区别在于所接收的第一个参数不是self类实例的指针而是cls当前类的具体类型。
3property属性的意思表示可以通过类实例直接访问的信息。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15classTest(object):
def__init__(self,name):
self._namename
staticmethod
defnewTest1(name):
returnTest(name)
classmethod
defnewTest2(cls):
returnTest()
property
defname(self):
returnself._name
装饰器的调用顺序
装饰器是可以叠加使用的那么这就涉及到装饰器的调用顺序。对于Python中的“”语法糖装饰器的调用顺序与使用语法糖的声明顺序相反。1
2
3
4
5
6
7
8
9# 装饰器的声明顺序
a
b
c
deff():
pass
# 等效于
fa(b(c(f)))# 以c、b、a的顺序调用
