Python的@裝飾器是干什么用的？

NusterCache 發(fā)布于2021-11-23 09:51 / 1035人閱讀

摘要：那么，這個裝飾器要怎么定義呢我們來看一下。當(dāng)然了，如果大家在網(wǎng)絡(luò)上搜索，關(guān)于如何定義裝飾器，看到的是一個更加規(guī)范的版本。在當(dāng)中，調(diào)用原函數(shù)時又，即把輸入的元祖解包再傳入。

我們在編程過程中，常常會遇到這種需求：

比如，我想開發(fā)一款計(jì)算器，我已經(jīng)寫好了一堆函數(shù)，用于執(zhí)行各種計(jì)算，那么我們需要在執(zhí)行各種計(jì)算函數(shù)前，首先對輸入的數(shù)據(jù)進(jìn)行檢查，確保他們必須得是數(shù)值才允許執(zhí)行函數(shù)，而不能是字符串；

又如，我想編寫一個用于計(jì)算三角形周長、面積、某個角角度的模塊，已經(jīng)寫好幾個函數(shù)用于計(jì)算，那么，在執(zhí)行計(jì)算前，首先要確保輸入的三條邊長能夠構(gòu)成三角形，再進(jìn)行計(jì)算才有意義；

再比如，我想開發(fā)某款網(wǎng)絡(luò)應(yīng)用，寫了一些函數(shù)用于實(shí)現(xiàn)用戶的某些操作，那么，得要先檢查確認(rèn)該用戶已經(jīng)登錄了，才允許執(zhí)行這些操作。

這些需求，歸納起來，就是，在執(zhí)行主函數(shù)之前，常常要先執(zhí)行某個預(yù)函數(shù)，進(jìn)行一些校驗(yàn)之類的操作。

這類需求是非常常見的，也是保證程序完整性、健壯性的重要舉措。所以，怎么做才比較簡單呢？

你會說，這很簡單啊，在每個函數(shù)里面寫上if語句不就得了。就拿那個計(jì)算器而言，如果我們要寫加減乘除，我們可以這樣：

def plus(a,b):    if type(a)==type(0) and type(b)==type(0): #假設(shè)該計(jì)算器只能計(jì)算整數(shù)，如果要計(jì)算小數(shù)再or type(0.0)        return a+b    else:        print("Type must be number") #檢測到數(shù)據(jù)類型不對，先輸出報(bào)警，函數(shù)值返回None        return Nonedef minus(a,b):    if type(a)==type(0) and type(b)==type(0):        return a-b    else:        print("Type must be number")        return Nonedef multiply(a,b):    if type(a)==type(0) and type(b)==type(0):        return a*b    else:        print("Type must be number")        return Nonedef divide(a,b):    if type(a)==type(0) and type(b)==type(0):        return a/b    else:        print("Type must be number")        return None

這個嘛，直接暴力。但是呢，這里只有4個函數(shù)，假如你開發(fā)的計(jì)算器有幾十幾百個函數(shù)，每個函數(shù)都要套上if語句，這不得麻煩死了，不煩死也啰嗦死了。

所以怎么弄簡單一點(diǎn)呢？聰明的你肯定想到了，我們可以把那個判斷if也多帶帶定義一個函數(shù)，然后把計(jì)算用的函數(shù)套在里面，就像這樣：

def check(a,b,func): #定義檢查函數(shù)，變量為待檢測參數(shù)a,b和檢測通過后執(zhí)行的函數(shù)func    if type(a)==type(0) and type(b)==type(0):        return func(a,b)    else:        print("Type must be number")        return Nonedef plus(a,b):    return a+bdef minus(a,b):    return a-b...#主程序check(1,2,plus) #計(jì)算1+2check(1,2,minus) #計(jì)算1-2check(1,2,multiply) #計(jì)算1*2check(1,2,divide) #計(jì)算1/2

這里面有一點(diǎn)一定要特別注意，主程序的check(1,2,plus) 是把plus函數(shù)本身作為變量傳遞給check，由check函數(shù)決定如何執(zhí)行plus函數(shù)，此處不能寫成check(1,2,plus(1,2))，plus不能帶參數(shù)和括號，不是執(zhí)行plus()后把結(jié)果傳給check。

這么寫程序簡潔了不少，加減乘除函數(shù)只需要定義他們本身的運(yùn)算就可以了，變量檢測交給了check函數(shù)。這么寫也是比較容易理解的。

但是對于使用該程序的用戶來說，就不是這么回事了，他們會覺得這么寫非常難看。

為什么呢？我是要拿程序做加減乘除計(jì)算的，但我不論計(jì)算什么，每次都是在主調(diào)用check這個函數(shù)！

