Python 裝飾器
裝飾器本質上是一個Python函數,它可以讓其他函數在不需要做任何代碼變動的前提下增加額外功能,裝飾器的返回值也是一個函數對象.
經常用於有切面需求的場景,比如:插入日誌、性能測試、事務處理、緩存、權限校驗等場景。裝飾器是解決這類問題的絕佳設計,有了裝飾器,我們就可以抽離出大量與函數功能本身無關的雷同代碼並繼續重用。
先來看一個簡單例子:
def now(): print(‘2017_7_29‘)
現在有一個新的需求,希望可以記錄下函數的執行日誌,於是在代碼中添加日誌代碼:
def now(): print(‘2017_7_29‘) logging.warn("running")
假設有類似的多個需求,怎麽做?再寫一個logging在now函數裏?這樣就造成大量雷同的代碼,為了減少重復寫代碼,我們可以這樣做,重新定義一個函數:專門處理日誌 ,日誌處理完之後再執行真正的業務代碼.
def use_logging(func): logging.warn("%s is running" % func.__name__) func() def now(): print(‘2017_7_29‘) use_logging(now)
在實現,邏輯上不難, 但是這樣的話,我們每次都要將一個函數作為參數傳遞給日誌函數。而且這種方式已經破壞了原有的代碼邏輯結構,之前執行業務邏輯時,執行運行now(),但是現在不得不改成use_logging(now)。那麽有沒有更好的方式的呢?當然有,答案就是裝飾器。
首先要明白函數也是一個對象,而且函數對象可以被賦值給變量,所以,通過變量也能調用該函數。例如:
def now(): print(‘2017_7_28‘) f=now f()
# 函數對象有一個__name__屬性,可以拿到函數的名字
print(‘now.__name__:‘,now.__name__)
print(‘f.__name__:‘,f.__name__)
簡單裝飾器
本質上,decorator就是一個返回函數的高階函數。所以,我們要定義一個能打印日誌的decorator,可以定義如下:
def log(func):
def wrapper(*args,**kw):
print(‘call %s():‘%func.__name__)
return func(*args,**kw)
return wrapper
# 由於log()是一個decorator,返回一個函數,所以,原來的now()函數仍然存在,
# 只是現在同名的now變量指向了新的函數,於是調用now()將執行新函數,即在log()函數中返回的wrapper()函數。
# wrapper()函數的參數定義是(*args, **kw),因此,wrapper()函數可以接受任意參數的調用。
# 在wrapper()函數內,首先打印日誌,再緊接著調用原始函數。
上面的log
,因為它是一個decorator,所以接受一個函數作為參數,並返回一個函數.現在執行:
now = log(now)
now()
輸出結果:
call now():
2017_7_28
函數log就是裝飾器,它把執行真正業務方法的func包裹在函數裏面,看起來像now被log裝飾了。在這個例子中,函數進入時 ,被稱為一個橫切面(Aspect),這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。
使用語法糖:
@log def now(): print(‘2017_7_28‘)
@符號是裝飾器的語法糖,在定義函數的時候使用,避免再一次賦值操作
這樣我們就可以省去now = log(now)這一句了,直接調用now()即可得到想要的結果。如果我們有其他的類似函數,我們可以繼續調用裝飾器來修飾函數,而不用重復修改函數或者增加新的封裝。這樣,我們就提高了程序的可重復利用性,並增加了程序的可讀性。
裝飾器在Python使用如此方便都要歸因於Python的函數能像普通的對象一樣能作為參數傳遞給其他函數,可以被賦值給其他變量,可以作為返回值,可以被定義在另外一個函數內。
帶參數的裝飾器:
如果decorator本身需要傳入參數,那就需要編寫一個返回decorator的高階函數,寫出來會復雜一點。比如,要自定義log的文本:
def log(text): def decorator(func): def wrapper(*args,**kw): print(‘%s %s()‘%(text,func.__name__)) return func(*args,**kw) return wrapper return decorator
這個3層嵌套的decorator用法如下:
@log(‘goal‘) def now(): print(‘2017-7-28‘)
now()
等價於
now = log(‘goal‘)(now)
# 首先執行log(‘execute‘),返回的是decorator函數,再調用返回的函數,參數是now函數,返回值最終是wrapper函數
now()
因為我們講了函數也是對象,它有__name__
等屬性,但你去看經過decorator裝飾之後的函數,它們的__name__
已經從原來的‘now‘
變成了‘wrapper‘
:
print(now.__name__) # wrapper
因為返回的那個wrapper()
函數名字就是‘wrapper‘
,所以,需要把原始函數的__name__
等屬性復制到wrapper()
函數中,否則,有些依賴函數簽名的代碼執行就會出錯。
不需要編寫wrapper.__name__ = func.__name__
這樣的代碼,Python內置的functools.wraps
就是幹這個事的,所以,一個完整的decorator的寫法如下:
import functools def log(func): @functools.wraps(func) def wrapper(*args, **kw): print(‘call %s():‘ % func.__name__) return func(*args, **kw) return wrapper
import functools def log(text): def decorator(func): @functools.wraps(func) def wrapper(*args, **kw): print(‘%s %s():‘ % (text, func.__name__)) return func(*args, **kw) return wrapper return decorator
類裝飾器:
再來看看類裝飾器,相比函數裝飾器,類裝飾器具有靈活度大、高內聚、封裝性等優點。使用類裝飾器還可以依靠類內部的__call__方法,當使用 @ 形式將裝飾器附加到函數上時,就會調用此方法
import time class Foo(object): def __init__(self, func): self._func = func def __call__(self): print (‘class decorator runing‘) self._func() print (‘class decorator ending‘) @Foo def now(): print (time.strftime(‘%Y-%m-%d‘,time.localtime(time.time()))) now()
總結:
概括的講,裝飾器的作用就是為已經存在的對象添加額外的功能。
同時在面向對象(OOP)的設計模式中,decorator被稱為裝飾模式。OOP的裝飾模式需要通過繼承和組合來實現,而Python除了能支持OOP的decorator外,直接從語法層次支持decorator。Python的decorator可以用函數實現,也可以用類實現。
Python 裝飾器