如果想對(duì)一個(gè)視圖功能進(jìn)行擴(kuò)展, 就需要使用到裝飾器了, 但是如果通過(guò)普通的方法添加裝飾器卻不能得到想要的結(jié)果, 舉個(gè)例子
# decorator
def my_decorator(func):
def wrapper(self, request, *args, **kwargs):
print('自定義裝飾器被調(diào)用了')
print('請(qǐng)求路徑%s' % request.path)
return func(self, request, *args, **kwargs)
return wrapper
# view
class DemoView(View):
@my_decorator
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
但是運(yùn)行以后, 結(jié)果可能是這樣的
AttributeError: 'Demoview' object has no attribute 'path'
為什么會(huì)這樣能? 這個(gè)后面就會(huì)解釋. 所以說(shuō)通過(guò)普通的方法進(jìn)行裝飾時(shí)沒(méi)有辦法解決問(wèn)題,只能用其它的方法
第一種: 在定義的路徑當(dāng)中手動(dòng)添加裝飾行為
- urls.py
from .views import my_decortator
urlpatterns = [
url(r'^demo/$', my_decorate(DemoView.as_view())) # DemoView.as_view()的結(jié)果是view方法 --> my_decorate(view)
]
- views.py
def my_decorator(func):
def wrapper(request, *args, **kwargs):
print('自定義裝飾器被調(diào)用了')
print('請(qǐng)求路徑%s' % request.path)
return func(request, *args, **kwargs)
return wrapper
class DemoView(View):
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
這種方法的實(shí)現(xiàn)原理是在視圖的入口處添加裝飾器:
- 給
as_view()
的執(zhí)行結(jié)果加裝飾器, 由于as_view()
方法返回的是一個(gè)view函數(shù)
,在調(diào)用view函數(shù)
之前進(jìn)行裝飾, 就相當(dāng)于給每一個(gè)視圖添加了裝飾器, 因?yàn)樗且粋€(gè)視圖的入口, 所以每次進(jìn)入view函數(shù)
之前都會(huì)調(diào)用一次! - 需要注意的是這種方式是手動(dòng)的! 是根據(jù)裝飾器的原理去實(shí)現(xiàn)手動(dòng)裝飾, 所以有點(diǎn)難以讀懂
- 它的裝飾時(shí)對(duì)類(lèi)視圖里的所有方法, 不能進(jìn)行單一控制
- 裝飾的位置是在urls.py中
第二種: 在請(qǐng)求方法調(diào)用前添加裝飾器
- 為全部請(qǐng)求方法添加裝飾器
from django.utils.decorators import method_decorator
# 為全部請(qǐng)求方法添加裝飾器
class DemoView(View):
@method_decorator(my_decorator) # 通過(guò)給dispatch方法添加裝飾器實(shí)現(xiàn)
def dispatch(self, *args, **kwargs):
return super().dispatch(*args, **kwargs)
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
- 為特定請(qǐng)求方法添加裝飾器
class DemoView(View):
@method_decorator(my_decorator) # 為get方法添加
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
它的原理: 在進(jìn)入視圖之前添加裝飾器
- 全部請(qǐng)求: 在進(jìn)入dispatch方法之前
- 其實(shí)和第一種方法差不多, 因?yàn)橐彩侨肟谔幪砑友b飾器, 只是比第一種方法裝飾的時(shí)刻更晚, 是在view方法之后, 在調(diào)用dispatch方法之前添加裝飾器.
- 與第一種的區(qū)別在于, 它可以在view函數(shù)里修改, 而不用修改urls.
- 特定請(qǐng)求: 在特定視圖上用
@方法
- 注意: 必須要使用
method_decorator(my_decorator)
, 不能直接加my_decorator
method_decorator裝飾器還支持使用name參數(shù)指明被裝飾的方法
- 其實(shí)就是上面的簡(jiǎn)寫(xiě)
# 為全部請(qǐng)求方法添加裝飾器
@method_decorator(my_decorator, name='dispatch')
class DemoView(View):
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
# 為特定請(qǐng)求方法添加裝飾器
@method_decorator(my_decorator, name='get')
class DemoView(View):
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
為什么需要使用method_decorator???
首先來(lái)看一下裝飾器所接受的參數(shù)
def my_decorate(func):
def wrapper(request, *args, **kwargs): # 第一個(gè)參數(shù)request對(duì)象
...代碼省略...
return func(request, *args, **kwargs)
return wrapper
裝飾器需要的第一個(gè)參數(shù)是 request
對(duì)象, 但我們調(diào)用類(lèi)視圖中請(qǐng)求方法時(shí), 傳入的第一個(gè)參數(shù)不是request
對(duì)象,而是self 視圖對(duì)象本身焕参,第二個(gè)位置參數(shù)才是request
對(duì)象: self, request, *args, **kwargs
,
所以如果直接將用于函數(shù)視圖的裝飾器裝飾類(lèi)視圖方法油额,會(huì)導(dǎo)致參數(shù)傳遞出現(xiàn)問(wèn)題。
method_decorator的作用是為函數(shù)視圖裝飾器補(bǔ)充第一個(gè)self參數(shù)涩嚣,以適配類(lèi)視圖方法航厚。
def my_decorator(func):
def wrapper(self, request, *args, **kwargs): # 此處增加了self
print('自定義裝飾器被調(diào)用了')
print('請(qǐng)求路徑%s' % request.path)
return func(self, request, *args, **kwargs) # 此處增加了self
return wrapper
補(bǔ)充上self以后, 問(wèn)題完美解決!
第三種: 構(gòu)造Mixin擴(kuò)展類(lèi)
- 原理:重寫(xiě)
as_view()
方法, 在進(jìn)入返回view函數(shù)之前, 對(duì)view函數(shù)
進(jìn)行裝飾- 和第二種的差不多, 第二種是重寫(xiě)加擴(kuò)展
dispatch方法
- 第三種是重寫(xiě)加擴(kuò)展
as_view
方法
- 和第二種的差不多, 第二種是重寫(xiě)加擴(kuò)展
class MyDecoratorMixin(object):
@classmethod
def as_view(cls, *args, **kwargs):
view = super().as_view(*args, **kwargs) # 調(diào)用as_view(),返回view方法
view = my_decorator(view) # 對(duì)view方法進(jìn)行裝飾
return view # 返回這個(gè)裝飾過(guò)的view方法
class DemoView(MyDecoratorMixin, View): # 通過(guò)多繼承的原理, 視圖繼承重寫(xiě)后的as_view
def get(self, request):
print('get方法')
return HttpResponse('ok')
def post(self, request):
print('post方法')
return HttpResponse('ok')
總結(jié): 其實(shí)功能和第二種差不多, 那為什么還用第三種呢, 因?yàn)樗油ㄓ? 它最大的優(yōu)點(diǎn)是 能給 多個(gè)不同的類(lèi)視圖進(jìn)行裝飾, 它不局限于只能給某個(gè)單一的視圖添加!
而第一,二種都是給單一的類(lèi)視圖添加, 不具備通用性, 所以在開(kāi)發(fā)中第三種往往更加通用.
- 使用Mixin擴(kuò)展類(lèi)幔睬,也會(huì)為類(lèi)視圖的所有請(qǐng)求方法都添加裝飾行為芹扭。注意: 是類(lèi)視圖中的所有請(qǐng)求, 也就意味著它不能單一控制, 這也算是一個(gè)缺點(diǎn)吧