如果看完這一篇文章還不理解裝飾器,這說明我寫的還不夠清晰藕甩、詳細施敢,那請鼓勵鼓勵我吧。
講 Python 裝飾器前狭莱,我想先舉個例子悯姊,雖有點污,但跟裝飾器這個話題很貼切贩毕。
談裝飾器前,還要先要明白一件事辉阶,Python 中的函數(shù)和 Java先壕、C++不太一樣瘩扼,Python 中的函數(shù)可以像普通變量一樣當做參數(shù)傳遞給另外一個函數(shù),例如:
正式回到我們的主題集绰。裝飾器本質(zhì)上是一個 Python 函數(shù)或類,它可以讓其他函數(shù)或類在不需要做任何代碼修改的前提下增加額外功能谆棺,裝飾器的返回值也是一個函數(shù)/類對象栽燕。它經(jīng)常用于有切面需求的場景,比如:插入日志改淑、性能測試碍岔、事務(wù)處理、緩存朵夏、權(quán)限校驗等場景蔼啦,裝飾器是解決這類問題的絕佳設(shè)計。有了裝飾器仰猖,我們就可以抽離出大量與函數(shù)功能本身無關(guān)的雷同代碼到裝飾器中并繼續(xù)重用捏肢。概括的講,裝飾器的作用就是為已經(jīng)存在的對象添加額外的功能饥侵。
先來看一個簡單例子鸵赫,雖然實際代碼可能比這復雜很多:
現(xiàn)在有一個新的需求躏升,希望可以記錄下函數(shù)的執(zhí)行日志辩棒,于是在代碼中添加日志代碼:
如果函數(shù) bar()煮甥、bar2() 也有類似的需求,怎么做藕赞?再寫一個 logging 在 bar 函數(shù)里成肘?這樣就造成大量雷同的代碼,為了減少重復寫代碼斧蜕,我們可以這樣做双霍,重新定義一個新的函數(shù):專門處理日志 ,日志處理完之后再執(zhí)行真正的業(yè)務(wù)代碼
這樣做邏輯上是沒問題的洒闸,功能是實現(xiàn)了,但是我們調(diào)用的時候不再是調(diào)用真正的業(yè)務(wù)邏輯 foo 函數(shù)均芽,而是換成了 use_logging 函數(shù)丘逸,這就破壞了原有的代碼結(jié)構(gòu), 現(xiàn)在我們不得不每次都要把原來的那個 foo 函數(shù)作為參數(shù)傳遞給 use_logging 函數(shù)掀宋,那么有沒有更好的方式的呢深纲?當然有仲锄,答案就是裝飾器。
簡單裝飾器
use_logging 就是一個裝飾器儒喊,它一個普通的函數(shù),它把執(zhí)行真正業(yè)務(wù)邏輯的函數(shù) func 包裹在其中币呵,看起來像 foo 被 use_logging 裝飾了一樣怀愧,use_logging 返回的也是一個函數(shù),這個函數(shù)的名字叫 wrapper余赢。在這個例子中芯义,函數(shù)進入和退出時 ,被稱為一個橫切面没佑,這種編程方式被稱為面向切面的編程毕贼。
@ 語法糖
如果你接觸 Python 有一段時間了的話,想必你對 @ 符號一定不陌生了蛤奢,沒錯 @ 符號就是裝飾器的語法糖鬼癣,它放在函數(shù)開始定義的地方,這樣就可以省略最后一步再次賦值的操作啤贩。
如上所示,有了 @ 痹屹,我們就可以省去foo = use_logging(foo)這一句了章郁,直接調(diào)用 foo() 即可得到想要的結(jié)果。你們看到了沒有志衍,foo() 函數(shù)不需要做任何修改暖庄,只需在定義的地方加上裝飾器,調(diào)用的時候還是和以前一樣楼肪,如果我們有其他的類似函數(shù)培廓,我們可以繼續(xù)調(diào)用裝飾器來修飾函數(shù),而不用重復修改函數(shù)或者增加新的封裝春叫。這樣肩钠,我們就提高了程序的可重復利用性,并增加了程序的可讀性暂殖。
裝飾器在 Python 使用如此方便都要歸因于 Python 的函數(shù)能像普通的對象一樣能作為參數(shù)傳遞給其他函數(shù)价匠,可以被賦值給其他變量,可以作為返回值呛每,可以被定義在另外一個函數(shù)內(nèi)踩窖。
可能有人問晨横,如果我的業(yè)務(wù)邏輯函數(shù) foo 需要參數(shù)怎么辦毙石?比如:
我們可以在定義 wrapper 函數(shù)的時候指定參數(shù):
這樣 foo 函數(shù)定義的參數(shù)就可以定義在 wrapper 函數(shù)中徐矩。這時滞时,又有人要問了,如果 foo 函數(shù)接收兩個參數(shù)呢滤灯?三個參數(shù)呢坪稽?更有甚者,我可能傳很多個鳞骤。當裝飾器不知道 foo 到底有多少個參數(shù)時窒百,我們可以用 *args 來代替:
如此一來豫尽,甭管 foo 定義了多少個參數(shù)籍滴,我都可以完整地傳遞到 func 中去卢鹦。這樣就不影響 foo 的業(yè)務(wù)邏輯了穴豫。這時還有讀者會問渔肩,如果 foo 函數(shù)還定義了一些關(guān)鍵字參數(shù)呢?比如:
這時妄呕,你就可以把 wrapper 函數(shù)指定關(guān)鍵字函數(shù):
帶參數(shù)的裝飾器
裝飾器還有更大的靈活性嗽测,例如帶參數(shù)的裝飾器绪励,在上面的裝飾器調(diào)用中,該裝飾器接收唯一的參數(shù)就是執(zhí)行業(yè)務(wù)的函數(shù) foo 唠粥。裝飾器的語法允許我們在調(diào)用時疏魏,提供其它參數(shù),比如@decorator(a)晤愧。這樣大莫,就為裝飾器的編寫和使用提供了更大的靈活性。比如养涮,我們可以在裝飾器中指定日志的等級葵硕,因為不同業(yè)務(wù)函數(shù)可能需要的日志級別是不一樣的眉抬。
上面的 use_logging 是允許帶參數(shù)的裝飾器蜀变。它實際上是對原有裝飾器的一個函數(shù)封裝悄谐,并返回一個裝飾器。我們可以將它理解為一個含有參數(shù)的閉包库北。當我
們使用@use_logging(level="warn")調(diào)用的時候爬舰,Python 能夠發(fā)現(xiàn)這一層的封裝们陆,并把參數(shù)傳遞到裝飾器的環(huán)境中。
@use_logging(level="warn")等價于@decorator
類裝飾器
沒錯情屹,裝飾器不僅可以是函數(shù)坪仇,還可以是類,相比函數(shù)裝飾器垃你,類裝飾器具有靈活度大椅文、高內(nèi)聚、封裝性等優(yōu)點惜颇。使用類裝飾器主要依靠類的call方法皆刺,當使用 @ 形式將裝飾器附加到函數(shù)上時,就會調(diào)用此方法凌摄。
使用裝飾器極大地復用了代碼,但是他有一個缺點就是原函數(shù)的元信息不見了锨亏,比如函數(shù)的docstring痴怨、name、參數(shù)列表屯伞,先看例子:
裝飾器
函數(shù)
不難發(fā)現(xiàn)劣摇,函數(shù) f 被with_logging取代了珠移,當然它的docstring,name就是變成了with_logging函數(shù)的信息了末融。好在我們有functools.wraps钧惧,wraps本身也是一個裝飾器,它能把原函數(shù)的元信息拷貝到裝飾器里面的 func 函數(shù)中勾习,這使得裝飾器里面的 func 函數(shù)也有和原函數(shù) foo 一樣的元信息了浓瞪。
裝飾器順序
一個函數(shù)還可以同時定義多個裝飾器巧婶,比如:
它的執(zhí)行順序是從里到外,最先調(diào)用最里層的裝飾器艺栈,最后調(diào)用最外層的裝飾器英岭,它等效于