Python Decorator的設計模式演繹過程解析

Posted on by

關於代理模式、裝飾模式

設計模式中經常提到的代理模式、裝飾模式，這兩種叫法實際上是說的同一件事，隻是側重點有所不同而已。

這兩者都是通過在原有對象的基礎上封裝一層對象，通過調用封裝後的對象而不是原來的對象來實現代理/裝飾的目的。

例如：（以Java為例）

public class CountProxy implements Count {
    private CountImpl countImpl;
    public CountProxy(CountImpl countImpl) {
        this.countImpl = countImpl;
    }
    @Override
    public void queryCount() {  
        System.out.println("事務處理之前");
        // 調用委托類的方法;
        countImpl.queryCount();
        System.out.println("事務處理之後");
    }
    @Override
    public void updateCount() {
        System.out.println("事務處理之前");
        // 調用委托類的方法;
        countImpl.updateCount();
        System.out.println("事務處理之後");
    }
}

在這個例子中CountProxy是對CountImpl的封裝。

使用者通過CountProxy.queryCount方法來調用CountImpl.queryCount方法，這被稱為代理，即CountProxy是代理類，CountImpl是被代理類。

在CountProxy.queryCount方法中，可以在CountImpl.queryCount方法調用之前和之後添加一些額外的操作，被稱為裝飾，即CountProxy是裝飾類，CountImpl是被裝飾類。

如果強調通過CountProxy 對CountImpl進行代理的作用，則稱為代理模式；

如果強調通過CountProxy 對CountImpl增加額外的操作，則稱為裝飾模式；

不論是哪種稱呼，其本質都在於對原有對象的封裝。

其封裝的目的在於增強所封裝對象的功能或管理所封裝的對象。

從上面的例子也可以發現，代理/封裝所圍繞的核心是可調用對象（比如函數）。

Python中的代理/裝飾

Python中的可調用對象包括函數、方法、實現瞭__call__方法的類。

Python中的函數也是對象，可以作為高階函數的參數傳入或返回值返回。

因此，當代理/裝飾的對象是函數時，可以使用高階函數來對某個函數進行封裝。

例如：

def query_count_proxy(fun, name, age):
    print('do something before')
    rv = fun(name, age)
    print('do something after')
    return rv
def query_count(name, age):
    print('name is %s, age is %d' % (name, age))
query_count_proxy(query_count, 'Lee', 20)

但是，這個例子中，query_count函數作為參數傳入query_count_proxy函數中，並在query_count_proxy函數中被調用，其結果作為返回值返回。這就完成瞭代理的功能，同時，在調用query_count函數的前後，我們還增加瞭裝飾代碼。

但是，query_count_proxy的函數參數與query_count不一樣瞭，理想的代理應該保持接口一致才對。

為瞭保持一致，我們可以利用高階函數可以返回函數的特點來完成：

def query_count_proxy(fun):
    def wrapper(name, age):
        print('do something before')
        rv = fun(name, age)
        print('do something after')
        return rv
    return wrapper
def query_count(name, age):
    print('name is %s, age is %d' % (name, age))
query_count_proxy(query_count)('Lee', 20)

修改後的例子，query_count_proxy僅負責接受被代理的函數query_count作為參數，同時，返回一個函數對象wrapper作為返回值，真正的封裝動作在wrapper這個函數中完成。

此時，如果調用query_count_proxy(query_count)就得到瞭wrapper函數對象，則，執行query_count_proxy(query_count)('Lee', 20)就相當於執行瞭wrapper('Lee', 20)。

但是可以看到，query_count_proxy(query_count)('Lee', 20)這種使用方法，仍然不能保證一致。

為瞭保持一致，我們需要利用Python中對象與其名稱可以動態綁定的特點。不使用query_count_proxy(quer_count)('Lee', 20)來調用代理函數，而是使用下面兩句：

query_count = query_count_proxy(query_count)
query_count('Lee', 20)

執行query_count_proxy(query_count)生成wrapper函數對象，將這個對象通過query_count = query_count_proxy(query_count)綁定到query_count這個名字上來，這樣執行query_count('Lee', 20)時，其實執行的是wrapper('Lee', 20)。

這麼做的結果就是：使用代理時調用query_count('Lee', 20)與不使用代理時調用query_count('Lee', 20)對使用者而言保持不變，不用改變代碼，但是在真正執行時，使用的是代理/裝飾後的函數。

這裡，基本利用Python的高階函數及名稱綁定完成瞭代理/裝飾的功能。

還有什麼不理想的地方呢？

對，就是query_count = query_count_proxy(query_count)，因為這句既不簡潔，又屬於重復工作。

Python為我們提供瞭語法糖來完成這類的tedious work。

方法就是：

@query_count_proxy
def query_count(name, age):
    return 'name is %s, age is %d' % (name, age)

query_count = query_count_proxy(query_count)就等同於在定義query_count函數的時候，在其前面加上@query_count_proxy。

Python看到這樣的語法，就會自動的執行query_count = query_count_proxy(query_count)進行name rebinding

補充

以上就是Python實現可調用對象裝飾的核心。

可調用對象包括函數、方法、實現瞭__call__方法的類，上述內容隻是針對函數來解釋，對於方法、實現瞭__call__方法的類，其基本原理相同，具體實現略有差別。

以上就是Python Decorator的設計模式演繹過程解析的詳細內容，更多關於Python Decorator設計模式的資料請關註WalkonNet其它相關文章！

推薦閱讀：