詳解Django中六個(gè)常用的自定義裝飾器
裝飾器作用
decorator是當(dāng)今最流行的設(shè)計(jì)模式之一,很多使用它的人并不知道它是一種設(shè)計(jì)模式。這種模式有什么特別之處? 有興趣可以看看Python Wiki上例子,使用它可以很方便地修改對(duì)象行為,通過(guò)使用類似例中的接口將修改動(dòng)作封裝在裝飾對(duì)象中。
decorator 可以動(dòng)態(tài)地修改函數(shù)、方法或類的功能,而無(wú)需創(chuàng)建子類或修改類的源代碼。正因?yàn)槿绱?,裝飾器可以讓代碼將變得更干凈、更可讀、更可維護(hù)(這很重要!),并且減少了許多冗余但又不得不寫(xiě)的代碼,使我們可以使用單個(gè)方法向多個(gè)類添加功能。
對(duì)于裝飾器的重用性和易用性,Django里面的@login_required就是一個(gè)很好的例子。使用它只用一句代碼就可以檢查用戶是否通過(guò)身份驗(yàn)證,并將未登錄用戶重定向到登錄url。
該裝飾器的使用方法如下:
from django.contrib.auth.decorators import login_required @login_required(login_url='/accounts/login/') def my_view(request): ...
每次用戶試圖訪問(wèn) my_view
時(shí),都會(huì)進(jìn)入 login_required
中的代碼。
Django裝飾器
下面介紹一些個(gè)人認(rèn)為比較有用的,或者是之前使用過(guò)的具有積極效果的裝飾器。事先聲明,如要實(shí)現(xiàn)同樣的業(yè)務(wù)場(chǎng)景,并不是只有本文中的方法。Django可以實(shí)現(xiàn)各種各樣的裝飾器,這完全根據(jù)您的需要進(jìn)行定制。
Group Required
有時(shí)需要保護(hù)一些視圖,只允許某些用戶組訪問(wèn)。這時(shí)就可以使用下面的裝飾器來(lái)檢查用戶是否屬于該用戶組。
from django.contrib.auth.decorators import user_passes_test def group_required(*group_names): """Requires user membership in at least one of the groups passed in.""" def in_groups(u): if u.is_authenticated(): if bool(u.groups.filter(name__in=group_names)) | u.is_superuser: return True return False return user_passes_test(in_groups) # The way to use this decorator is: @group_required('admins', 'seller') def my_view(request, pk): ...
有關(guān)此裝飾器更多的介紹,可以參考這里。
Anonymous required
這個(gè)裝飾器是參考Django自帶的 login_required
裝飾器,但是功能是相反的情況,即用戶必須是未登錄的,否則用戶將被重定向到 settings.py
中定義的地址。當(dāng)我們想要已登錄的用戶不允許進(jìn)入某些視圖(比如登錄)時(shí),非常有用。
def anonymous_required(function=None, redirect_url=None): if not redirect_url: redirect_url = settings.LOGIN_REDIRECT_URL actual_decorator = user_passes_test( lambda u: u.is_anonymous(), login_url=redirect_url ) if function: return actual_decorator(function) return actual_decorator # The way to use this decorator is: @anonymous_required def my_view(request, pk): ...
有關(guān)此裝飾器更多的介紹,可以參考這里。
Superuser required
這個(gè)裝飾器和上面的 group_required
類似, 但是它只允許超級(jí)用戶才能訪問(wèn)視圖。
from django.core.exceptions import PermissionDenied def superuser_only(function): """Limit view to superusers only.""" def _inner(request, *args, **kwargs): if not request.user.is_superuser: raise PermissionDenied return function(request, *args, **kwargs) return _inner # The way to use this decorator is: @superuser_only def my_view(request): ...
有關(guān)此裝飾器更多的介紹,可以參考這里。
Ajax required
這個(gè)裝飾器用于檢查請(qǐng)求是否是AJAX請(qǐng)求,在使用jQuery等Javascript框架時(shí),這是一個(gè)非常有用的裝飾器,也是一種保護(hù)應(yīng)用程序的好方法。
from django.http import HttpResponseBadRequest def ajax_required(f): """ AJAX request required decorator use it in your views: @ajax_required def my_view(request): .... """ def wrap(request, *args, **kwargs): if not request.is_ajax(): return HttpResponseBadRequest() return f(request, *args, **kwargs) wrap.__doc__ = f.__doc__ wrap.__name__ = f.__name__ return wrap # The way to use this decorator is: @ajax_required def my_view(request): ...
有關(guān)此裝飾器更多的介紹,可以參考這里。
Time it
如果您需要改進(jìn)某個(gè)視圖的響應(yīng)時(shí)間,或者只想知道運(yùn)行需要多長(zhǎng)時(shí)間,那么這個(gè)裝飾器非常有用。
def timeit(method): def timed(*args, **kw): ts = time.time() result = method(*args, **kw) te = time.time() print('%r (%r, %r) %2.2f sec' % (method.__name__, args, kw, te - ts)) return result return timed # The way to use this decorator is: @timeit def my_view(request): ...
有關(guān)此裝飾器更多的介紹,可以參考這里。
自定義功能
下面這個(gè)裝飾器只是一個(gè)示例,測(cè)試你能夠輕松地檢查某些權(quán)限或某些判斷條件,并100%自己定制。
想象你有一個(gè)博客、購(gòu)物論壇,如果用戶需要有很多積分才能發(fā)表評(píng)論,這是一個(gè)避免垃圾信息的好方法。下面創(chuàng)建一個(gè)裝飾器來(lái)檢查用戶是否已登錄并擁有超過(guò)10個(gè)積分,這樣才可以發(fā)表評(píng)論,否則將拋出一個(gè)Forbidden。
from django.http import HttpResponseForbidden logger = logging.getLogger(__name__) def user_can_write_a_review(func): """View decorator that checks a user is allowed to write a review, in negative case the decorator return Forbidden""" @functools.wraps(func) def wrapper(request, *args, **kwargs): if request.user.is_authenticated() and request.user.points < 10: logger.warning('The {} user has tried to write a review, but does not have enough points to do so'.format( request.user.pk)) return HttpResponseForbidden() return func(request, *args, **kwargs) return wrapper
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
python函數(shù)enumerate,operator和Counter使用技巧實(shí)例小結(jié)
這篇文章主要介紹了python函數(shù)enumerate,operator和Counter使用技巧,結(jié)合實(shí)例形式總結(jié)分析了python內(nèi)置函數(shù)enumerate,operator和Counter基本功能、原理、用法及操作注意事項(xiàng),需要的朋友可以參考下2020-02-02在Python中封裝GObject模塊進(jìn)行圖形化程序編程的教程
這篇文章主要介紹了在Python中封裝GObject模塊進(jìn)行圖形化程序編程的教程,本文來(lái)自于IBM官方網(wǎng)站技術(shù)文檔,需要的朋友可以參考下2015-04-04python使用range函數(shù)計(jì)算一組數(shù)和的方法
這篇文章主要介紹了python使用range函數(shù)計(jì)算一組數(shù)和的方法,涉及Python中range函數(shù)的使用技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-05-05Python中應(yīng)該使用%還是format來(lái)格式化字符串
這篇文章主要介紹了Python中應(yīng)該使用%還是format來(lái)格式化字符串的相關(guān)知識(shí),非常不錯(cuò),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2018-09-09Python文件右鍵找不到IDLE打開(kāi)項(xiàng)解決辦法
這篇文章主要介紹了Python文件右鍵找不到IDLE打開(kāi)項(xiàng)解決辦法,本文使用注冊(cè)表解決了這個(gè)問(wèn)題,需要的朋友可以參考下2015-06-06