装饰器是一种设计模式,它提供了强大的复用非业务逻辑的能力,经典的应用场景有日志记录、性能测试、事务处理等。
下面分几个部分逐步介绍python中的装饰器。
1、python如何理解函数
在介绍装饰器之前,先介绍一下函数。理解python中的函数,首先要建立这样认知:在python中,一切皆对象。变量、列表、字典,甚至函数、类、元类等都是对象。
这里讲的函数作为第一类对象,可以将它:
- 赋值给一个变量或存入其他数据结构,如列表、字典等
- 作为参数窜地给其他函数
- 作为函数的返回值
>>> def foo():
... i = 1
... print i
...
>>> a = foo
>>> a
<function foo at 0x100700320>
>>> b = [str, foo]
>>> b
[<type 'str'>, <function foo at 0x100700320>]
>>> def bar(func):
... return func
...
>>> c = bar(foo)
>>> c
<function foo at 0x100700320>
>>> c()
1
>>>
另外,实现了__call__
方法类的实例也可以像函数一样使用。
>>> class Bar:
... def __init__(self, i):
... self.i = i
... def __call__(self, j):
... return self.i + j
...
>>> foo = Bar(1)
>>> foo(2)
3
建立了以上的认知之后,我们来介绍装饰器。
2、装饰器其实是一种闭包
前面介绍过,闭包是一种引用了自由变量的函数。
>>> def print_msg(msg):
... def printer():
... print('start....')
... print(msg)
... print('end....')
... return printer
...
>>> another_print = print_msg('hello')
>>> another_print()
start....
hello
end....
>>>
那装饰器呢?
>>> def print_msg(func):
... def printer():
... print('starting...')
... func()
... print('end....')
... return printer
...
>>> def foo():
... print('hello')
...
>>> another_print = print_msg(foo)
>>> another_print()
starting...
hello
end....
基本没有修改什么逻辑,只是把参数替换成了函数,就变成了一个简单的装饰器。所以,装饰器其实是一种以函数作为参数的闭包。这个print_msg就是装饰器,它封装一些可复用的非业务逻辑,而被装饰的foo可以专注于业务逻辑。这样整个设计就非常清晰,而且增加了可读性。
3、装饰器的两种类型
装饰器有两种类型:函数和类。
函数装饰器,就像上面例子中一样,是一个函数。但是装饰器不仅可以是函数,还可以是类。类装饰器在灵活性、内聚性、封装型等方面优点更未突出。
前面看过了函数装饰器的例子,下面看一个类装饰器的例子
>>> class Dec:
... def __init__(self, func):
... self._func = func
... def __call__(self):
... print('start....')
... self._func()
... print('end....')
...
>>> def para():
... print('hello')
...
>>> a = Dec(para)
>>> a
<__main__.Dec instance at 0x10071c680>
>>> a()
start....
hello
end....
4、参数设置
4.1装饰器参数
装饰器的使用非常灵活,需要时可以设置必要的参数。
def outer(a):
def print_msg(func):
def printer():
if a == 1:
print('start...')
func()
else:
func()
return printer
return print_msg
def foo():
print('hello')
another_print = outer(1)
another_print(foo)()
start...
hello
4.2被装饰函数参数
如果被装饰函数需要传入参数,可以在执行该函数的嵌套函数中设置。上面例子中,可以在printer中设置需要的相关参数。
def printer(*args, **kwargs):
if a == 1:
print('start....')
func(*args, **kwargs)
else:
func(*args, **kwargs)
5、@语法糖
@符号是装饰器的语法糖,将@符号和装饰器名称放在被装饰函数定义的地方,这样在使用函数时不用显示的调用装饰器, 而且这样并不会影响参数设置。
def outer(a):
def print_msg(func):
def printer():
if a == 1:
print(func.__name__)
func()
else:
func()
return printer
return print_msg
@outer(a=1)
def foo():
print('hello')
foo()
start...
hello
参考目录: