一、装饰器概念
1、装饰器
- 装饰器:一种返回值也是一个函数的函数,即装饰器。
2、装饰器目的
-
装饰器的目的:装饰器是用于拓展原函数的一种函数,可以在不改变原来函数名或类名的情况下,给原函数增加新的功能。
一般情况下,我们需要改变原函数,直接改原函数的代码即可,但是实际情况中,并不是所有的函数代码(如核心代码)是不允许随意更改的,此时使用装饰器就更为方便。
二、如何创建装饰器
- 举个栗子,如有一简单函数
def function1():
print('i am a funcation!')
- 现需要将该函数运行时记录日志,在该函数里加上打印日志的代码即可
def function1():
print('i am a function!')
print('function1 is running!')
- 如果有大批函数都需要加上打印日志的功能,则无法一个一个去改代码,最好能使用一个方法,给所有函数调用。
def log(func):
print('%s is runnning!' % func.__name__)
return func
@log
def function1():
print('i am a function!')
function1()
>>>
function1 is runnning!
i am a function!
- 但是装饰器要求返回的是一个函数对象,所以我们可以将上述代码改造一下,使用嵌套函数,使其返回一个函数对象。
def log(func):
def _decoration():
print('%s is runnning!' % func.__name__)
func()
return _decoration
@log
def function1():
print('i am a function!')
function1()
>>>
function1 is runnning!
i am a function!
三、python内置装饰器
@property
- @property:上篇文章python类的三大特性——封装有写到,property,属性的意思,被修饰的方法,可以使用引用类中字段属性的方法去调用。
@staticmethod
- @staticmethod:静态方法,即将类中的方法修饰为静态方法,在不创建实例的情况下,可以通过类名直接引用。其成员方法区别是没有self参数。
@classmethod
- @classmethod:类方法,类方法的第一个参数是一个类,将类本身作为操作的方法。
四、装饰器类型
1、无参数的装饰器
见上例装饰器
2、带固定参数的装饰器
def log(func):
def _decoration(a, b):
print('%s is runnning!' % func.__name__)
func(a, b)
return _decoration
@log
def function1(a, b):
s = a + b
print('the result is %d' % s)
print('i am a function!')
function1(1, 2)
>>>
function1 is runnning!
the result is 3
i am a function!
3、无固定参数的装饰器
def log(func):
def _decoration(*args, **kwargs):
print('%s is runnning!' % func.__name__)
func(*args, **kwargs)
return _decoration
@log
def function1(a, b):
s = a + b
print('the result is %d' % s)
print('i am a function!')
@log
def function2(a, b, c):
s = a + b - c
print('the result is %d' % s)
print('i am a function!')
function1(1, 2)
function2(1, 2, 3)
>>>
function1 is runnning!
the result is 3
i am a function!
function2 is runnning!
the result is 0
i am a function!
4、使用@functools.wraps
栗子如下:
def log(func):
def _decoration():
print('%s is runnning!' % func.__name__)
func()
return _decoration
@log
def function1():
print('i am a function!')
print(function1.__name__)
function1()
>>>
function1 is runnning!
i am a function!
_decoration
发现此处打印的不是function1的函数名.
使用上述代码的缺点就是原函数的信息不见了. 如: name, 参数列表等.
所以这里引入@functools.wraps
import functools
def log(func):
@functools.wraps(func)
def _decoration():
print('%s is runnning!' % func.__name__)
func()
return _decoration
@log
def function1():
print('i am a function!')
print(function1.__name__)
function1()
>>>
function1 is runnning!
i am a function!
function1
5、类装饰器
import functools
class Log(object):
def __call__(self, func):
@functools.wraps(func)
def _decoration():
print('%s is runnning!' % func.__name__)
func()
return _decoration
@Log()
def function1():
print('i am a function!')
print(function1.__name__)
function1()
>>>
function1 is runnning!
i am a function!
function1
6、多个装饰器的调用顺序
多个类装饰一个函数时,调用时有一定的顺序 . 简单来说,就是装饰器调用顺序与@ 声明的顺序相反.
五、装饰器的用途
装饰器可以在不改变原函数功能的情况下,给原函数实现其他功能,同时,又能复用大量代码,减少冗余.
它常被用于有切面需求的场景, 如: 打印日志, 记录时间, 权限校验, 事务处理, 缓存等场景.