裝飾器模式
無論何時我們想對一個對象添加額外的功能卧晓，都有下面這些不同的可選方法。
- 如果合理桨菜，可以直接將功能添加到對象所屬的類（例如涉瘾，添加一個新的方法）
- 使用組合
- 使用繼承
注意硼讽，本文中的Decorator可以為裝飾器或者修飾器巢价。
與繼承相比，通常應該優(yōu)先選擇組合固阁，因為繼承使得代碼更難復用壤躲，繼承關系是靜態(tài)的，并且應用于整個類以及這個類的所有實例（請參考[GOF95备燃，第31頁]和網(wǎng)頁[t.cn/RqrC8Yo]）碉克。
設計模式為我們提供第四種可選方法，以支持動態(tài)地（運行時）擴展一個對象的功能并齐，這種方法就是修飾器漏麦。修飾器（Decorator）模式能夠以透明的方式（不會影響其他對象）動態(tài)地將功能添加到一個對象中（請參考[GOF95客税，第196頁]）。
在許多編程語言中撕贞，使用子類化（繼承）來實現(xiàn)修飾器模式（請參考[GOF95更耻，第198頁]）。在Python中麻掸，我們可以（并且應該）使用內(nèi)置的修飾器特性酥夭。一個Python修飾器就是對Python語法的一個特定改變，用于擴展一個類脊奋、方法或函數(shù)的行為，而無需使用繼承疙描。從實現(xiàn)的角度來說诚隙，Python修飾器是一個可調(diào)用對象（函數(shù)、方法起胰、類）久又，接受一個函數(shù)對象fin作為輸入，并返回另一個函數(shù)對象fout（請參考網(wǎng)頁）效五。這意味著可以將任何具有這些屬性的可調(diào)用對象當作一個修飾器地消。在第1章和第2章中已經(jīng)看到如何使用內(nèi)置的property修飾器讓一個方法表現(xiàn)為一個變量。在5.4節(jié)畏妖，我們將學習如何實現(xiàn)及使用我們自己的修飾器脉执。
修飾器模式和Python修飾器之間并不是一對一的等價關系。Python修飾器能做的實際上比修飾器模式多得多戒劫，其中之一就是實現(xiàn)修飾器模式（請參考[Eckel08半夷，第59頁]和網(wǎng)頁[t.cn/RqrlLcQ]）。
#!/usr/bin/env python
"""https://docs.python.org/2/library/functools.html#functools.wraps"""
"""https://stackoverflow.com/questions/739654/how-can-i-make-a-chain-of-function-decorators-in-python/739665#739665"""
from functools import wraps
def makebold(fn):
return getwrapped(fn, "b")
def makeitalic(fn):
return getwrapped(fn, "i")
def getwrapped(fn, tag):
@wraps(fn)
def wrapped():
return "<%s>%s</%s>" % (tag, fn(), tag)
return wrapped
@makebold
@makeitalic
def hello():
"""a decorated hello world"""
return "hello world"
if __name__ == '__main__':
print('result:{} name:{} doc:{}'.format(hello(), hello.__name__, hello.__doc__))
### OUTPUT ###
# result:<b><i>hello world</i></b> name:hello doc:a decorated hello world
result:<b><i>hello world</i></b> name:hello doc:a decorated hello world
# http://stackoverflow.com/questions/3118929/implementing-the-decorator-pattern-in-python
class foo(object):
def f1(self):
print("original f1")
def f2(self):
print("original f2")
class foo_decorator(object):
def __init__(self, decoratee):
self._decoratee = decoratee
def f1(self):
print("decorated f1")
self._decoratee.f1()
def __getattr__(self, name):
return getattr(self._decoratee, name) # 這個不是delegation么
u = foo()
v = foo_decorator(u)
v.f1()
v.f2()
decorated f1
original f1
original f2
現(xiàn)實中的例子
該模式雖名為修飾器迅细，但這并不意味著它應該只用于讓產(chǎn)品看起來更漂亮巫橄。修飾器模式通常用于擴展一個對象的功能。這類擴展的實際例子有茵典，給槍加一個消音器湘换、使用不同的照相機鏡頭（在可拆卸鏡頭的照相機上）等。
下圖由sourcemaking.com提供统阿，展示了我們可以如何使用一些專用配件來修飾一把槍彩倚，使其 無聲、更準以及更具破壞力（請參考網(wǎng)頁[t.cn/RqrC8Yo]）砂吞。注意署恍，圖中使用了子類化，但是在 Python中蜻直，這并不是必需的盯质，因為可以使用語言內(nèi)置的修飾器特性袁串。
軟件中的例子
Django框架大量地使用修飾器，其中一個例子是視圖修飾器呼巷。Django的視圖（View）修飾器 可用于以下幾種用途（請參考網(wǎng)頁[t.cn/RqrlJbA]）囱修。
- 限制某些HTTP請求對視圖的訪問控制特定視圖上的緩存行為
- 按單個視圖控制壓縮
- 基于特定HTTP請求頭控制緩存
Grok框架也使用修飾器來實現(xiàn)不同的目標，比如下面幾種情況王悍。
- 將一個函數(shù)注冊為事件訂閱者
- 以特定權限保護一個方法
- 實現(xiàn)適配器模式
應用案例
當用于實現(xiàn)橫切關注點（cross-cutting concerns）時破镰，修飾器模式會大顯神威（請參考[Lott14，第223頁]和網(wǎng)頁[t.cn/Rqrl6O0]）压储。以下是橫切關注點的一些例子鲜漩。
- 數(shù)據(jù)校驗
- 事務處理（這里的事務類似于數(shù)據(jù)庫事務，意味著要么所有步驟都成功完成集惋，要么事務失斣兴啤） ?緩存
- 日志
- 監(jiān)控
- 調(diào)試
- 業(yè)務規(guī)則
- 壓縮
- 加密
一般來說，應用中有些部件是通用的刮刑，可應用于其他部件喉祭，這樣的部件被看作橫切關注點。
使用修飾器模式的另一個常見例子是圖形用戶界面（Graphical User Interface雷绢，GUI）工具集泛烙。在一個GUI工具集中，我們希望能夠?qū)⒁恍┨匦郧涛桑热邕吙虮伟薄㈥幱啊㈩伾约皾L屏霞溪，添加到單個組件/部件孵滞。
實現(xiàn)
Python修飾器通用并且非常強大。你可以在Python官網(wǎng)python.org的修飾器代碼庫頁面（請參考網(wǎng)頁[t.cn/zRHPIq4]）中找到許多修飾器的使用樣例鸯匹。本節(jié)中坊饶，我們將學習如何實現(xiàn)一個memoization修飾器（請參考網(wǎng)頁[t.cn/zQi9AET]）。所有遞歸函數(shù)都能因memoization而提速殴蓬，那么來試試常用的斐波那契數(shù)列例子匿级。使用遞歸算法實現(xiàn)斐波那契數(shù)列，直接了當染厅，但性能問題較大痘绎，即使對于很小的數(shù)值也是如此。首先來看看樸素的實現(xiàn)方法（文件fibonacci_naive.py）肖粮。
def fibonacci(n):
assert(n >= 0), 'n must be >= 0'
return n if n in (0, 1) else fibonacci(n-1) + fibonacci(n-2)
if __name__ == '__main__':
from timeit import Timer
t = Timer('fibonacci(8)', 'from __main__ import fibonacci')
print(t.timeit())
15.40320448600687
執(zhí)行一下這個例子就知道這種實現(xiàn)的速度有多慢了孤页。計算第8個斐波那契數(shù)要花費運行的樣例輸出如上所示。
使用memoization方法看看能否改善涩馆。在下面的代碼中行施，我們使用一個dict來緩存斐波那契 數(shù)列中已經(jīng)計算好的數(shù)值允坚，同時也修改傳給fabonacci()函數(shù)的參數(shù)，計算第100個斐波那契數(shù)蛾号， 而不是第8個稠项。
known = {0:0, 1:1}
def fibonacci(n):
assert(n >= 0), 'n must be >= 0'
if n in known:
return known[n]
res = fibonacci(n-1) + fibonacci(n-2)
known[n] = res
return res
if __name__ == '__main__':
from timeit import Timer
t = Timer('fibonacci(100)', 'from __main__ import fibonacci')
print(t.timeit())
0.30129148002015427
執(zhí)行基于memoization的代碼實現(xiàn)，可以看到性能得到了極大的提升鲜结，甚至對于計算大的數(shù) 值性能也是可接受的展运。運行的樣例輸出如上所示。
但這種方法有一些問題精刷。雖然性能不再是一個問題拗胜，但代碼也沒有不使用memoization時那 樣簡潔。如果我們決定擴展代碼贬养，加入更多的數(shù)學函數(shù)挤土，并將其轉(zhuǎn)變成一個模塊，那又會是什么 樣的呢?假設決定加入的下一個函數(shù)是nsum()误算，該函數(shù)返回前n個數(shù)字的和。注意這個函數(shù)已存 在于math模塊中迷殿，名為fsum()儿礼，但我們也能很容易就能想到標準庫中還沒有、但是對我們模塊 有用的其他函數(shù)（例如庆寺，帕斯卡三角形蚊夫、埃拉托斯特尼篩法等）。所以暫且不必在意示例函數(shù)是 否已存在懦尝。使用memoization實現(xiàn)nsum()函數(shù)的代碼如下所示知纷。
known_sum = {0:0}
def nsum(n):
assert(n >= 0), 'n must be >= 0'
if n in known_sum:
return known_sum[n]
res = n + nsum(n-1)
known_sum[n] = res
return res
你有沒有注意到其中的問題?多了一個名為known_sum的新字典，為nsum提供緩存作用陵霉， 并且函數(shù)本身也比不使用memoization時的更復雜琅轧。這個模塊逐步變得不必要地復雜。保持遞歸 函數(shù)與樸素版本的一樣簡單踊挠，但在性能上又能與使用memoization的函數(shù)相近乍桂，這可能嗎?幸運 的是，確實可能效床，解決方案就是使用修飾器模式睹酌。
首先創(chuàng)建一個如下面的例子所示的memoize()函數(shù)。這個修飾器接受一個需要使用 memoization的函數(shù)fn作為輸入剩檀，使用一個名為known的dict作為緩存憋沿。函數(shù)functools.wraps() 是一個為創(chuàng)建修飾器提供便利的函數(shù);雖不強制，但推薦使用沪猴，因為它能保留被修飾函數(shù)的文檔字符串和簽名（請參考網(wǎng)頁[t.cn/Rqrl0K5]）辐啄。這種情況要求參數(shù)列表args采章，因為被修飾的函數(shù)可能有輸入?yún)?shù)。如果fibonacci()和nsum()不需要任何參數(shù)则披，那么使用args確實是多余的共缕，但它 們是需要參數(shù)n的。
from functools import wraps
def memoize(fn):
known = dict()
@wraps(fn)
def memoizer(*args):
if args not in known:
known[args] = fn(*args)
return known[args]
return memoizer
現(xiàn)在士复，對樸素版本的函數(shù)應用memoize()修飾器图谷。這樣既能保持代碼的可讀性又不影響性能。 我們通過修飾（或修飾行）來應用一個修飾器阱洪。修飾使用@name語法便贵，其中name是指我們想要使 用的修飾器的名稱。這其實只不過是一個簡化修飾器使用的語法糖冗荸。我們甚至可以繞過這個語法 手動執(zhí)行修飾器承璃，留給你作為練習吧。來看看下面的例子中如何對我們的遞歸函數(shù)使用memoize() 修飾器蚌本。
@memoize
def nsum(n):
'''返回前n個數(shù)字的和'''
assert(n >= 0), 'n must be <= 0'
return 0 if n == 0 else n + nsum(n-1)
@memoize
def fibonacci(n):
'''返回斐波那契數(shù)列的第n個數(shù)'''
assert(n >= 0), 'n must be >= 0'
return n if n in (0, 1) else fibonacci(n-1) + fibonacci(n-2)
代碼的最后一部分展示如何使用被修飾的函數(shù)盔粹，并測量其性能。measure是一個字典列表程癌，用于避免代碼重復舷嗡。注意name和doc分別是如何展示正確的函數(shù)名稱和文檔字符串值的。嘗試從memoize()中刪除@functools.wraps(fn)修飾嵌莉，看看是否仍舊如此进萄。
if __name__ == '__main__':
from timeit import Timer
measure = [ {'exec':'fibonacci(100)', 'import':'fibonacci', 'func':fibonacci},{'exec':'nsum(200)', 'import':'nsum', 'func':nsum} ]
for m in measure:
t = Timer('{}'.format(m['exec']), 'from __main__ import {}'.format(m['import']))
print('name: {}, doc: {}, executing: {}, time: {}'.format(m['func'].__name__, m['func'].__doc__, m['exec'], t.timeit()))
name: fibonacci, doc: 返回斐波那契數(shù)列的第n個數(shù), executing: fibonacci(100), time: 0.29140055197058246
name: nsum, doc: 返回前n個數(shù)字的和, executing: nsum(200), time: 0.3004333569551818
看看我們數(shù)學模塊的完整代碼（文件mymath.py）和執(zhí)行時的樣例輸出。
from functools import wraps
def memoize(fn):
known = dict()
@wraps(fn)
def memoizer(*args):
if args not in known:
known[args] = fn(*args)
return known[args]
return memoizer
@memoize
def nsum(n):
'''返回前n個數(shù)字的和'''
assert(n >= 0), 'n must be <= 0'
return 0 if n == 0 else n + nsum(n-1)
@memoize
def fibonacci(n):
'''返回斐波那契數(shù)列的第n個數(shù)'''
assert(n >= 0), 'n must be >= 0'
return n if n in (0, 1) else fibonacci(n-1) + fibonacci(n-2)
if __name__ == '__main__':
from timeit import Timer
measure = [ {'exec':'fibonacci(100)', 'import':'fibonacci', 'func':fibonacci},{'exec':'nsum(200)', 'import':'nsum', 'func':nsum} ]
for m in measure:
t = Timer('{}'.format(m['exec']), 'from __main__ import {}'.format(m['import']))
print('name: {}, doc: {}, executing: {}, time: {}'.format(m['func'].__name__, m['func'].__doc__, m['exec'], t.timeit()))
name: fibonacci, doc: 返回斐波那契數(shù)列的第n個數(shù), executing: fibonacci(100), time: 0.272907609003596
name: nsum, doc: 返回前n個數(shù)字的和, executing: nsum(200), time: 0.2719842789811082
不錯!這一方案同時具備可讀的代碼和可接受的性能锐峭。此時中鼠，你可能想爭論說這不是修飾器 模式，因為我們并不是在運行時應用它沿癞。被修飾的函數(shù)確實無法取消修飾援雇，但仍然可以在運行時 決定是否執(zhí)行修飾器。這個有趣的練習就留給你來完成吧抛寝。
使用修飾器進行一層額外的封裝熊杨，基于某個條件來決定是否執(zhí)行真正的修 飾器。
修飾器的另一個有趣的特性是可以使用多個修飾器來修飾一個函數(shù)盗舰。本章沒有涉及這一特 性晶府，因此這是另一個練習，創(chuàng)建一個修飾器來幫助你調(diào)試遞歸函數(shù)钻趋，并將其應用于nsum()和 fibonacci()川陆。多個修飾器會以什么次序執(zhí)行?
如果你仍未充分理解修飾器，那么我有最后一個練習留給你蛮位。修飾器memoize()無法修飾接 受多個參數(shù)的函數(shù)较沪。我們?nèi)绾慰梢则炞C這一點?驗證之后鳞绕，嘗試找到一種方法解決這個問題: 經(jīng)測試，memoize()對多參函數(shù)仍然有效尸曼。（此處可能有誤）
小結(jié)
本章介紹了修飾器模式及其與Python編程語言的關聯(lián)们何。我們使用修飾器模式來擴展一個對象的行為，無需使用繼承控轿，非常方便冤竹。Python進一步擴展了修飾器的概念，允許我們無需使用繼承或組 合就能擴展任意可調(diào)用對象（函數(shù)茬射、方法或類）的行為鹦蠕。我們可以使用Python內(nèi)置的修飾器特性。
我們看了現(xiàn)實中一些被修飾對象的例子在抛，比如槍和照相機钟病。從軟件的視角來看，Django和Grok都使用了修飾器來達到不同的目標刚梭，比如控制HTTP壓縮和緩存肠阱。
修飾器模式是實現(xiàn)橫切關注點的絕佳方案，因為橫切關注點通用但不太適合使用面向?qū)ο缶?程范式來實現(xiàn)朴读。在5.3節(jié)中我們提到很多種橫切關注點辖所。事實上，5.4節(jié)演示了一個橫切關注點磨德， memoization。我們看到修飾器如何可以幫助我們保持函數(shù)簡潔吆视，同時不犧牲性能典挑。
本章中推薦的練習可以幫助你更好地理解修飾器，這樣你就能將這一強大工具用于解決許多 常見的（或許不太常見的）編程問題啦吧。第6章將介紹外觀模式您觉，一種簡化復雜系統(tǒng)訪問的方式。
個人讀后感授滓，好爛的一章琳水，完全就是湊字數(shù)，還不如干脆挑明了直接解釋傳統(tǒng)意義上的裝飾器模式和python的裝飾器之間的差別般堆，還有自己造了一個輪子：memorize在孝，其實我們完全可以使用現(xiàn)有的輪子： from functools import lru_cache，還是別自己造輪子了淮摔。私沮。
我后續(xù)會補充完整這方面的內(nèi)容。
