今天來討論一下裝飾器。裝飾器是一個很著名的設計模式，經常被用於有切面需求的場景，較為經典的有插入日誌、效能測試、事務處理等。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量函式中與函式功能本身無關的雷同程式碼並繼續重用。概括的講，裝飾器的作用就是為已經存在的物件新增額外的功能。
1. 裝飾器入門
1.1. 需求是怎麼來的？
裝飾器的定義很是抽象，我們來看一個小例子。
|
1 2 3 4 |
def foo(): print 'in foo()' foo() |
這是一個很無聊的函式沒錯。但是突然有一個更無聊的人，我們稱呼他為B君，說我想看看執行這個函式用了多長時間，好吧，那麼我們可以這樣做：
|
1 2 3 4 5 6 7 8 |
import time def foo(): start = time.clock() print 'in foo()' end = time.clock() print 'used:', end - start foo() |
很好，功能看起來無懈可擊。可是蛋疼的B君此刻突然不想看這個函式了，他對另一個叫foo2的函式產生了更濃厚的興趣。
怎麼辦呢？如果把以上新增加的程式碼複製到foo2裡，這就犯了大忌了~複製什麼的難道不是最討厭了麼！而且，如果B君繼續看了其他的函式呢？
1.2. 以不變應萬變，是變也
還記得嗎，函式在Python中是一等公民，那麼我們可以考慮重新定義一個函式timeit，將foo的引用傳遞給他，然後在timeit中呼叫foo並進行計時，這樣，我們就達到了不改動foo定義的目的，而且，不論B君看了多少個函式，我們都不用去修改函式定義了！
|
1 2 3 4 5 6 7 8 9 10 11 12 |
import time def foo(): print 'in foo()' def timeit(func): start = time.clock() func() end =time.clock() print 'used:', end - start timeit(foo) |
看起來邏輯上並沒有問題，一切都很美好並且運作正常！……等等，我們似乎修改了呼叫部分的程式碼。原本我們是這樣呼叫的：foo()，修改以後變成了：timeit(foo)。這樣的話，如果foo在N處都被呼叫了，你就不得不去修改這N處的程式碼。或者更極端的，考慮其中某處呼叫的程式碼無法修改這個情況，比如：這個函式是你交給別人使用的。
1.3. 最大限度地少改動！
既然如此，我們就來想想辦法不修改呼叫的程式碼；如果不修改呼叫程式碼，也就意味著呼叫foo()需要產生呼叫timeit(foo)的效果。我們可以想到將timeit賦值給foo，但是timeit似乎帶有一個引數……想辦法把引數統一吧！如果timeit(foo)不是直接產生呼叫效果，而是返回一個與foo引數列表一致的函式的話……就很好辦了，將timeit(foo)的返回值賦值給foo，然後，呼叫foo()的程式碼完全不用修改！
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
#-*- coding: UTF-8 -*- import time def foo(): print 'in foo()' # 定義一個計時器，傳入一個，並返回另一個附加了計時功能的方法 def timeit(func): # 定義一個內嵌的包裝函式，給傳入的函式加上計時功能的包裝 def wrapper(): start = time.clock() func() end =time.clock() print 'used:', end - start # 將包裝後的函式返回 return wrapper foo = timeit(foo) foo() |
這樣，一個簡易的計時器就做好了！我們只需要在定義foo以後呼叫foo之前，加上foo = timeit(foo)，就可以達到計時的目的，這也就是裝飾器的概念，看起來像是foo被timeit裝飾了。在在這個例子中，函式進入和退出時需要計時，這被稱為一個橫切面(Aspect)，這種程式設計方式被稱為面向切面的程式設計(Aspect-Oriented Programming)。與傳統程式設計習慣的從上往下執行方式相比較而言，像是在函式執行的流程中橫向地插入了一段邏輯。在特定的業務領域裡，能減少大量重複程式碼。面向切面程式設計還有相當多的術語，這裡就不多做介紹，感興趣的話可以去找找相關的資料。
這個例子僅用於演示，並沒有考慮foo帶有引數和有返回值的情況，完善它的重任就交給你了 ：）
2. Python的額外支援
2.1. 語法糖
上面這段程式碼看起來似乎已經不能再精簡了，Python於是提供了一個語法糖來降低字元輸入量。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
import time def timeit(func): def wrapper(): start = time.clock() func() end =time.clock() print 'used:', end - start return wrapper @timeit def foo(): print 'in foo()' foo() |
重點關注第11行的@timeit，在定義上加上這一行與另外寫foo = timeit(foo)完全等價，千萬不要以為@有另外的魔力。除了字元輸入少了一些，還有一個額外的好處：這樣看上去更有裝飾器的感覺。
2.2. 內建的裝飾器
內建的裝飾器有三個，分別是staticmethod、classmethod和property，作用分別是把類中定義的例項方法變成靜態方法、類方法和類屬性。由於模組裡可以定義函式，所以靜態方法和類方法的用處並不是太多，除非你想要完全的物件導向程式設計。而屬性也不是不可或缺的，Java沒有屬性也一樣活得很滋潤。從我個人的Python經驗來看，我沒有使用過property，使用staticmethod和classmethod的頻率也非常低。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
class Rabbit(object): def __init__(self, name): self._name = name @staticmethod def newRabbit(name): return Rabbit(name) @classmethod def newRabbit2(cls): return Rabbit('') @property def name(self): return self._name |
這裡定義的屬性是一個只讀屬性，如果需要可寫，則需要再定義一個setter：
|
1 2 3 |
@name.setter def name(self, name): self._name = name |
2.3. functools模組
functools模組提供了兩個裝飾器。這個模組是Python 2.5後新增的，一般來說大家用的應該都高於這個版本。但我平時的工作環境是2.4 T-T
2.3.1. wraps(wrapped[, assigned][, updated]):
這是一個很有用的裝飾器。看過前一篇反射的朋友應該知道，函式是有幾個特殊屬性比如函式名，在被裝飾後，上例中的函式名foo會變成包裝函式的名字wrapper，如果你希望使用反射，可能會導致意外的結果。這個裝飾器可以解決這個問題，它能將裝飾過的函式的特殊屬性保留。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
import time import functools def timeit(func): @functools.wraps(func) def wrapper(): start = time.clock() func() end =time.clock() print 'used:', end - start return wrapper @timeit def foo(): print 'in foo()' foo() print foo.__name__ |
首先注意第5行，如果註釋這一行，foo.__name__將是’wrapper’。另外相信你也注意到了，這個裝飾器竟然帶有一個引數。實際上，他還有另外兩個可選的引數，assigned中的屬性名將使用賦值的方式替換，而updated中的屬性名將使用update的方式合併，你可以通過檢視functools的原始碼獲得它們的預設值。對於這個裝飾器，相當於wrapper = functools.wraps(func)(wrapper)。
2.3.2. total_ordering(cls):
這個裝飾器在特定的場合有一定用處，但是它是在Python 2.7後新增的。它的作用是為實現了至少__lt__、__le__、__gt__、__ge__其中一個的類加上其他的比較方法，這是一個類裝飾器。如果覺得不好理解，不妨仔細看看這個裝飾器的原始碼：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
def total_ordering(cls): 54 """Class decorator that fills in missing ordering methods""" 55 convert = { 56 '__lt__': [('__gt__', lambda self, other: other < self), 57 ('__le__', lambda self, other: not other < self), 58 ('__ge__', lambda self, other: not self < other)], 59 '__le__': [('__ge__', lambda self, other: other <= self), 60 ('__lt__', lambda self, other: not other <= self), 61 ('__gt__', lambda self, other: not self <= other)], 62 '__gt__': [('__lt__', lambda self, other: other > self), 63 ('__ge__', lambda self, other: not other > self), 64 ('__le__', lambda self, other: not self > other)], 65 '__ge__': [('__le__', lambda self, other: other >= self), 66 ('__gt__', lambda self, other: not other >= self), 67 ('__lt__', lambda self, other: not self >= other)] 68 } 69 roots = set(dir(cls)) & set(convert) 70 if not roots: 71 raise ValueError('must define at least one ordering operation: < > <= >=') 72 root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__ 73 for opname, opfunc in convert[root]: 74 if opname not in roots: 75 opfunc.__name__ = opname 76 opfunc.__doc__ = getattr(int, opname).__doc__ 77 setattr(cls, opname, opfunc) 78 return cls |
本文到這裡就全部結束了，有空的話我會整理一個用於檢查引數型別的裝飾器的原始碼放上來，算是一個應用吧 ：）