一. 有时候我们会有这样需求: 在原有的逻辑前后添加一段逻辑
如: 在增/删/改操作之前检查用户是否登录、某个操作前后添加一些log ...
在java中你只能重写源码. 例如有一个视频上传的方法:
public void upload(Video video) { ... }
调用处: upload(video);
现在你需要在视频上传方法调用时记录一条log.
这时你可能会这样处理:
public void uploadVideoWithLog(Video video) {
System.out.println("upload method execute !");
upload(video);
}
调用之处得改成: uploadVideoWithLog(video);
可以看出, 这对原有代码逻辑的改动是非常大的.
为了灵活性和减少对原有代码的破坏性, 你可能会使用spring的AOP或者使用AspectJ. 对于Python 来说有更简单的处理方法, 即使用装饰器.
二. Python装饰器 (Python在原有逻辑前后添加逻辑的手段)
-
不用装饰器的处理方式.
#原有函数
def foo():
print('I am foo !')# 重新定义一个函数, 包装原有函数 def use_log(func): # 需要添加的逻辑 print('function %s() executing ' % func.__name__) func() #真正工作委托给原有函数 # 调用函数 (原来是这样调用: foo()) use_log(foo)
输出:
function foo() execute
I am foo !
-
使用装饰器.
# 定义需要添加的逻辑 (定义装饰器)
def log(func):
def decorator(*args, *kwargs):
print('function %s() execute ' % func.name)
return func(args, **kwargs)
return decorator@log # 在原有函数上应用装饰逻辑 def foo(): #原有函数 print('I am foo !') #调用函数 (和原有的调用逻辑一致, 不需要更改) foo()
输出:
function foo() execute
I am foo !
- 可见装饰器对于原有代码的破坏性要小的多, 它只需要定义要添加的逻辑, 并在原有函数之前添加
@decorator即可, 调用逻辑不用改变. 这是一个非常好的应用开闭原则的例子 (对更改关闭, 对扩展开发. 添加逻辑就是属于扩展).
三. functools.wraps
- 在原有代码之上应用装饰逻辑 (即在原来函数之前添加
@decorator), 其实是Python内置的语法糖.
def decorator(func):
def delegate(*args, **kwargs):
print('function %s() execute ' % func.__name__)
return func(*args, **kwargs)
return delegate
# 在一个函数(我们叫暂且他目标函数吧, target_func)上添加装饰逻辑(decorator函数),
# 等价于: target_func = decorator(target_func)
# 即调用装饰函数(以目标函数为参数)生成一个新函数替换原有的目标函数
@decorator
def foo():
print('I am foo !')
上面这段代码其实等价于:
def decorator(func):
def delegate(*args, **kwargs):
print('function %s() execute ' % func.__name__)
return func(*args, **kwargs)
return delegate
def foo():
print('I am foo !')
foo = decorator(foo)
添加@decorator其实就是把函数的内容重新赋值了 (以目标函数为参数, 调用decorator函数重新生成一个新的函数, 用新生成的函数替换目标函数). 这样下来目标函数的属性就变了.
看看面的程序会输出什么 ?
def decorator(func):
def delegate(*args, *kwargs):
print('function %s() execute ' % func.name)
return func(args, **kwargs)
return delegate
#下面的调用等价于: foo = decorator(foo)
@decorator
def foo():
"""description of function foo !!!!!!!!!"""
print('I am foo !')
print(foo.__name__) #输出: delegate
print(foo.__doc__) #输出: None
输出:
delegate
None
可以看到foo()函数的属性确实变了. 因为调用decorator()函数生成的函数是delegate()函数, 因此__name__属性的值是delegate; 而delegate()函数并没有定义函数文档, 因此__doc__属性值为None.
那么, 如何在添加装饰器之后还能保持原有函数的属性呢 ??
-
functools.wraps(指定某个函数的属性)
可以使用python内置的functools.wraps装饰器来解决上面的问题.
from functools import wraps
def decorator(func):
@wraps(func) #让下面的函数使用func函数的属性
def delegate(*args, *kwargs):
print('function %s() execute ' % func.name)
return func(args, **kwargs)
return delegate#下面的调用等价于: foo = decorator(foo) @decorator def foo(): """description of function foo !!!!!!!!!""" print('I am foo !') print(foo.__name__) #输出: foo print(foo.__doc__) #输出: description of method foo !!!!!!!!!
输出:
foo
description of method foo !!!!!!!!!
这样, 在应用了装饰器之后foo()函数仍能保持其原有属性.
functools.wraps就是一个装饰器. 最简单的用法就是改变一个函数的属性. 如下, 将foo()函数的属性改为函数bar()的属性:
from functools import wraps
def bar():
"""description of function bar !!!!!!"""
pass
@wraps(bar)
def foo():
pass
print(foo.__name__) #输出: bar
print(foo.__doc__) #输出: description of function bar !!!!!!
tips: 上述代码环执行境为Python 3.5.1`, 所使用的IDE为PyCharm
.
.
错误之处在所难免, 欢迎指正~~