## 裝飾器的作用

decorator 是當今最流行的設計模式之一，很多使用它的人並不知道它是一種設計模式。這種模式有什麼特別之處？使用它可以很方便的修改物件行為，透過使用類似例中的介面將修改動作封裝在裝飾器物件中。

decorator可以動態地修改函式、方法或類的功能，而無需建立子類或修改類的原始碼。正因為如此，裝飾器可以讓程式碼將變得 更乾淨 、 更可讀 、 更可維護 (這很重要!)，並且減少了許多冗餘但又不得不寫的程式碼，使我們可以使用單個方法向多個類新增功能。

對於裝飾器的重用性和易用性，Django裡面的 @login_required 就是一個很好的例子。使用它只用一句程式碼就可以檢查使用者是否透過身份驗證，並將未登入使用者重定向到登入url。

該裝飾器的使用方法如下:

from django.contrib.auth.decorators import login_required
	 
	@login_required(login_url='/accounts/login/')
	def my_view(request):
		...

每次使用者試圖訪問 my_view 時，都會進入 login_required 中的程式碼。

### Django裝飾器

下面介紹一些個人認為比較有用的，或者是之前使用過的具有積極效果的裝飾器。事先宣告，如要實現同樣的業務場景，並不是只有本文中的方法。Django可以實現各種各樣的裝飾器，這完全根據您的需要進行定製。

#### Group Required

有時需要保護一些檢視，只允許某些使用者組訪問。這時就可以使用下面的裝飾器來檢查使用者是否屬於該使用者組。

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):
	    ...

#### Anonymous required

這個裝飾器是參考Django自帶的 login_required 裝飾器，但是功能是相反的情況，即使用者必須是未登入的，否則使用者將被重定向到 settings.py 中定義的地址。當我們想要已登入的使用者不允許進入某些檢視(比如登入)時，非常有用。

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):
	    ...

#### Superuser required

這個裝飾器和上面的 group_required 類似， 但是它只允許超級使用者才能訪問檢視。

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):
		...

#### Ajax required

這個裝飾器用於檢查請求是否是AJAX請求，在使用jQuery等Javascript框架時，這是一個非常有用的裝飾器，也是一種保護應用程式的好方法。

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):
	    ...

#### Time it

如果您需要改進某個檢視的響應時間，或者只想知道執行需要多長時間，那麼這個裝飾器非常有用。

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):
	    ...

#### 自定義功能

下面這個裝飾器只是一個示例，測試你能夠輕鬆地檢查某些許可權或某些判斷條件，並100%自己定製。

想象你有一個部落格、購物論壇，如果使用者需要有很多積分才能發表評論，這是一個避免垃圾資訊的好方法。下面建立一個裝飾器來檢查使用者是否已登入並擁有超過10個積分，這樣才可以發表評論，否則將丟擲一個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

Django 常用的自定義裝飾器

相關文章