前言
這篇文章打算寫下關于python3中裝飾器的一些認識，提高一下知識水平
1 裝飾器是啥
裝飾器本質上是一個 Python 函數／類，它可以讓其他函數／類在不需要做任何代碼修改的前提下增加額外功能，裝飾器的返回值也是一個函數/類對象。它經常用于有切面需求的場景，比如：插入日志、性能測試、權限校驗等場景，裝飾器是解決這類問題的絕佳設計。有了裝飾器，我們就可以抽離出與函數功能本身無關的代碼到裝飾器中復用。概括的講，裝飾器的作用就是為已經存在的對象添加額外的功能。
2 簡單裝飾器（不使用@符號）
下面是一個簡單的裝飾器例子，log_append 來裝飾 direct_print，這種寫法支持任意參數的direct_print，也支持任意參數的裝飾函數log_append
def log_append():
def decorator(func):
def wrapper(**kwargs):
if "name" in kwargs:
print("check name %s" % (kwargs.get("name")))
else:
print("check name fail" )
return
return func(**kwargs)
return wrapper
return decorator
def direct_print(**kwargs):
print("print name is %s"% (kwargs.get("name")))
fun_decoratored=log_append()(direct_print)
fun_decoratored(names="111")
fun_decoratored(name="111")
print(fun_decoratored)
direct_print(name="111")
3 用@符號
利用@符號，可以提高代碼的閱讀性,我們用@的方式改寫上面的代碼
def log_append():
def decorator(func):
def wrapper(**kwargs):
if "name" in kwargs:
print("check name %s" % (kwargs.get("name")))
else:
print("check name fail" )
return
return func(**kwargs)
return wrapper
return decorator
@log_append()
def direct_print(**kwargs):
print("print name is %s"% (kwargs.get("name")))
direct_print(name="111")
direct_print(names="111")
4 裝飾器函數傳遞參數并體現裝飾器便利性
假如現在接口強制校驗的規則不定，一個函數強制校驗name，另一個強制校驗names字段，后面可能還會強制校驗key等別的字段，這時候改寫log_append就比較方便了
下面的代碼在完全不改變direct_print 業務邏輯的情況下，重寫了校驗邏輯，并且
復用在direct_print_names 方法
from collections import Iterable
def log_append(au_keys=[]):
def decorator(func):
def wrapper(**kwargs):
if not isinstance(au_keys,Iterable):
raise Exception("error au_keys,should be Iterable str")
for check_key in au_keys:
if check_key in kwargs:
print("check %s %s" % (check_key,kwargs.get(check_key)))
else:
print("check %s fail\n"% (check_key))
return
return func(**kwargs)
return wrapper
return decorator
@log_append(["name"])
def direct_print(**kwargs):
print("print name is %s\n"% (kwargs.get("name")))
@log_append(["names"])
def direct_print_names(**kwargs):
print("print names is %s\n"% (kwargs.get("names")))
direct_print(name="111")
direct_print(names="111")
direct_print_names(name="111")
direct_print_names(names="111")
5 functools.wraps 保留函數信息
不使用functools.wraps會導致 docstring、name這些函數元信息丟失，比如 使用 direct_print_names.name 會返回wrapper，這樣很影響使用，所以我們需要functools.wraps。加入方式簡單，再裝飾函數傳入func的地方加入@wraps
from collections import Iterable
from functools import wraps
def log_append(au_keys=[]):
def decorator(func):
@wraps(func)
def wrapper(**kwargs):
print()
if not isinstance(au_keys,Iterable):
raise Exception("error au_keys,should be Iterable str")
for check_key in au_keys:
if check_key in kwargs:
print("check %s %s" % (check_key,kwargs.get(check_key)))
else:
print("check %s fail\n"% (check_key))
return
return func(**kwargs)
return wrapper
return decorator
@log_append(["name"])
def direct_print(**kwargs):
print("print name is %s\n"% (kwargs.get("name")))
@log_append(["names"])
def direct_print_names(**kwargs):
print("print names is %s\n"% (kwargs.get("names")))
direct_print(name="111")
direct_print(names="111")
direct_print_names(name="111")
direct_print_names(names="111")
print(direct_print.__name__)
6 調用順序
python支持多重裝飾的，使用方式就是一個一個的@寫下去，它的執行順序是從外到里，最先調用最外層的裝飾器，最后調用最里層的裝飾器 在上面的代碼里面加入打印時間的裝飾函數print_time,讓direct_print 先裝飾print_time，direct_print_names后裝飾，實際上 direct_print 效果等于
print_time(log_append(["name"])(direct_print))
direct_print_names效果等于
log_append(["_names"])(print_time(direct_print))
整體代碼如下
from collections import Iterable
from functools import wraps
import time
def log_append(au_keys=[]):
def decorator(func):
@wraps(func)
def wrapper(**kwargs):
print()
if not isinstance(au_keys,Iterable):
raise Exception("error au_keys,should be Iterable str")
for check_key in au_keys:
if check_key in kwargs:
print("check %s %s" % (check_key,kwargs.get(check_key)))
else:
print("check %s fail\n"% (check_key))
return
return func(**kwargs)
return wrapper
return decorator
def print_time(func):
@wraps(func)
def wrapper(**kwargs):
print("time is %s"%(time.strftime("%Y-%m-%d %H:%M;%S",time.localtime())))
return func(**kwargs)
return wrapper
@print_time
@log_append(["name"])
def direct_print(**kwargs):
print("print name is %s\n"% (kwargs.get("name")))
@log_append(["names"])
@print_time
def direct_print_names(**kwargs):
print("print names is %s\n"% (kwargs.get("names")))
direct_print(name="111")
direct_print(names="111")
direct_print_names(name="111")
direct_print_names(names="111")
print(direct_print.__name__)
結語
這篇文章看下來，python的裝飾器基本上差不多了吧，好好學習，天天向上 ^_^
