裝飾器
裝飾器是程序開發中經常會用到的一個功能,用好了裝飾器,開發效率如虎添翼,所以這也是Python面試中必問的問題,但對于好多初次接觸這個知識的人來講,這個功能有點繞,自學時直接繞過去了,然后面試問到了就掛了,因為裝飾器是程序開發的基礎知識,這個都不會,別跟人家說你會Python, 看了下面的文章,保證你學會裝飾器。
1、先明白這段代碼
#### 第一波 ####
def foo():print('foo')foo # 表示是函數
foo() # 表示執行foo函數#### 第二波 ####
def foo():print('foo')foo = lambda x: x + 1foo() # 執行lambda表達式,而不再是原來的foo函數,因為foo這個名字被重新指向了另外一個匿名函數
函數名僅僅是個變量,只不過指向了定義的函數而已,所以才能通過 函數名()調用,如果 函數名=xxx被修改了,那么當在執行 函數名()時,調用的就不知之前的那個函數了
2、需求來了
初創公司有N個業務部門,基礎平臺部門負責提供底層的功能,如:數據庫操作、redis調用、監控API等功能。業務部門使用基礎功能時,只需調用基礎平臺提供的功能即可。如下:
############### 基礎平臺提供的功能如下 ###############def f1():print('f1')def f2():print('f2')def f3():print('f3')def f4():print('f4')############### 業務部門A 調用基礎平臺提供的功能 ###############f1()
f2()
f3()
f4()############### 業務部門B 調用基礎平臺提供的功能 ###############f1()
f2()
f3()
f4()
目前公司有條不紊的進行著,但是,以前基礎平臺的開發人員在寫代碼時候沒有關注驗證相關的問題,即:基礎平臺的提供的功能可以被任何人使用。現在需要對基礎平臺的所有功能進行重構,為平臺提供的所有功能添加驗證機制,即:執行功能前,先進行驗證。
老大把工作交給 Low B,他是這么做的:
跟每個業務部門交涉,每個業務部門自己寫代碼,調用基礎平臺的功能之前先驗證。誒,這樣一來基礎平臺就不需要做任何修改了。太棒了,有充足的時間泡妹子...
當天Low B 被開除了…
老大把工作交給 Low BB,他是這么做的:
############### 基礎平臺提供的功能如下 ############### def f1():# 驗證1# 驗證2# 驗證3print('f1')def f2():# 驗證1# 驗證2# 驗證3print('f2')def f3():# 驗證1# 驗證2# 驗證3print('f3')def f4():# 驗證1# 驗證2# 驗證3print('f4')############### 業務部門不變 ###############
### 業務部門A 調用基礎平臺提供的功能### f1()
f2()
f3()
f4()### 業務部門B 調用基礎平臺提供的功能 ### f1()
f2()
f3()
f4()
過了一周 Low BB 被開除了…
老大把工作交給 Low BBB,他是這么做的:
只對基礎平臺的代碼進行重構,其他業務部門無需做任何修改
############### 基礎平臺提供的功能如下 ############### def check_login():# 驗證1# 驗證2# 驗證3passdef f1():check_login()print('f1')def f2():check_login()print('f2')def f3():check_login()print('f3')def f4():check_login()print('f4')
老大看了下Low BBB 的實現,嘴角漏出了一絲的欣慰的笑,語重心長的跟Low BBB聊了個天:
老大說:
寫代碼要遵循開放封閉
原則,雖然在這個原則是用的面向對象開發,但是也適用于函數式編程,簡單來說,它規定已經實現的功能代碼不允許被修改,但可以被擴展,即:
- 封閉:已實現的功能代碼塊
- 開放:對擴展開發
如果將開放封閉原則應用在上述需求中,那么就不允許在函數 f1 、f2、f3、f4的內部進行修改代碼,老板就給了Low BBB一個實現方案:
def w1(func):def inner():# 驗證1# 驗證2# 驗證3func()return inner@w1
def f1():print('f1')
@w1
def f2():print('f2')
@w1
def f3():print('f3')
@w1
def f4():print('f4')
對于上述代碼,也是僅僅對基礎平臺的代碼進行修改,就可以實現在其他人調用函數 f1 f2 f3 f4 之前都進行【驗證】操作,并且其他業務部門無需做任何操作。
Low BBB心驚膽戰的問了下,這段代碼的內部執行原理是什么呢?
老大正要生氣,突然Low BBB的手機掉到地上,恰巧屏保就是Low BBB的女友照片,老大一看一緊一抖,喜笑顏開,決定和Low BBB交個好朋友。
詳細的開始講解了:
單獨以f1為例:
def w1(func):def inner():# 驗證1# 驗證2# 驗證3func()return inner@w1
def f1():print('f1')
python解釋器就會從上到下解釋代碼,步驟如下:
- def w1(func): ==>將w1函數加載到內存
- @w1
沒錯, 從表面上看解釋器僅僅會解釋這兩句代碼,因為函數在 沒有被調用之前其內部代碼不會被執行。
從表面上看解釋器著實會執行這兩句,但是 @w1 這一句代碼里卻有大文章, @函數名 是python的一種語法糖。
上例@w1內部會執行一下操作:
執行w1函數
執行w1函數 ,并將 @w1 下面的函數作為w1函數的參數,即:@w1 等價于 w1(f1)?所以,內部就會去執行:
def inner(): #驗證 1#驗證 2#驗證 3f1() # func是參數,此時 func 等于 f1 return inner# 返回的 inner,inner代表的是函數,非執行函數 ,其實就是將原來的 f1 函數塞進另外一個函數中
w1的返回值
將執行完的w1函數返回值 賦值 給@w1下面的函數的函數名f1 即將w1的返回值再重新賦值給 f1,即:
新f1 = def inner(): #驗證 1#驗證 2#驗證 3原來f1()return inner
所以,以后業務部門想要執行 f1 函數時,就會執行 新f1 函數,在新f1 函數內部先執行驗證,再執行原來的f1函數,然后將原來f1 函數的返回值返回給了業務調用者。
如此一來, 即執行了驗證的功能,又執行了原來f1函數的內容,并將原f1函數返回值 返回給業務調用著
Low BBB 你明白了嗎?要是沒明白的話,我晚上去你家幫你解決吧!!!
3. 再議裝飾器
# 定義函數:完成包裹數據
def makeBold(fn):def wrapped():return "<b>" + fn() + "</b>"return wrapped# 定義函數:完成包裹數據
def makeItalic(fn):def wrapped():return "<i>" + fn() + "</i>"return wrapped@makeBold
def test1():return "hello world-1"@makeItalic
def test2():return "hello world-2"@makeBold
@makeItalic
def test3():return "hello world-3"print(test1())
print(test2())
print(test3())
運行結果:
<b>hello world-1</b>
<i>hello world-2</i>
<b><i>hello world-3</i></b>
4. 裝飾器(decorator)功能
- 引入日志
- 函數執行時間統計
- 執行函數前預備處理
- 執行函數后清理功能
- 權限校驗等場景
- 緩存
5. 裝飾器示例
例1:無參數的函數
from time import ctime, sleepdef timefun(func):def wrapped_func():print("%s called at %s" % (func.__name__, ctime()))func()return wrapped_func@timefun
def foo():print("I am foo")foo()
sleep(2)
foo()
上面代碼理解裝飾器執行行為可理解成
foo = timefun(foo)
# foo先作為參數賦值給func后,foo接收指向timefun返回的wrapped_func
foo()
# 調用foo(),即等價調用wrapped_func()
# 內部函數wrapped_func被引用,所以外部函數的func變量(自由變量)并沒有釋放
# func里保存的是原foo函數對象
例2:被裝飾的函數有參數
from time import ctime, sleepdef timefun(func):def wrapped_func(a, b):print("%s called at %s" % (func.__name__, ctime()))print(a, b)func(a, b)return wrapped_func@timefun
def foo(a, b):print(a+b)foo(3,5)
sleep(2)
foo(2,4)
例3:被裝飾的函數有不定長參數
from time import ctime, sleepdef timefun(func):def wrapped_func(*args, **kwargs):print("%s called at %s"%(func.__name__, ctime()))func(*args, **kwargs)return wrapped_func@timefun
def foo(a, b, c):print(a+b+c)foo(3,5,7)
sleep(2)
foo(2,4,9)
例4:裝飾器中的return
from time import ctime, sleepdef timefun(func):def wrapped_func():print("%s called at %s" % (func.__name__, ctime()))func()return wrapped_func@timefun
def foo():print("I am foo")@timefun
def getInfo():return '----hahah---'foo()
sleep(2)
foo()print(getInfo())
執行結果:
foo called at Fri Nov 4 21:55:35 2016
I am foo
foo called at Fri Nov 4 21:55:37 2016
I am foo
getInfo called at Fri Nov 4 21:55:37 2016
None
如果修改裝飾器為return func()
,則運行結果:
foo called at Fri Nov 4 21:55:57 2016
I am foo
foo called at Fri Nov 4 21:55:59 2016
I am foo
getInfo called at Fri Nov 4 21:55:59 2016
----hahah---
總結:
- 一般情況下為了讓裝飾器更通用,可以有return
例5:裝飾器帶參數,在原有裝飾器的基礎上,設置外部變量
#decorator2.pyfrom time import ctime, sleepdef timefun_arg(pre="hello"):def timefun(func):def wrapped_func():print("%s called at %s %s" % (func.__name__, ctime(), pre))return func()return wrapped_funcreturn timefun# 下面的裝飾過程
# 1. 調用timefun_arg("itcast")
# 2. 將步驟1得到的返回值,即time_fun返回, 然后time_fun(foo)
# 3. 將time_fun(foo)的結果返回,即wrapped_func
# 4. 讓foo = wrapped_fun,即foo現在指向wrapped_func
@timefun_arg("itcast")
def foo():print("I am foo")@timefun_arg("python")
def too():print("I am too")foo()
sleep(2)
foo()too()
sleep(2)
too()
可以理解為
foo()==timefun_arg("itcast")(foo)()
例6:類裝飾器(擴展,非重點)
裝飾器函數其實是這樣一個接口約束,它必須接受一個callable對象作為參數,然后返回一個callable對象。在Python中一般callable對象都是函數,但也有例外。只要某個對象重寫了?__call__()
?方法,那么這個對象就是callable的。
class Test():def __call__(self):print('call me!')t = Test()
t() # call me
類裝飾器demo
class Test(object):def __init__(self, func):print("---初始化---")print("func name is %s"%func.__name__)self.__func = funcdef __call__(self):print("---裝飾器中的功能---")self.__func()
#說明:
#1. 當用Test來裝作裝飾器對test函數進行裝飾的時候,首先會創建Test的實例對象
# 并且會把test這個函數名當做參數傳遞到__init__方法中
# 即在__init__方法中的屬性__func指向了test指向的函數
#
#2. test指向了用Test創建出來的實例對象
#
#3. 當在使用test()進行調用時,就相當于讓這個對象(),因此會調用這個對象的__call__方法
#
#4. 為了能夠在__call__方法中調用原來test指向的函數體,所以在__init__方法中就需要一個實例屬性來保存這個函數體的引用
# 所以才有了self.__func = func這句代碼,從而在調用__call__方法中能夠調用到test之前的函數體
@Test
def test():print("----test---")
test()
showpy()#如果把這句話注釋,重新運行程序,依然會看到"--初始化--"
運行結果如下:
---初始化---
func name is test
---裝飾器中的功能---
----test---