那有沒有什么辦法，可以既好看，又簡潔呢？裝飾器就是起到了這個神奇的作用。

上面這個需求，用裝飾器可以這么寫：

def check(func):    ...@checkdef plus(a,b):    return a+b@checkdef minus(a,b):    return a-b...#主程序plus(1,2) #計(jì)算1+2minus(1,2) #計(jì)算1-2...

先直觀感受一下，通過@check，check函數(shù)就被“注入”到了plus函數(shù)中，使得plus函數(shù)擁有了參數(shù)檢測的功能。這樣，在主程序中，若要計(jì)算加法就可直接調(diào)用plus，便可先校驗(yàn)再計(jì)算。

那么，這個裝飾器check要怎么定義呢？我們來看一下。

def check(func): #定義裝飾器check    def newfunc(a,b): #定義函數(shù)模板，即如何處理func        if type(a)==type(0) and type(b)==type(0):            return func(a,b)        else:            print("Type must be number!")            return None    return newfunc #將處理后的func作為新函數(shù)newfunc輸出@checkdef plus(a,b):    return a+b#主程序，計(jì)算1+2plus(1,2)

我們可以看到，當(dāng)裝飾器@check作用于plus函數(shù)時，plus函數(shù)本身作為參數(shù)func傳入裝飾器中。在裝飾器check的定義內(nèi)部，定義了一個函數(shù)模板，描述了對輸入的func如何處理。可以看到，newfunc對func（也就是輸入的plus）套用了判斷數(shù)據(jù)類型的if語句，最后，再將套好的newfunc輸出，替代原來的func。這樣，此時執(zhí)行func就是在執(zhí)行newfunc，執(zhí)行plus就是在執(zhí)行套上if語句的新函數(shù)。

所以，通過裝飾器，添加上了判斷語句的新函數(shù)替換了原來的plus函數(shù)，但仍通過plus這個函數(shù)名調(diào)用，所以看起來就是plus函數(shù)被“裝飾”了。

當(dāng)然了，如果大家在網(wǎng)絡(luò)上搜索，關(guān)于如何定義裝飾器，看到的是一個更加規(guī)范的版本。看起來更難理解一些，但其實(shí)是一樣的：

def checkall(func):    def wrapper(*args,**kwargs):        if type(args[0])==type(0) and type(args[1])==type(0):            return func(*args,**kwargs)        else:            print("Type must be number!")            return None    return wrapper

模板函數(shù)一般習(xí)慣用wrapper來表示，這個沒啥，建議大家都這么寫，規(guī)范一些。

參數(shù)一般用不定長的*args,**kwargs來表示，這個可能有些人就困惑了。因?yàn)楸谎b飾的函數(shù)可能有很多種，參數(shù)的個數(shù)一般也不確定。然后*args,**kwargs是什么東西？args，kwargs這兩個形參英文字母是什么無所謂可以自己定，關(guān)鍵是前面的單星號*和雙星號**。

假如我定義一個函數(shù)，不能確定參數(shù)有多少個，例如要對輸入的一組數(shù)字做連加操作。那么就可以定義plus(*x)，當(dāng)調(diào)用該函數(shù)時，若輸入多個變量plus(1,2,3)，那么就會把輸入的變量組合成一個元祖x=(1,2,3)輸入。定義雙星號plus(**x)的意思是，調(diào)用該函數(shù)時若寫出形參變量plus(a=1,b=2,c=3)，那么輸入變量就會組合成字典x={a:1,b:2,c:3}傳入函數(shù)。

當(dāng)然也可以反向操作，定義函數(shù)的時候參數(shù)個數(shù)是明確的plus(a,b,c)，那么調(diào)用該函數(shù)時，加上星號plus(*(1,2,3))，就是對輸入元祖(1,2,3)執(zhí)行炸開操作，轉(zhuǎn)換為plus(1,2,3)輸入。

裝飾器里這么寫有什么用呢？我們仔細(xì)觀察一下我們之前寫的newfunc(a,b)，那就意味著，指明了新函數(shù)有兩個參數(shù)a,b，假如被裝飾的原函數(shù)有三個參數(shù)怎么辦呢？不就沒用了嗎？

我們來看別人寫的，定義時用了wrapper(*args,**kwargs)，即不管有多少個參數(shù)，打包輸入wrapper。在wrapper當(dāng)中，調(diào)用原函數(shù)時又func(*args,**kwargs)，即把輸入的元祖解包再傳入func。這么一打包一解包，雖然看起來啥都沒干，但確適應(yīng)了函數(shù)參數(shù)不確定的情況，使得該裝飾器可以裝飾多種參數(shù)數(shù)量不同的函數(shù)。

就先這樣吧。