python3中装饰器(Decorator)的应用
装饰器本质上是一个 Python 函数或类,它可以让其他函数或类在不需要做任何代码修改的前提下增加额外功能,装饰器的返回值也是一个函数/类对象。
它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等场景,装饰器是解决这类问题的绝佳设计。有了装饰器,我们就可以抽离出大量与函数功能本身无关的雷同代码到装饰器中并继续重用。概括的讲,装饰器的作用就是为已经存在的对象添加额外的功能。
装饰器其实就是一个闭包,把一个函数当做参数然后返回一个替代版函数。
Python 中的函数可以像普通变量一样当做参数传递给另外一个函数,例如:
def foo():#定义函数foo
print("in foo")
def bar(func):#定义函数传入参数,必填参数!此处传入函数名
func()#将传入的函数名,进行函数调用
bar(foo)#调用函数bar,并将参数foo传入
现在有一个新的需求,希望可以记录下函数的执行日志,于是在代码中添加日志代码:
def foo():
print('i am foo')
logging.info("foo is running")
装饰器定义成函数形式
import logging#导入日志模块
def user_loging(tail):
def inner(func):#func接受的bar函数
#*args可变参数,传入的是一个元组
def wrapper(*args,**keywords):#*args,传入可变参数,**keywords传入关键字参数
func(*args,**keywords)
# 获取日志
#func.__name__可以获取传入的函数名
logging.warn("%s is running" % func.__name__)#tail装饰器参数传入
# args是一个数组,kwargs一个字典
# print("in wapper")
return wrapper
return inner
#加了装饰器后,会将bar函数当做参数传递给装饰器函数。然后执行装饰器函数体中的代码
@user_loging
def bar(*args, **keywords):
print(f"信息{args}")
print(f'关键字可变参数:{keywords}')
@user_loging('tom')
def foo(*args, **keywords):
print(f"信息{args}")
print(f'关键字可变参数:{keywords}')
nameinfo = {'name':'李四','age':56}
foo('张三',56,'男',**nameinfo)
带参数的装饰器
装饰器还有更大的灵活性,例如带参数的装饰器,在上面的装饰器调用中,该装饰器接收唯一的参数就是执行业务的函数 foo 。装饰器的语法允许我们在调用时,提供其它参数,比如@decorator(a)
。这样,就为装饰器的编写和使用提供了更大的灵活性。比如,我们可以在装饰器中指定日志的等级,因为不同业务函数可能需要的日志级别是不一样的。
def user_logging(level):
def decorator(func):
def wrapper(*args, **kwargs):
if level == "warning":
logging.warning("%s is running" % func.__name__)
elif level == "info":
logging.info("%s is running" % func.__name__)
return func(**kwargs)
return wrapper
return decorator
@user_logging(level="warning")
def foo(name='foo'):
print("i am %s" % name)
foo(name="王芳")
上面的 user_logging 是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装,并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我 们使用@user_logging(level="warning")
调用的时候,Python 能够发现这一层的封装,并把参数传递到装饰器的环境中。
@user_logging(level="warn")等价于@decorator
将装饰器定义成类的形式
#类装饰器
class Foo:
#在初始化方法init里面定义一个实例属性。作为传入的函数
def __init__(self, fc):
#实例属性
self._func = fc
#类里面装饰函数,在call方法中
def __call__(self, *args, **kwargs):
print("start call")
self._func(*args,**kwargs)
print("end call")
@Foo
def bar(name,age,namedict):
print(f"您的名字{name},名字为{age}")
print(f"信息{namedict}")
nameinfo = {'name':'李四','age':56}
bar('张三',56,nameinfo)