綜述

裝飾器本質(zhì)上是一個(gè) Python 函數(shù)或類，它可以讓其他函數(shù)或類在不需要做任何代碼修改的前提下增加額外功能，裝飾器的返回值也是一個(gè)函數(shù)/類對(duì)象。它經(jīng)常用于有切面需求的場(chǎng)景，比如：插入日志、性能測(cè)試、事務(wù)處理、緩存、權(quán)限校驗(yàn)等場(chǎng)景，裝飾器是解決這類問(wèn)題的絕佳設(shè)計(jì)。有了裝飾器，我們就可以抽離出大量與函數(shù)功能本身無(wú)關(guān)的雷同代碼到裝飾器中并繼續(xù)重用。概括的講，裝飾器的作用就是為已經(jīng)存在的對(duì)象添加額外的功能。

詳解

談裝飾器前，還要先要明白一件事，Python 中的函數(shù)和 Java、C++不太一樣，Python 中的函數(shù)可以像普通變量一樣當(dāng)做參數(shù)傳遞給另外一個(gè)函數(shù)，例如：

def foo():
    print("foo")

def bar(func):
    func()

bar(foo)

先來(lái)看一個(gè)簡(jiǎn)單例子，雖然實(shí)際代碼可能比這復(fù)雜很多：

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

現(xiàn)在有一個(gè)新的需求，希望可以記錄下函數(shù)的執(zhí)行日志，于是在代碼中添加日志代碼：

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

如果函數(shù) bar()、bar2() 也有類似的需求，怎么做？再寫一個(gè) logging 在 bar 函數(shù)里？這樣就造成大量雷同的代碼，為了減少重復(fù)寫代碼，我們可以這樣做，重新定義一個(gè)新的函數(shù)：專門處理日志 ，日志處理完之后再執(zhí)行真正的業(yè)務(wù)代碼

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

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

use_logging(foo)

這樣做邏輯上是沒問(wèn)題的，功能是實(shí)現(xiàn)了，但是我們調(diào)用的時(shí)候不再是調(diào)用真正的業(yè)務(wù)邏輯 foo 函數(shù)，而是換成了 use_logging 函數(shù)，這就破壞了原有的代碼結(jié)構(gòu)， 現(xiàn)在我們不得不每次都要把原來(lái)的那個(gè) foo 函數(shù)作為參數(shù)傳遞給 use_logging 函數(shù)，那么有沒有更好的方式的呢？當(dāng)然有，答案就是裝飾器。

簡(jiǎn)單裝飾器

def use_logging(func):
    def wrapper():
        logging.warn("%s is running" % func.__name__)
        return func()   # 把 foo 當(dāng)做參數(shù)傳遞進(jìn)來(lái)時(shí)，執(zhí)行func()就相當(dāng)于執(zhí)行foo()
    return wrapper

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

foo = use_logging(foo)  # 因?yàn)檠b飾器 use_logging(foo) 返回的時(shí)函數(shù)對(duì)象 wrapper，這條語(yǔ)句相當(dāng)于  foo = wrapper
foo()                    # 執(zhí)行foo()就相當(dāng)于執(zhí)行 wrapper()

use_logging 就是一個(gè)裝飾器，它一個(gè)普通的函數(shù)，它把執(zhí)行真正業(yè)務(wù)邏輯的函數(shù) func 包裹在其中，看起來(lái)像 foo 被 use_logging 裝飾了一樣，use_logging 返回的也是一個(gè)函數(shù)，這個(gè)函數(shù)的名字叫 wrapper。在這個(gè)例子中，函數(shù)進(jìn)入和退出時(shí) ，被稱為一個(gè)橫切面，這種編程方式被稱為面向切面的編程。

@ 語(yǔ)法糖

如果你接觸 Python 有一段時(shí)間了的話，想必你對(duì) @ 符號(hào)一定不陌生了，沒錯(cuò) @ 符號(hào)就是裝飾器的語(yǔ)法糖，它放在函數(shù)開始定義的地方，這樣就可以省略最后一步再次賦值的操作。

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

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

foo()

如上所示，有了 @ ，我們就可以省去foo = use_logging(foo)這一句了，直接調(diào)用 foo() 即可得到想要的結(jié)果。你們看到了沒有，foo() 函數(shù)不需要做任何修改，只需在定義的地方加上裝飾器，調(diào)用的時(shí)候還是和以前一樣，如果我們有其他的類似函數(shù)，我們可以繼續(xù)調(diào)用裝飾器來(lái)修飾函數(shù)，而不用重復(fù)修改函數(shù)或者增加新的封裝。這樣，我們就提高了程序的可重復(fù)利用性，并增加了程序的可讀性。

裝飾器在 Python 使用如此方便都要?dú)w因于 Python 的函數(shù)能像普通的對(duì)象一樣能作為參數(shù)傳遞給其他函數(shù)，可以被賦值給其他變量，可以作為返回值，可以被定義在另外一個(gè)函數(shù)內(nèi)。

