python装饰器函数执行后日志_python 装饰器理解
在理解裝飾器之前，先應該對閉包有個概念：所謂閉包，就是將組成函數的語句和這些語句的執行環境打包在一起時得到的對象，它的主要作用是封存上下文。這一特性可以巧妙的被用于現有函數的包裝，從而為現有函數添加功能，這就是裝飾器。
裝飾器的本質與作用
裝飾器(Decorator)的本質是一個Python函數，它可以讓其他函數在不需要做任何代碼變動的前提下增加額外的功能，裝飾器的返回值也是一個函數對象。
它經常用于有切面需求的場景 ，比如：插入日志、性能測試、事務處理、緩存、權限校驗等場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函數功能本身無關的雷同代碼并繼續復用。
我們先看一個例子，代碼如下：1
2
3
4#!/usr/bin python
deffoo():
print('i am foo')
現在有一個新的需求，希望可以記錄下函數的執行日志，于是在代碼中添加了日志代碼：1
2
3deffoo():
print('i am foo')
logging.info("foo is running")
此時bar()、bar2()也有類似的需求，再寫一個logging在bar函數里？為了提高代碼的復用，我們重新定義一個函數：專門處理日志，日志處理完后再執行真正的業務代碼：1
2
3
4
5
6
7
8
9
10#!/usr/bin python
defuse_logging(func):
logging.warn("%s is running"%func.__name__)
func()
defbar():
print('i am bar')
use_logging(bar)
上述代碼雖然解決了，但是我們每次都要將一個函數作為參數傳遞給use_logging函數，而且這種方式以已經破壞了原有的代碼邏輯結構，本來的業務邏輯是執行bar()，但是現在不得已改成執行use_logging(bar)。鑒于這個弊端，Python裝飾器應運而生。
簡單裝飾器
函數use_logging就是裝飾器，它把執行真正業務方法的func包裹在函數里面，看起來像bar被use_logging裝飾了。1
2
3
4
5
6
7
8
9
10
11defuse_logging(func):
defwrapper(*args,**kwargs):
logging.warn("%s is running"%func.__name__)
returnfunc(*args,**kwargs)
returnwrapper
defbar():
print('i am bar')
bar=use_logging(func)
bar()
在這個例子中，函數進入和退出時，被稱為一個橫切面(Aspect)，這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。
但是bar = use_logging(func)這樣的寫法未免太過麻煩，于是Python提供了一種更優雅的寫法：語法糖。@符號是裝飾器的語法糖，在定義函數時使用，避免了再一次賦值操作。1
2
3
4
5
6
7
8
9
10
11
12
13
14defuse_logging(func):
defwrapper(*args,**kwargs):
logging.warn("%s is running"%func.__name__)
returnfunc(*args)
returnwrapper
@use_logging# 語法糖,等價于:bar=use_logging(bar)
deffoo():
print('i am foo')
@use_logging
defbar():
print('i am bar')
bar()
如上所示，直接調用bar()就可以獲得結果。如果有其他類似函數，也可以繼續調用裝飾函數，而不用重復修改或增加新的封裝。
裝飾器在Python使用如此方便都要歸因于Python函數能像普通的對象（Python中一切皆對象）一樣作為參數傳遞給其他函數，可以被賦值給其他變量，可以作為返回值，可以定義在另一個函數內。
帶參數的裝飾器
在上述的的裝飾器調用中，@use_logging該裝飾器唯一的參數就是執行業務的函數，而裝飾器的語法允許我們在調用時，提供其他參數，比如:@decorator(a)，這樣，就為裝飾器的編寫和使用提供了更大的靈活性。1
2
3
4
5
6
7
8
9
10
11
12
13
14defuse_logging(level):
defdecorator(func):
defwrapper(*args,**kwargs):
iflevel=="warn":
logging.warn("%s is running"%func.__name__)
returnfunc(*args)
returnwrapper
returndecorator
@use_logging(level="warn")
deffoo(name='foo')
print("i am %s"%name)
foo()
上述的use_logging是允許帶參數的裝飾器，是對原有裝飾器的一次函數封裝，并返回一個裝飾器。我們可以將它理解為一個含有參數的閉包，當我們調研這個語法糖的時候，Python會發現這一層的封裝，并將參數傳遞到裝飾器的環境中。
總結：無參的裝飾器參數是要裝飾的函數；有參裝飾器參數是函數的參數，最后返回的是內部函數。
類裝飾器
相比函數裝飾器，類裝飾器具有高內聚、靈活性大、高封裝等優點。使用類裝飾器還可以依靠類內部的__call__方法，當使用@將裝飾器附加到函數上時 ，就會調用此方法。1
2
3
4
5
6
7
8
9
10
11
12
13classfoo(object):
def__init__(self,func):
self._func=func
def__call__(self):
print('class decorator running')
self._func()
print('class decorator ending')
@foo
defbar():
print('i am bar')
bar()
使用類裝飾器極大地復用了代碼，但是它也存在缺陷：原函數的元信息不見了，比如函數的docstring、__name__、參數列表，我們先寫一個裝飾器：1
2
3
4
5deflogged(func):
defwith_logging(*args,**kwargs):
printfunc.__name__+"was called"
returnfunc(*args,**kwargs)
returnwith_logging
定義一個函數來調用該裝飾器：1
2
3
4@logged
deff(x):
"""does some math"""
returnx+x*x
上述函數完全等價于：1
2
3
4deff(x):
"""does some math"""
returnx+x*x
f=logged(f)
可以看出，函數f被with_logging取代了，因此它的docstring、__name__也就變成了with_logging函數的信息了：1
2printf.__name__# print 'with_logging'
printf.__doc__# print None
好在我們有functools.wraps（Python的一個模塊），wraps本身就是一個裝飾器，它能把原函數的元信息拷貝到裝飾器函數中，使得裝飾器函數也有和原函數一樣的元信息。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15# 導入functools模塊中的wraps裝飾器
fromfunctoolsimportwraps
deflogged(func):
@wraps(func)
defwith_logging(*args,**kwagrs):
printfunc.__name__+"was called"
returnfunc(*args,**kwargs)
returnwith_logging
@logged
deff(x):
"""does some math"""
returnx+x*x
printf.__name__# print 'f'
printf.__doc__# print 'does some math'
內置裝飾器
在Python中有三個內置的裝飾器，都與class相關：
1）staticmethod：類靜態方法，其根跟成員方法的區別是沒有self參數，并且可以在類不進行實例化的情況下調用。
2）classmethod：與成員方法的區別在于所接收的第一個參數不是self（類實例的指針），而是cls（當前類的具體類型）。
3）property：屬性的意思，表示可以通過類實例直接訪問的信息。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15classTest(object):
def__init__(self,name):
self._name=name
@staticmethod
defnewTest1(name):
returnTest(name)
@classmethod
defnewTest2(cls):
returnTest('')
@property
defname(self):
returnself._name
裝飾器的調用順序
裝飾器是可以疊加使用的，那么這就涉及到裝飾器的調用順序。對于Python中的“@”語法糖，裝飾器的調用順序與使用@語法糖的聲明順序相反。1
2
3
4
5
6
7
8
9# 裝飾器的聲明順序
@a
@b
@c
deff():
pass
# 等效于
f=a(b(c(f)))# 以c、b、a的順序調用
總結
以上是生活随笔為你收集整理的python装饰器函数执行后日志_python 装饰器理解的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 十、关于MySQL 标识列，你该了解这些
- 下一篇： python网络爬虫系列（十）——chr