裝飾器本質上是一個函式，該函式用來處理其他函式，它可以讓其他函式在不需要修改程式碼的前提下增加額外的功能，裝飾器的返回值也是一個函式物件。它經常用於有切面需求的場景，比如：插入日誌、效能測試、事務處理、快取、許可權校驗等應用場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函式功能本身無關的雷同程式碼並繼續重用。概括的講，裝飾器的作用就是為已經存在的物件新增額外的功能。

先來看一個簡單例子：

def foo():
    print('i am foo')

現在有一個新的需求，希望可以記錄下函式的執行日誌，於是在程式碼中新增日誌程式碼：

def foo():
    print('i am foo')
    logging.info("foo is running")

bar()、bar2()也有類似的需求，怎麼做？再寫一個logging在bar函式裡？這樣就造成大量雷同的程式碼，為了減少重複寫程式碼，我們可以這樣做，重新定義一個函式：專門處理日誌 ，日誌處理完之後再執行真正的業務程式碼

def use_logging(func):
    logging.warn("%s is running" % func.__name__)
    func()

def bar():
    print('i am bar')

use_logging(bar)

邏輯上不難理解，而且執行正常。 但是這樣的話，我們每次都要將一個函式作為引數傳遞給use_logging

簡單裝飾器

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()

函式use_logging就是裝飾器，它把真正的業務方法func包裹在函式裡面，看起來像bar被use_logging裝飾了。在這個例子中，函式進入和退出時 ，被稱為一個橫切面(Aspect)，這種程式設計方式被稱為面向切面的程式設計(Aspect-Oriented Programming)。

@符號是裝飾器的語法糖，在定義函式的時候使用，避免再一次賦值操作

def use_logging(func):

    def wrapper(*args, **kwargs):
        logging.warn("%s is running" % func.__name__)
        return func(*args)
    return wrapper

@use_logging
def foo():
    print("i am foo")

@use_logging
def bar():
    print("i am bar")

bar()

如上所示，這樣我們就可以省去bar = use_logging(bar)這一句了，直接呼叫bar()即可得到想要的結果。如果我們有其他的類似函式，我們可以繼續呼叫裝飾器來修飾函式，而不用重複修改函式或者增加新的封裝。這樣，我們就提高了程式的可重複利用性，並增加了程式的可讀性。

裝飾器在Python使用如此方便都要歸因於Python的函式能像普通的物件一樣能作為引數傳遞給其他函式，可以被賦值給其他變數，可以作為返回值，可以被定義在另外一個函式內。

帶引數的裝飾器

裝飾器還有更大的靈活性，例如帶引數的裝飾器：在上面的裝飾器呼叫中，比如@use_logging，該裝飾器唯一的引數就是執行業務的函式。裝飾器的語法允許我們在呼叫時，提供其它引數，比如@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是允許帶引數的裝飾器。它實際上是對原有裝飾器的一個函式封裝，並返回一個裝飾器。我們可以將它理解為一個含有引數的閉包。當我 們使用@use_logging(level="warn")呼叫的時候，Python能夠發現這一層的封裝，並把引數傳遞到裝飾器的環境中。

類裝飾器

再來看看類裝飾器，相比函式裝飾器，類裝飾器具有靈活度大、高內聚、封裝性等優點。使用類裝飾器還可以依靠類內部的\_\_call\_\_方法，當使用 @ 形式將裝飾器附加到函式上時，就會呼叫此方法。

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

使用裝飾器極大地複用了程式碼，但是他有一個缺點就是原函式的元資訊不見了，比如函式的docstring、__name__、引數列表，先看例子：

裝飾器

def logged(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

該函式完成等價於：

def f(x):
    """does some math"""
    return x + x * x
f = logged(f)

不難發現，函式f被with_logging取代了，當然它的docstring，__name__就是變成了with_logging函式的資訊了。

print f.__name__    # prints 'with_logging'
print f.__doc__     # prints None

這個問題就比較嚴重的，好在我們有functools.wraps，wraps本身也是一個裝飾器，它能把原函式的元資訊拷貝到裝飾器函式中，這使得裝飾器函式也有和原函式一樣的元資訊了。

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'

內建裝飾器

@staticmathod、@classmethod、@property

裝飾器的順序

@a
@b
@c
def f ():

等效於

f = a(b(c(f)))

關注公眾號「Python之禪」（id：vttalk）獲取最新文章