*args、**kwargs

可能有人問(wèn)，如果我的業(yè)務(wù)邏輯函數(shù) foo 需要參數(shù)怎么辦？比如：

def foo(name):
    print("i am %s" % name)

我們可以在定義 wrapper 函數(shù)的時(shí)候指定參數(shù)：

def wrapper(name):
        logging.warn("%s is running" % func.__name__)
        return func(name)
    return wrapper

這樣 foo 函數(shù)定義的參數(shù)就可以定義在 wrapper 函數(shù)中。這時(shí)，又有人要問(wèn)了，如果 foo 函數(shù)接收兩個(gè)參數(shù)呢？三個(gè)參數(shù)呢？更有甚者，我可能傳很多個(gè)。當(dāng)裝飾器不知道 foo 到底有多少個(gè)參數(shù)時(shí)，我們可以用 *args 來(lái)代替：

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

如此一來(lái)，甭管 foo 定義了多少個(gè)參數(shù)，我都可以完整地傳遞到 func 中去。這樣就不影響 foo 的業(yè)務(wù)邏輯了。這時(shí)還有讀者會(huì)問(wèn)，如果 foo 函數(shù)還定義了一些關(guān)鍵字參數(shù)呢？比如：

def foo(name, age=None, height=None):
    print("I am %s, age %s, height %s" % (name, age, height))

這時(shí)，你就可以把 wrapper 函數(shù)指定關(guān)鍵字函數(shù)：

def wrapper(*args, **kwargs):
        # args是一個(gè)數(shù)組，kwargs一個(gè)字典
        logging.warn("%s is running" % func.__name__)
        return func(*args, **kwargs)
    return wrapper

帶參數(shù)的裝飾器

裝飾器還有更大的靈活性，例如帶參數(shù)的裝飾器，在上面的裝飾器調(diào)用中，該裝飾器接收唯一的參數(shù)就是執(zhí)行業(yè)務(wù)的函數(shù) foo 。裝飾器的語(yǔ)法允許我們?cè)谡{(diào)用時(shí)，提供其它參數(shù)，比如@decorator(a)。這樣，就為裝飾器的編寫和使用提供了更大的靈活性。比如，我們可以在裝飾器中指定日志的等級(jí)，因?yàn)椴煌瑯I(yè)務(wù)函數(shù)可能需要的日志級(jí)別是不一樣的。

def use_logging(level):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if level == "warn":
                logging.warn("%s is running" % func.__name__)
            elif level == "info":
                logging.info("%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 是允許帶參數(shù)的裝飾器。它實(shí)際上是對(duì)原有裝飾器的一個(gè)函數(shù)封裝，并返回一個(gè)裝飾器。我們可以將它理解為一個(gè)含有參數(shù)的閉包。當(dāng)我們使用@use_logging(level="warn")調(diào)用的時(shí)候，Python 能夠發(fā)現(xiàn)這一層的封裝，并把參數(shù)傳遞到裝飾器的環(huán)境中。
@use_logging(level="warn")等價(jià)于@decorator

類裝飾器

沒錯(cuò)，裝飾器不僅可以是函數(shù)，還可以是類，相比函數(shù)裝飾器，類裝飾器具有靈活度大、高內(nèi)聚、封裝性等優(yōu)點(diǎn)。使用類裝飾器主要依靠類的call方法，當(dāng)使用 @ 形式將裝飾器附加到函數(shù)上時(shí)，就會(huì)調(diào)用此方法。

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

使用裝飾器極大地復(fù)用了代碼，但是他有一個(gè)缺點(diǎn)就是原函數(shù)的元信息不見了，比如函數(shù)的docstring、name、參數(shù)列表，先看例子：

# 裝飾器
def logged(func):
    def with_logging(*args, **kwargs):
        print func.__name__      # 輸出 'with_logging'
        print func.__doc__       # 輸出 None
        return func(*args, **kwargs)
    return with_logging

# 函數(shù)
@logged
def f(x):
   """does some math"""
   return x + x * x

logged(f)

不難發(fā)現(xiàn)，函數(shù) f 被with_logging取代了，當(dāng)然它的docstring，name就是變成了with_logging函數(shù)的信息了。好在我們有functools.wraps，wraps本身也是一個(gè)裝飾器，它能把原函數(shù)的元信息拷貝到裝飾器里面的 func 函數(shù)中，這使得裝飾器里面的 func 函數(shù)也有和原函數(shù) foo 一樣的元信息了。

from functools import wraps
def logged(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print func.__name__      # 輸出 'f'
        print func.__doc__       # 輸出 'does some math'
        return func(*args, **kwargs)
    return with_logging

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

裝飾器順序

一個(gè)函數(shù)還可以同時(shí)定義多個(gè)裝飾器，比如：

@a
@b
@c
def f ():
    pass

它的執(zhí)行順序是從里到外，最先調(diào)用最里層的裝飾器，最后調(diào)用最外層的裝飾器，它等效于f = a(b(c(f)))