**裝飾器是一個很著名的設計模式,經(jīng)常被用于有切面需求的場景,較為經(jīng)典的有插入日志、性能測試、事務處理等。裝飾器是解決這類問題的絕佳設計,有了裝飾器,我們就可以抽離出大量函數(shù)中與函數(shù)功能本身無關的雷同代碼并繼續(xù)重用。概括的講,裝飾器的作用就是為已經(jīng)存在的對象添加額外的功能。
**
先來看一個簡單例子:
def foo(): print('i am foo')
現(xiàn)在有一個新的需求,希望可以記錄下函數(shù)的執(zhí)行日志,于是在代碼中添加日志代碼:
def foo(): print('i am foo') logging.info("foo is running")
bar()、bar2()也有類似的需求,怎么做?再寫一個logging在bar函數(shù)里?這樣就造成大量雷同的代碼,為了減少重復寫代碼,我們可以這樣做,重新定義一個函數(shù):專門處理日志 ,日志處理完之后再執(zhí)行真正的業(yè)務代碼
def use_logging(func): logging.warn("%s is running" % func.__name__) func() def bar(): print('i am bar')
use_logging(bar)
邏輯上不難理解,而且運行正常。 但是這樣的話,我們每次都要將一個函數(shù)作為參數(shù)傳遞給use_logging函數(shù)。而且這種方式已經(jīng)破壞了原有的代碼邏輯結(jié)構(gòu),之前執(zhí)行業(yè)務邏輯時,執(zhí)行運行bar(),但是現(xiàn)在不得不改成use_logging(bar)。那么有沒有更好的方式的呢?當然有,答案就是裝飾器。
簡單裝飾器
def use_logging(func): def wrapper(*args, **kwargs): logging.warn("%s is running" % func.__name__) return func(*args, **kwargs) return wrapper def bar(): print('i am bar') bar = use_logging(bar) bar()
函數(shù)use_logging就是裝飾器,它把真正的業(yè)務方法func包裹在函數(shù)里面,看起來像bar被use_logging裝飾了。在這個例子中,函數(shù)進入和退出時 ,被稱為一個橫切面(Aspect),這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。
@符號是裝飾器的語法糖,在定義函數(shù)的時候使用,避免再一次賦值操作
@use_logging def foo(): print("i am foo") @use_logging def bar(): print("i am bar")
bar()
如上所示,這樣我們就可以省去bar = use_logging(bar)這一句了,直接調(diào)用bar()即可得到想要的結(jié)果。如果我們有其他的類似函數(shù),我們可以繼續(xù)調(diào)用裝飾器來修飾函數(shù),而不用重復修改函數(shù)或者增加新的封裝。這樣,我們就提高了程序的可重復利用性,并增加了程序的可讀性。
帶參數(shù)的裝飾器
裝飾器還有更大的靈活性,例如帶參數(shù)的裝飾器:在上面的裝飾器調(diào)用中,比如@use_logging,該裝飾器唯一的參數(shù)就是執(zhí)行業(yè)務的函數(shù)。裝飾器的語法允許我們在調(diào)用時,提供其它參數(shù),比如@decorator(a)。這樣,就為裝飾器的編寫和使用提供了更大的靈活性。
def use_logging(level): def decorator(func): def wrapper(*args, **kwargs): if level == "warn": logging.warn("%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()
上面的use_logging是允許帶參數(shù)的裝飾器。它實際上是對原有裝飾器的一個函數(shù)封裝,并返回一個裝飾器。我們可以將它理解為一個含有參數(shù)的閉包。當我 們使用@use_logging(level="warn")調(diào)用的時候,Python能夠發(fā)現(xiàn)這一層的封裝,并把參數(shù)傳遞到裝飾器的環(huán)境中。
類裝飾器
再來看看類裝飾器,相比函數(shù)裝飾器,類裝飾器具有靈活度大、高內(nèi)聚、封裝性等優(yōu)點。使用類裝飾器還可以依靠類內(nèi)部的__call__方法,當使用 @ 形式將裝飾器附加到函數(shù)上時,就會調(diào)用此方法。
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 bar(): print ('bar')
bar()
functools.wraps
使用裝飾器極大地復用了代碼,但是他有一個缺點就是原函數(shù)的元信息不見了,比如函數(shù)的docstring、name、參數(shù)列表,先看例子:
裝飾器
def logged(func): def with_logging(*args, **kwargs): print func.__name__ + " was called" return func(*args, **kwargs) return with_logging
函數(shù)
@logged def f(x): """does some math""" return x + x * x
@logged等價于:f = logged(f). 不難發(fā)現(xiàn),函數(shù)f被with_logging取代了,當然它的docstring,__name__就是變成了with_logging函數(shù)的信息了。
print f.__name__ # prints 'with_logging' print f.__doc__ # prints None
這個問題就比較嚴重的,好在我們有functools.wraps,wraps本身也是一個裝飾器,它能把原函數(shù)的元信息拷貝到裝飾器函數(shù)中,這使得裝飾器函數(shù)也有和原函數(shù)一樣的元信息了。
from functools import wraps def logged(func): @wraps(func) def with_logging(*args, **kwargs): print func.__name__ + " was called" return func(*args, **kwargs) return with_logging
@logged def f(x): """does some math""" return x + x * x
print f.__name__ # prints 'f' print f.__doc__ # prints 'does some math'