【API】DRFのアプロダ作成　その③バリデーション【Django】

作業の流れ

mac側

１.VSCODEを起動します。

サンドボックス（Vagrant側）

１.vagrantを起動して、Amazon Linux2にログインします。

２.Djnangoプロジェクトを作成したディレクトリへ移動します。

※今回の記事は、既にAmazonLinux２のVagrant環境を作成済みであるとします。

AmazonLinux2仮想環境へログイン

①「ターミナル」を開いて下記のコマンドを入力します。

cd ~/Work/Vagrant/AmazonLinux2

②下記のコマンドを入力して仮想環境を起動します。

Vagrant up

③下記のコマンドを入力してログインします。

vagrant ssh

シリアライザにバリデーション追加

①以下のようなDjangoアプリ構成を作ります。プロジェクト名が「config」で、アプリケーション名が「nuploader1」です。プロジェクトの設定は済ませたものとします。赤字のファイルは、今回変更する部分です。

②nuploader1/serializers.pyに以下の内容を記述します。チェックを書く場所は幾つかありますが、シリアライザーのvalidateメソッドに書いていきます。

from django.core.exceptions import ObjectDoesNotExist
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from .models import Composite

class CompositeSerializer(serializers.ModelSerializer):
  parent = SimpleCompositeRelation(queryset=Composite.objects.filter(is_dir=True), required=False, allow_null=True)
  composite_set = SimpleCompositeSerializer(many=True, read_only=True)

  class Meta:
    model = Composite
    fields = ('pk', 'name', 'is_dir', 'src', 'parent', 'zip_depth', 'composite_set')

    def validate(self, attrs):
      parent = attrs['parent']
      name = attrs['name']
      is_dir = attrs['is_dir']

      if (self.instance and parent) and (parent.pk == self.instance.pk):
        raise serializers.ValidationError('親ディレクトリが自分です')

        # 同名ファイル・ディレクトリがないかチェック
        same_names = Composite.objects.filter(parent=parent, name=name)
    
      if self.instance:  # 更新の場合は、自分が同名ファイルとして出てくるので、それは除く
        same_names = same_names.exclude(pk=self.instance.pk)
      if same_names.exists():
        raise serializers.ValidationError('同じ名前のファイル・ディレクトリが既に存在します')

      # ファイルの送信処理があった
      if 'src' in attrs:
        src = attrs['src']
        # 送られたファイルの中身があり、ディレクトリ指定
        if is_dir and src:
          raise serializers.ValidationError('ディレクトリの時は、ファイルを添付しないでください')

      # ファイルフラグだが、ファイルの中身は空
      if not is_dir and not src:
       raise serializers.ValidationError('ファイルの時は、ファイルを添付してください')

        # ファイルの送信はなかった
      else:
        if not self.instance:
          # ファイルの送信はなかったのに、ファイルフラグ
          if not is_dir:
            raise serializers.ValidationError('ファイルの時は、ファイルを添付してください')
        else:
          src = self.instance.src
          # ファイルの送信はなかったし、アップロード済みでもないのにファイルフラグ
          if not is_dir and not src:
            raise serializers.ValidationError('ファイルの時は、ファイルを添付してください')
        
      return attrs

こういったバリデーションはフロントエンド側でもある程度はできますが、サーバー側でもチェックは必須です。

    def validate(self, attrs):
        parent = attrs['parent']
        name = attrs['name']
        is_dir = attrs['is_dir']

      if (self.instance and parent) and (parent.pk == self.instance.pk):
        raise serializers.ValidationError('親ディレクトリが自分です')

③SimpleCompositeRelationにも処理を追加します。

from django.core.exceptions import ObjectDoesNotExist
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from .models import Composite

class CompositeSerializer(serializers.ModelSerializer):
～（省略）～

class SimpleCompositeRelation(serializers.RelatedField):
    default_error_messages = {
        'does_not_exist': _('Invalid pk "{pk_value}" - object does not exist.'),
        'incorrect_type': _('Incorrect type. Expected pk value, received {data_type}.'),
    }

    def to_representation(self, value):
        return SimpleCompositeSerializer(value).data

    def to_internal_value(self, data):
        try:
            return self.get_queryset().get(pk=data)
        except ObjectDoesNotExist:
            self.fail('does_not_exist', pk_value=data)
        except (TypeError, ValueError):
            self.fail('incorrect_type', data_type=type(data).__name__)

    def get_choices(self, cutoff=None):
        queryset = self.get_queryset()
        if queryset is None:
            return {}

        if cutoff is not None:
            queryset = queryset[:cutoff]

        # https://github.com/encode/django-rest-framework/issues/5141
        return dict([
            (
                item.pk,
                self.display_value(item)
            )
            for item in queryset
        ])

ホームのファイル・ディレクトリ一覧

あるCompositeに紐づくCompositeの一覧は取得できています。しかし、何処にも紐づかないComposite、parentがNoneなComposite…最上位にあるファイル・ディレクトリの一覧が取得できません。

①今あるビュの一覧処理を上書きします。nuploader1/views.pyに記述します。

from django.shortcuts import render  # render(request, 'hello.html', context)
from django.http import HttpResponse  # HttpResponse('Hello, World !!')
from django.shortcuts import render
from django.views import View
from .models import Composite
from .serializers import CompositeSerializer
from rest_framework import viewsets, permissions  # 追加

class CompositeViewSet(viewsets.ModelViewSet):
    queryset = Composite.objects.all()
    serializer_class = CompositeSerializer
    permission_classes = [permissions.IsAuthenticatedOrReadOnly]  # 追加

    def list(self, request, *args, **kwargs):
        queryset = Composite.objects.filter(parent__isnull=True)
        queryset = self.filter_queryset(queryset)
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)

        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

    def list(self, request, *args, **kwargs):
        queryset = Composite.objects.filter(parent__isnull=True)
        queryset = self.filter_queryset(queryset)
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)

        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)

ログイン必須にする

データの作成や更新、削除処理はログイン済でなければできないようにします。通常のDjangoでは、「django.contrib.auth.mixins.LoginRequired」といったMixinがありましたが、DRFでは以下のように書きます。

from django.shortcuts import render  # render(request, 'hello.html', context)
from django.http import HttpResponse  # HttpResponse('Hello, World !!')
from django.shortcuts import render
from django.views import View
from .models import Composite
from .serializers import CompositeSerializer
from rest_framework import viewsets, permissions  # 追加

class CompositeViewSet(viewsets.ModelViewSet):
    queryset = Composite.objects.all()
    serializer_class = CompositeSerializer
    permission_classes = [permissions.IsAuthenticatedOrReadOnly]  # 追加

〜（省略）〜

permissions.IsAuthenticatedOrReadOnlyは、読み取りは自由で、作成などの処理はログイン必須にします。

次回

フロントエンド（Vue.js）の準備をします。

→【AmazonLinux2】AmazonLinux2にNode.jsとVueをインストールする【Vue】