Djangoでよく使われる6つのカスタムデコレータ

デコレータの役割

デコレータは現在最も人気のあるデザインパターンの1つであり、多くの利用者はそれがデザインパターンの一種であることを知りません。このパターンには何が特別なのでしょうか？興味がある場合はPython Wikiの例を見てみてください。デコレータを使用すると、オブジェクトの動作を簡単に変更できます。例に示されているようなインターフェースを使用して、変更アクションをデコレータオブジェクトにカプセル化できます。

デコレータは関数、メソッド、またはクラスの機能を動的に変更できます。これにより、サブクラスを作成したり、クラスのソースコードを変更したりする必要がなくなります。このため、デコレータはコードをよりクリーンで、より読みやすく、より保守しやすく（これは重要です！）にし、多くの冗長ですが書かざるを得ないコードを削減し、単一のメソッドを使用して複数のクラスに機能を追加できるようにします。

デコレータの再利用性と使いやすさについては、Djangoの@login_requiredが良い例です。これを使用すると、ユーザーが認証されているかどうかを1行のコードで確認し、ログインしていないユーザーをログイン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では様々なデコレータを実装できますので、皆様のニーズに応じてカスタマイズしてください。

グループ必須

時には、いくつかのビューを保護して、特定のユーザーグループのみがアクセスできるようにする必要があります。このような場合、次のデコレータを使用してユーザーがそのグループに属しているかどうかを確認できます。

from django.contrib.auth.decorators import user_passes_test

def group_required(*group_names):
   """渡されたグループの少なくとも1つにユーザーが所属している必要があります。"""

   def in_groups(u):
       if u.is_authenticated():
           if bool(u.groups.filter(name__in=group_names)) or u.is_superuser:
               return True
       return False
   return user_passes_test(in_groups)

# このデコレータの使用方法：
@group_required('admins', 'seller')
def my_view(request, pk):
    ...

匿名ユーザー必須

このデコレータはDjangoの組み込み`login_required`デコレータを参考にしていますが、機能は逆の状況です。つまり、ユーザーはログインしていない必要があり、そうでない場合はユーザーは`settings.py`で定義されたアドレスにリダイレクトされます。ログインしたユーザーが特定のビュー（ログインなど）に入れないようにしたい場合に非常に役立ちます。

import settings
from django.contrib.auth.decorators import user_passes_test

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

# このデコレータの使用方法：
@anonymous_required
def my_view(request, pk):
    ...

スーパーユーザー必須

このデコレータは上記の`group_required`と似ていますが、ビューにアクセスできるのはスーパーユーザーのみです。

from django.core.exceptions import PermissionDenied

def superuser_only(view_func):
    """ビューをスーパーユーザーのみに制限します。"""

    def wrapper(request, *args, **kwargs):
        if not request.user.is_superuser:
            raise PermissionDenied("スーパーユーザーのみアクセス可能です")
        return view_func(request, *args, **kwargs)

    return wrapper

# このデコレータの使用方法：
@superuser_only
def my_view(request):
    ...

AJAX必須

このデコレータはリクエストがAJAXリクエストかどうかを確認するために使用されます。jQueryなどのJavaScriptフレームワークを使用する場合、これは非常に役立つデコレータであり、アプリケーションを保護する良い方法でもあります。

from django.http import HttpResponseBadRequest

def ajax_required(view_func):
    """
    AJAXリクエストが必要なデコレータ
    ビューで使用します：
 
    @ajax_required
    def my_view(request):
        ....
 
    """

    def wrapper(request, *args, **kwargs):
        if not request.is_ajax():
            return HttpResponseBadRequest("AJAXリクエストのみ許可されています")
        return view_func(request, *args, **kwargs)

    wrapper.__doc__ = view_func.__doc__
    wrapper.__name__ = view_func.__name__
    return wrapper

# このデコレータの使用方法：
@ajax_required
def my_view(request):
    ...

実行時間計測

ビューの応答時間を改善する必要がある場合、または実行にどれくらい時間がかかるかを知りたい場合、このデコレータは非常に役立ちます。

import time

def timeit(view_func):

   def timed(*args, **kw):
       start_time = time.time()
       result = view_func(*args, **kw)
       end_time = time.time()
       print('%r (%r, %r) %2.2f sec' % (view_func.__name__, args, kw, end_time - start_time))
       return result

   return timed

# このデコレータの使用方法：
@timeit
def my_view(request):
    ...

カスタム機能

以下のデコレータは単なる例です。特定の権限や条件を確認し、完全にカスタマイズできるかテストするために作成しました。ブログやショッピングフォーラムがあると想像してください。ユーザーがコメントを投稿するには多くのポイントが必要な場合、これはスパムを防ぐ良い方法です。ユーザーがログインしていて10ポイント以上ある場合にのみコメントを投稿できるようにするデコレータを作成し、そうでない場合はForbiddenを返します。

import logging
from django.http import HttpResponseForbidden

logger = logging.getLogger(__name__)

def check_user_points(view_func):
   """ユーザーがレビューを書く権限があるかどうかを確認するビューデコレータ。権限がない場合はForbiddenを返します"""

   @functools.wraps(view_func)
   def wrapper(request, *args, **kwargs):
       if request.user.is_authenticated and request.user.points < 10:
           logger.warning('ユーザーID {} がレビューを書こうとしましたが、十分なポイントがありません'.format(request.user.pk))
           return HttpResponseForbidden("十分なポイントがありません")

       return view_func(request, *args, **kwargs)

   return wrapper