装饰器一步一步详解
python装饰器解释
装饰器本质上是一个Python函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能，装饰器的返回值也是一个函数对象。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能无关的雷同代码并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。
1. 装饰器之前解惑
为什么要使用装饰器？
现在有一个新的需求，希望可以记录下函数的执行日志，于是在代码中添加日志代码
def use_logging(func): logging.warning("%s is running" % func.__name__) func() def bar(): print("i am bar") use_logging(bar)
上面的代码，逻辑上不难理解，但是这样的话，我们每次都要将一个函数作为参数传递给use_logging 函数。
而且这种方式已经破坏了原有代码逻辑结构，之前执行业务逻辑时，执行运行 bar() ,但是现在不得不改成 use_logging(bar)。有没有更好的方式呢？答案是：装饰器。
2. 简单装饰器
import logging def use_logging(func): def wrapper(*args,**kwargs): logging.warning("%s is running"%func.__name__) return func(*args,**kwargs) return wrapper def bar(): print("i am bar") bar = use_logging(bar) bar() res： WARNING:root:bar is running i am bar
函数 user_logging 就是装饰器，它把执行真正业务方法的func包裹在函数里，看起来像bar被use_logging装饰了。在这个例子中，函数进入和退出时，被称为一个横切面（Aspect），这种变成方式被称为面向切面的编程（Aspect-Oriented Programming）。
“@” 符号是装饰器的语法糖，在定义函数的时候使用，避免再一次赋值操作。
import logging def use_logging(func): def wrapper(*args,**kwargs): logging.warning("%s is running"%func.__name__) return func(*args,**kwargs) return wrapper @use_logging def bar(): print("i am bar") @use_logging def foo(): print("i am foo") bar()
如上所示，这样我们就可以省去 bar = use_logging(bar) 这一句了，直接调用bar() 即可得到想要的结果，如果我们有其他的类似函数，我们可以继续调用装饰器来修饰函数。而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。
装饰器在Python 使用如此方便都要归因于Python的函数能像普通的对象一样能作为参数传递给其他函数，可以被赋值给其他变量，可以作为返回值，可以被定义在另外一个函数内。
3. 带参数的装饰器
装饰器还有更大的灵活性，例如带参数的装饰器：在上面的装饰器调用中，比如 @use_logging， 该装饰器唯一的参数就是执行业务的函数。装饰器的语法允许我们在调用时，提供其他函数，比如 @decorator(a) 。这样，就为装饰器的编码和使用提供了更大的灵活性。
import logging def use_logging(level): def decorator(func): def wrapper(*args,**kwargs): if level == "warn": logging.warning("%s is running"%func.__name__) return func(*args) return wrapper return decorator @use_logging(level="warn") def foo(name='foo'): print("i am %s"%name) foo() # res: # i am foo # WARNING:root:foo is running
上面的use_logging 是允许带参数的装饰器。它实际上是对原有装饰器的一个函数的封装，并返回一个装饰器。我们可以将它理解成为一个含有参数的闭包。当我们使用 @use_logging(level="warn")调用的时候，Python能够发现这一层的封装，并把参数传递到装饰器的环境中。
4.登陆认证使用装饰器返回装饰器里面的用户名
def login_auth(func): def inner(*args,**kwargs): global user_login_status name = 'ryan' old_password = '1111' login_name = input("login:").strip() password = input("password:").strip() if password == old_password and login_name == name: func(login_name,*args,**kwargs) return inner @login_auth def run(username,age,address): print("login user is %s,age is %s,address is %s"%(username,age,address)) run(18,'SH') # res: # login:ryan # password:1111 # login user is ryan,age is 18,address is SH
5. 装饰器缺点及改进（原函数的元信息不见了）
def decorator(func): def wrapper(*args, **kwargs): '''wrapper test''' print(func.__name__, func.__doc__, 'call decorator') return func(*args, **kwargs) return wrapper @decorator def show(): """ show test """ print('......') show() print(show.__name__) # wrapper print(show.__doc__) # wrapper test # res: # show show test call decorator # ...... # wrapper # wrapper test
###改进装饰器 使用functools.wraps装饰器,它能把原函数的元信息拷贝到装饰器函数中， 这使得装饰器函数也有和原函数一样的元信息了。
from functools import wraps def decorator(func): @wraps(func) def wrapper(*args, **kwargs): print(func.__name__, func.__doc__, 'call decorator') return func(*args, **kwargs) return wrapper
@decorator def show(): """show test """ print('......') show() print(show.__name__) # show print(show.__doc__) # show test # res: # show show test call decorator # ...... # show # show test
6. 利用装饰器记录程序运行时间
""" 定义简单的装饰器,用来输出程序运行的所用时间 """ def timer(func): def decor(*args): start_time = time.time() time.sleep(2) func(*args) end_time = time.time() run_time = end_time - start_time print("run the func use : ", run_time) return decor @timer def printSth(str, count): for i in range(count): print("%d hello,%s!"%(i,str)) printSth("world", 100)
类装饰器，待学完类以后在写。
