Django Rest framework（drf）数据校验

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

前言

Django Rest framework（drf）数据校验

提示：以下是本篇文章正文内容，下面案例可供参考

一、目的

实现对上传数据的数据校验，前提是上传数据为excel表格格式。本文举例两种常见的数据校验需求：一是某一字段值的唯一性；二是某一字段值满足指定范围。
基于drf的数据校验，一般在serializers.py实现数据校验逻辑，在views.py实现导入数据、输出提示。

二、示例

1.唯一性校验–serializers.py

代码如下：

from rest_framework import serializers
from .models import Demand  # 修改为自己的模型
from rest_framework.validators import UniqueValidator

class DemandSerializers(serializers.ModelSerializer):
    class Meta:
        model = Demand
        fields = '__all__'
        extra_kwargs = {
            'name': {'validators': [UniqueValidator(queryset=model.objects.all(), message='Demand name is not unique')]}       
        }

fields 指明序列化需要的字段，all 表示所有字段。
extra_kwargs 表示除了模型定义时字段需要满足的条件之外，还需要满足的条件。
UniqueValidator 检验唯一性，给出错误提示。

2.满足指定范围–serializers.py

代码如下：

from rest_framework import serializers
from .models import Demand  # 修改为自己的模型
from rest_framework.validators import UniqueValidator
from rest_framework import validators


def is_status(value):
    if value not in ['已完成', '等待中', '未完成', '讨论中', '已结束']:
        raise serializers.ValidationError('"状态" 字段值必须是 "已完成", "等待中", "未完成", "讨论中" 或 "已结束" 中的一个')


class DemandSerializers(serializers.ModelSerializer):

    class Meta:
        model = Demand
        fields = '__all__'
        extra_kwargs = {          
            'status': {'validators': [is_status]}
        }

3.导入数据–views.py

导入数据，数据校验，若数据非法，则给出提示，否则存入数据库

代码如下：

from rest_framework.viewsets import ModelViewSet
from .serializers import DemandSerializers
from .models import Demand  # 修改为自己的模型
from .filter import DemandModuleFilter  # 修改为自己的序列化器
from rest_framework import status
from rest_framework.parsers import MultiPartParser, FormParser
from rest_framework.response import Response
from rest_framework.views import APIView
from openpyxl import load_workbook
from drf_yasg import openapi
from django.http import FileResponse


class UploadExcelView(APIView):
    parser_classes = (MultiPartParser, FormParser)
    def post(self, request, *args, **kwargs):
        file = request.FILES.get('file')
        if file is None:
            return Response({'message': 'No file uploaded'}, status=status.HTTP_400_BAD_REQUEST)

        wb = load_workbook(file)
        sheet = wb.active
        rows = list(sheet.iter_rows(values_only=True))
        rows.pop(0)
        titles = [title for title in rows]
        
        for row in rows:
            row_data = [cell for cell in row]
            data = dict(zip(titles, row_data))
            serializer = DemandSerializers(data=data)
            if not serializer.is_valid():  # 数据校验
            	# 校验不通过则给出提示，并报错
                return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
        
        # 校验通过，则保存数据        
        for row in rows:
            row_data = [cell for cell in row]
            data = dict(zip(titles, row_data))

            serializer = DemandSerializers(data=data)
            if serializer.is_valid():
                serializer.save()
        return Response({'message': 'Excel data imported successfully'}, status=status.HTTP_201_CREATED)

总结

drf + excel数据上传 + serializers数据校验