Python裝飾器與面向切面編程

文章目錄

• 1.1. 需求是怎麼來的？
• 1.2. 以不變應萬變，是變也
• 1.3. 最大限度地少改動！
• 2.1. 文法糖
• 2.2. 內建的裝飾器
• 2.3. functools模組

新年好~  那麼，很久沒有更新了，其實想想也沒多少可以寫的，因為Python的文檔似乎很全面的說……能做的差不多隻有翻譯和整理了，英文過關的朋友不妨直接去doc.python.org這裡查看相關資料 ：）
轉載請註明原作者和原文地址，多謝！

今天來討論一下裝飾器。裝飾器是一個很著名的設計模式，經常被用於有切面需求的情境，較為經典的有插入日誌、效能測試、交易處理等。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量函數中與函數功能本身無關的雷同代碼並繼續重用。概括的講，裝飾器的作用就是為已經存在的對象添加額外的功能。

1. 裝飾器入門1.1. 需求是怎麼來的？

裝飾器的定義很是抽象，我們來看一個小例子。

def foo():    print 'in foo()'foo()

這是一個很無聊的函數沒錯。但是突然有一個更無聊的人，我們稱呼他為B君，說我想看看執行這個函數用了多長時間，好吧，那麼我們可以這樣做：

import timedef foo():    start = time.clock()    print 'in foo()'    end = time.clock()    print 'used:', end - startfoo()

很好，功能看起來無懈可擊。可是蛋疼的B君此刻突然不想看這個函數了，他對另一個叫foo2的函數產生了更濃厚的興趣。

怎麼辦呢？如果把以上新增加的代碼複製到foo2裡，這就犯了大忌了~複製什麼的難道不是最討厭了麼！而且，如果B君繼續看了其他的函數呢？

1.2. 以不變應萬變，是變也

還記得嗎，函數在Python中是一等公民，那麼我們可以考慮重新定義一個函數timeit，將foo的引用傳遞給他，然後在timeit中調用foo並進行計時，這樣，我們就達到了不改動foo定義的目的，而且，不論B君看了多少個函數，我們都不用去修改函數定義了！

import timedef foo():    print 'in foo()'def timeit(func):    start = time.clock()    func()    end =time.clock()    print 'used:', end - starttimeit(foo)

看起來邏輯上並沒有問題，一切都很美好並且運作正常！……等等，我們似乎修改了調用部分的代碼。原本我們是這樣調用的：foo()，修改以後變成了：timeit(foo)。這樣的話，如果foo在N處都被調用了，你就不得不去修改這N處的代碼。或者更極端的，考慮其中某處調用的代碼無法修改這個情況，比如：這個函數是你交給別人使用的。

1.3. 最大限度地少改動！

既然如此，我們就來想想辦法不修改調用的代碼；如果不修改調用代碼，也就意味著調用foo()需要產生調用timeit(foo)的效果。我們可以想到將timeit賦值給foo，但是timeit似乎帶有一個參數……想辦法把參數統一吧！如果timeit(foo)不是直接產生調用效果，而是返回一個與foo參數列表一致的函數的話……就很好辦了，將timeit(foo)的傳回值賦值給foo，然後，調用foo()的代碼完全不用修改！

#-*- coding: UTF-8 -*-import timedef foo():    print 'in foo()'# 定義一個計時器，傳入一個，並返回另一個附加了計時功能的方法def timeit(func):        # 定義一個內嵌的封裝函數，給傳入的函數加上計時功能的封裝    def wrapper():        start = time.clock()        func()        end =time.clock()        print 'used:', end - start        # 將封裝後的函數返回    return wrapperfoo = timeit(foo)foo()

這樣，一個簡易的計時器就做好了！我們只需要在定義foo以後調用foo之前，加上foo = timeit(foo)，就可以達到計時的目的，這也就是裝飾器的概念，看起來像是foo被timeit裝飾了。在在這個例子中，函數進入和退出時需要計時，這被稱為一個橫切面(Aspect)，這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。與傳統編程習慣的從上往下執行方式相比較而言，像是在函數執行的流程中橫向地插入了一段邏輯。在特定的業務領域裡，能減少大量重複代碼。面向切面編程還有相當多的術語，這裡就不多做介紹，感興趣的話可以去找找相關的資料。

這個例子僅用於示範，並沒有考慮foo帶有參數和有傳回值的情況，完善它的重任就交給你了 ：）

2. Python的額外支援2.1. 文法糖

上面這段代碼看起來似乎已經不能再精簡了，Python於是提供了一個文法糖來降低字元輸入量。

import timedef timeit(func):    def wrapper():        start = time.clock()        func()        end =time.clock()        print 'used:', end - start    return wrapper@timeitdef foo():    print 'in foo()'foo()

重點關注第11行的@timeit，在定義上加上這一行與另外寫foo = timeit(foo)完全等價，千萬不要以為@有另外的魔力。除了字元輸入少了一些，還有一個額外的好處：這樣看上去更有裝飾器的感覺。

2.2. 內建的裝飾器

內建的裝飾器有三個，分別是staticmethod、classmethod和property，作用分別是把類中定義的執行個體方法變成靜態方法、類方法和類屬性。由於模組裡可以定義函數，所以靜態方法和類方法的用處並不是太多，除非你想要完全的物件導向編程。而屬性也不是不可或缺的，Java沒有屬性也一樣活得很滋潤。從我個人的Python經驗來看，我沒有使用過property，使用staticmethod和classmethod的頻率也非常低。

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：

    @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，如果你希望使用反射，可能會導致意外的結果。這個裝飾器可以解決這個問題，它能將裝飾過的函數的特殊屬性保留。

import timeimport functoolsdef timeit(func):    @functools.wraps(func)    def wrapper():        start = time.clock()        func()        end =time.clock()        print 'used:', end - start    return wrapper@timeitdef 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__其中一個的類加上其他的比較方法，這是一個類裝飾器。如果覺得不好理解，不妨仔細看看這個裝飾器的原始碼：

53def 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__ = opname76            opfunc.__doc__ = getattr(int, opname).__doc__77            setattr(cls, opname, opfunc)78    return cls

本文到這裡就全部結束了，有空的話我會整理一個用於檢查參數類型的裝飾器的原始碼放上來，算是一個應用吧 ：）