526互联

drf——序列化组件的基本使用

发布时间 2023-11-20 21:02:58作者: wellplayed

一、准备工作

首先需要一张数据库表（以Book表为例）

在models内书写：

class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.BigIntegerField()

 

url：

path('books/', views.BookView.as_view()),
path('books/<int:pk>/', views.BookDetailView.as_view()),

 

二、书写序列化类（需要序列化的内容）

1.创建serializer.py文件

2.导入模块

from rest_framework import serializers

from rest_framework.exceptions import ValidationError
from .models import *

 

3.书写序列化类

class BookSerializer(serializers.Serializer):
    id = serializers.IntegerField(required=False)  # 可以不输入
    name = serializers.CharField(max_length=8)
    price = serializers.IntegerField()

 

三、反序列化的校验（三层校验）

第一层校验：书写字段参数（在 二.3 中新增校验条件 ）

id = serializers.IntegerField(required=False)
name = serializers.CharField(allow_blank=True, required=False, max_length=8,
                                 min_length=3, error_messages={'max_length': '太长了'})
price = serializers.IntegerField(max_value=100, min_value=10, error_messages={'max_value': '必须小于100'})

 

第二层校验：局部钩子

方法名必须是： validate_字段名

def validate_name(self, name):
        if 'sb' in name:
            # 不合法，抛异常
            raise ValidationError('书名中不能包含sb')
        else:
            return name


 def validate_price(self, item):
        if item == 88:
            raise ValidationError('价格不能等于88')
        else:
            return item

 

第三层校验：全局钩子

方法名必须是：validate

def validate(self, attrs):
        price = attrs.get('price')
        name = attrs.get('name')
        if name == price:
            raise ValidationError('价格不能等于书名')
        else:
            return attrs

 

只有三层都通过，在视图类中书写：

ser.is_valid():  # 是True，才能保存

 

四、反序列化的保存

新增接口

实例化的时候在视图层书写：

ser = BookSerializer(data=request.data)

 

新增接口 create方法：

def create(self, validated_data):
        book=Book.objects.create(**validated_data)
        return book

 

修改接口

实例化的时候在视图层书写：

ser = BookSerializer(instance=book,data=request.data)

 

修改接口 update方法：

def update(self, book, validated_data):
        for item in validated_data:  # {"name":"xxx","price":xx}
            setattr(book, item, validated_data[item])

        book.save()
        return book

 

五：具体代码如下

路由(urls)

urlpatterns = [
    path('books/', views.BookView.as_view()),
    path('books/<int:pk>/', views.BookDetailView.as_view()),
]

 

视图(views)

from .models import Book
from .serializer import BookSerializer


class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 使用序列化类，完成序列化  两个很重要参数： instance实例，对象      data：数据
        # 如果是多条many=True  如果是queryset对象，就要写
        # 如果是单个对象 many=False，默认是False
        serializer = BookSerializer(instance=book_list, many=True)
        # serializer.data  # 把qs对象，转成列表套字典  ReturnList
        # print(serializer.data)
        # print(type(serializer.data))
        # return Response(serializer.data)
        return Response({'code': 100, 'msg': '成功', 'data': serializer.data})

    # 新增
    def post(self, request):
        # 前端会传入数据，request.data--->把这个数据保存到数据库中
        # 借助于序列化类，完成 校验和反序列化
        # data 前端传入的数据 {"name":"三国演义","price":88}
        ser = BookSerializer(data=request.data)
        # 校验数据
        if ser.is_valid():  # 三层：字段自己的校验，局部钩子校验，全局钩子校验
            # 校验通过，保存
            print(ser.validated_data)  # validated_data：校验过后的数据
            # 如果没有save，如何保存，自己做
            # Book.objects.create(**ser.validated_data)
            ser.save()  # 会保存，但是会报错,因为它不知道你要保存到那个表中
            return Response({'code': 100, 'msg': '新增成功'})
        else:
            print(ser.errors)  # 校验失败的错误
            return Response({'code': 101, 'msg': '新增失败', 'errors': ser.errors})


class BookDetailView(APIView):
    def get(self, request, pk):
        book = Book.objects.all().get(pk=pk)
        serializer = BookSerializer(instance=book)
        return Response({'code': 100, 'msg': '成功', 'data': serializer.data})

    def put(self, request, pk):
        book = Book.objects.get(pk=pk)
        ser = BookSerializer(instance=book, data=request.data)
        if ser.is_valid():
            ser.save() # 也会报错，重写update
            return Response({'code': 100, 'msg': '修改成功'})
        else:
            return Response({'code': 101, 'msg': '修改失败', 'errors': ser.errors})

 

序列化类(serializer)

# from rest_framework.serializers import Serializer
from rest_framework import serializers

from rest_framework.exceptions import ValidationError
from .models import Book


class BookSerializer(serializers.Serializer):
    # 要序列化的字段
    id = serializers.IntegerField(required=False)  # 前端传入数据，可以不填这个字段
    name = serializers.CharField(allow_blank=True, required=False, max_length=8,
                                 min_length=3, error_messages={'max_length': '太长了'})  # allow_blank: 这个字段传了，value值可以为空
    price = serializers.IntegerField(max_value=100, min_value=10, error_messages={'max_value': '必须小于100'})

    # price = serializers.CharField()

    # 局部钩子：给某个字段做个校验
    # 书名中不能包含sb
    # validate_字段名
    def validate_name(self, name):
        if 'sb' in name:
            # 不合法，抛异常
            raise ValidationError('书名中不能包含sb')
        else:
            return name

    def validate_price(self, item):
        if item == 88:
            raise ValidationError('价格不能等于88')
        else:
            return item

    # 全局钩子
    # 价格和书名不能一样  validate
    def validate(self, attrs):
        price = attrs.get('price')
        name = attrs.get('name')
        if name == price:
            raise ValidationError('价格不能等于书名')
        else:
            return attrs

    def create(self, validated_data):
        # validated_data校验过后的数据，字典
        book = Book.objects.create(**validated_data)
        return book

    # def update(self, book, validated_data):
    #     # instance 要修改的对象
    #     # validated_data：前端传入，并且校验过后的数据
    #     book.name = validated_data.get('name')
    #     book.price = validated_data.get('price')
    #     # 一定不要忘了
    #     book.save()
    #     return book
    def update(self, book, validated_data):

        for item in validated_data:  # {"name":"jinping","price":55}
            setattr(book, item, validated_data[item])
            # 等同于下面
            # setattr(book,'name','jinping')
            # setattr(book,'price',55)
            # 等同于
            #     book.name = validated_data.get('name')
            #     book.price = validated_data.get('price')
        book.save()
        return book

 

模型层(models)

from django.db import models


class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.BigIntegerField()