【Django】デコレータ(Decorator)の自作と使い方

djangoのデコレータ(Decorator)関数は便利ですね。

viewsで定義した関数の一行上で「@」のように表示されるアレです。

本日は実例を基に、実際のコードを書いてdjangoのデコレータ(Decorator)を紹介していきます。

コンテンツ

環境

・python 3.8

・django 2.2

作成しようと思った理由

そもそもどのような時に、djangoのデコレータ関数をしょうしたくなるかというと、「毎回同じように書いている関数を一つにまとめて必要な時だけ取り出して使用したい。」というところからです。

つまりオブジェクト思考です。

今回の例では、djangoでログインフォームを作成した後に、非ログイン状態のユーザーにはログインフォームに飛ばすのではなく403でアクセスさせない画面を作成したいと想定しました。

毎回非ログイン状態のユーザーを403に表示させるコードを書くのは大変ですよね。

例にあげてみます。

views.py

from django.core.exceptions import PermissionDenied

def profile(request):
    """プロフィールページ
    """
    if not request.user.is_authenticated:
        raise PermissionDenied
    return (render, 'profile.html')

from django.core.exceptions import PermissionDenied

def profile(request):

"""プロフィールページ

"""

if not request.user.is_authenticated:

raise PermissionDenied

return (render, 'profile.html')

プロフィールページになりますが、プロフィールページはログイン中のユーザー以外の非ログインユーザーがアクセスしようとしたら403エラーを排出させて閲覧禁止にしたいですよね。

※ちなみに403エラーとは下記参照

【403エラー】そのページは存在するけど、特定のアクセス者にページを表示する権限が付与されず、アクセスが拒否されたことを示すもの。
https://ja.wikipedia.org/wiki/HTTP_403

このプロフィール以外にもログイン後のページには多くの閲覧禁止エリアを作成したので、毎回各ページ毎に以下のコードを設置するのはめちゃくちゃ面倒くさいわけですし、これこそオブジェクト思考に反するコードになるわけです。

if not request.user.is_authenticated:
    raise PermissionDenied

1 2	if not request.user.is_authenticated: raise PermissionDenied

デコレータとは

デコレータは早い話がpythonの関数です。

条件さえ整っていればいつでもどこでも呼び出して検証できる関数を指し、django内で自作ができます。

デコレータの自作手順

それでは早速作成していきます。

とりあえず同じファイルページに作成することにします。

作成したのが以下になります。

views.py

from django.core.exceptions import PermissionDenied

def permission(func):
    """非ログイン状態でアクセスしたら404を排出
    """
    def checker(request, *args, **kwargs):
        func(request)
        if request.user.is_authenticated:
            return func(request, *args, **kwargs)
        else:
            raise PermissionDenied
    return checker


@permission
def profile(request):
    """プロフィール
    """
    return render(request, 'profile.html')

from django.core.exceptions import PermissionDenied

def permission(func):

"""非ログイン状態でアクセスしたら404を排出

"""

def checker(request, *args, **kwargs):

func(request)

if request.user.is_authenticated:

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

else:

raise PermissionDenied

return checker

@permission

def profile(request):

"""プロフィール

"""

return render(request, 'profile.html')

使い方を説明します。

何者かがprofile.htmlにアクセスしたとき、まず15行目の@permissionで3行目のpermission関数が呼び出されます。
6行目でcheckerという関数名を命名し、引数としてrequest, *args, **kwargsを書いておきます。*args,**kwargsの説明に関してはこちらから。よくわからないよ!!って人はおまじないとして書いておきましょう。
8行目は、もしユーザーがログイン状態の場合は9行目のreturnでfuncを返しています。
10行目は、もしユーザーが非ログイン状態の場合は、11行目で強制的に403画面を排出します。このPermissionDeniedは1行目から呼び出しています。