装饰器表面意思也大概猜的出来,对主要的某些功能,函数,类等进行装饰的作用,就比如python一个函数已经被别人编写了,我们不能改动别人的代码,又想在调用它的时候,添加一些我们想要用到的功能,装饰器则可以完美的解决这一问题。
一,无参数装饰器
首先我们先定义一个函数:
import time
def sp():
str1 = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())
print(str1)
以上我们可以看到,sp是定义的一个函数,这个函数是打印当前时间的一个函数,现在我需要对其进行强化,加入一些其他的内容,比如在函数调用前后加日志打印,并且不改动原函数内容,我们可以定义一个装饰器:
import functools
def fixture1(func): # 定义装饰器
@functools.wraps(func) #保留原函数的装饰器
def wrapper(*args, **kw):
print('函数开始运行咯')
func(*args, **kw)
print('函数运行结束咯')
return wrapper # 返回wrapper函数
然后我们只要在下面加上这个装饰器:
@fixture1 # 装饰器
def sp():
str1 = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())
print(str1)
运行结果可得到如下:
>>>函数开始运行咯
>>>2020-06-30 19:00:57
>>>函数运行结束咯
以上直接调用sp()实际就等同于func = fixture1(sp())的效果是相同的,wrapper函数里面传的参数为*args与**kw,所以支持任意形式函数的调用。@functools.wraps(func)这一个装饰器的效果是为了保留原函数的元信息,我们都知道每个函数都有自己的.__name__属性,如果我们没有加这个内置装饰器,我们打印sp.__name__会得到wrapper,而加上之后,我们得到的函数名称就为sp。
接下来我们再来看一个简单的实例:
def fixture2(func):
@functools.wraps(func)
def wrapper(*args,**kwargs):
return '现在时间是:'+func(*args,**kwargs)
return wrapper
@fixture2
def testadd():
str1 = time.strftime('%Y-%m-%d %H:%M:%S',time.localtime())
return str1
print(testadd())
运行以上代码,我们可以得到以下结果:
>>>现在时间是:2020-06-30 19:19:23
以上代码是在装饰器中返回函数与一个字符串进行拼接,因此我们在定义使用的函数的时候,也需要return出一个数据。
装饰器也可以同时使用多个:
def fixture1(func):
@functools.wraps(func)
def wrapper(*args,**kwargs):
print('函数开始运行咯')
return '杭州'+func(*args,**kwargs)
return wrapper
def fixture2(func):
@functools.wraps(func)
def wrapper(*args,**kwargs):
return '当前时间是:'+func(*args,**kwargs)
return wrapper
@fixture1
@fixture2
def testadd():
str1 = time.strftime('%Y-%m-%d %H:%M:%S',time.localtime())
return str1
print(testadd())
运行以上代码:
>>>函数开始运行咯
>>>杭州当前时间是:2020-06-30 19:29:36
如果我们把装饰器位置调换一下:
@fixture2
@fixture1
def testadd():
str1 = time.strftime('%Y-%m-%d %H:%M:%S',time.localtime())
return str1
打印以上函数可得到如下结果:
>>>函数开始运行咯
>>>当前时间是:杭州2020-06-30 19:31:30
二,有参数的装饰器
装饰器也可以带参数,上面的装饰器解决了给业务逻辑函数传递参数的问题,带参数的装饰器则进一步丰富了装饰器的功能,比如logging装饰器,可以指定日志记录的等级,代码示例如下
def fixture1(level):
def decorator(func):
@functools.wraps(func)
def wrapper(*args,**kwargs):
if level == 'info':
return '----------------{}'.format(func(*args,**kwargs))
if level == 'error':
return '*******************{}'.format(func(*args,**kwargs))
return wrapper
return decorator
@fixture1(level='error')
def testadd():
str1 = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())
return str1
print(testadd())
运行以上代码可得到如下结果:
*******************2020-07-01 12:47:24
以上我们可以看到,我们在wrapper函数外面又嵌套了一层decorator函数,这层函数的使用,使得我们可以在装饰器中传入参数。
三,非必传参数的装饰器
我们在编写代码时,会注意到,装饰器有些参数可以传,有时候也可以不传,那么我们如何定义呢:
def fixture(arg):
if hasattr(arg, '__call__'):
@functools.wraps(arg)
def wrapper(*args, **kw):
print('%s函数开始运行了' % arg.__name__)
arg(*args, **kw)
print('%s函数运行结束了' % arg.__name__)
return wrapper
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('%s函数开始运行了' % arg.__name__)
arg(*args, **kw)
print('%s函数运行结束了' % arg.__name__)
return wrapper
return decorator
@fixture
def testTime():
str1 = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())
print(str1)
testTime()
这个时候我们可以看到装饰器中既可以传入参数,也可以不传参数,代码运行并不会报错。我们只需在fixture函数内进行一个if判断,如果arg传入的是可调用的方法,那么返回的就是一个不带参数的decorator函数。
那么我们既然知道了装饰器的使用,那一般企业中在什么时候会用到呢,例如打印日志的时候,身份验证的时候,比如有些接口需要我们登陆之后方可进行操作,那么我们就可以写一个检查在线状态的装饰器,在每次进行操作前,进行一次身份检查。