DRF学习——序列化（一）

目录

一、简介

二、Serializer

三、ModelSerializer

四、choices返回文本

五、ForeignKey以及ManyToManyField返回数据

---

一、简介

本篇文章主要通过案例的形式展示DRF中序列化器Serializer如何使用，并对其中涉及到的知识点进行简单的介绍

二、Serializer

首先介绍最基础的Serializer，它需要我们自己去构建需要序列化的关键字

例如，现在有一个部门model

# api/models.py
from django.db import models


class Depart(models.Model):
    """部门表"""
    title = models.CharField(verbose_name="标题", max_length=32)
    count = models.IntegerField(verbose_name="人数")

 该部门model存储以下数据

 现在写一个get方法去获取数据库中的title和count

# api/views.py
class DepartView(APIView):
    def get(self, request, *args, **kwargs):
        # 一个对象
        # depart_obj = models.Depart.objects.all().first()
        # 如果去掉first()，则返回的是一个queryset对象
        # 什么是queryset对象，简单理解为列表里面放对象[obj, obj, obj]
        queryset = models.Depart.objects.all()
        # 如果是普通对象则是many=False
        # ser = DepartSerializers(instance=queryset, many=False)
        # 如果是queryset对象，即列表里面装对象的情况，则需要many=True
        ser = DepartSerializers(instance=queryset, many=True)
        return Response(ser.data)

这里介绍一下queryset对象，当我们取的数据是 models.Depart.objects.all()时，此时所得到的便是queryset对象，可以理解为列表中放了许多对象，如[对象, 对象, 对象, 对象]，并且此时在序列化器中需要将many赋值为True，反之，如果所取数据是models.Depart.objects.all().first()即一个对象时，many赋值为Flase

上面这段代码用到了DepartSerializers，即这个部门model的序列化器，其代码如下：

# api/views.py
class DepartSerializers(serializers.Serializer):
    title = serializers.CharField()
    count = serializers.IntegerField()

 与定义部门model时很像，将我们所需要序列化的title和count分别进行了构建

最后需要定义一个url来调用当前的DepartView

from django.urls import path
from api import views

urlpatterns = [
    path('api/depart/<str:version>/', views.DepartView.as_view(), name="depart"),
]

 访问部门url，可正常访问

三、ModelSerializer

如果只是简单的使用Serializer，当我们某个model定义的关键字特别多时，Serializer使用起来就显得比较麻烦，因此DRF推荐我们使用ModelSerializer，Serializer和ModelSerializer的关系就如同Django中的Form和ModelForm类似，以下为DepartSerializers换为ModelSerializer的用法：

# api/views.py
class DepartSerializers(serializers.ModelSerializer):
    class Meta:
        model = models.Depart
        fields = "__all__"

 访问部门url，可正常访问

四、choices返回文本

在实际的开发当中，有时候我们会用到choices，即1代表某种意义，2代表另一种意义，例如现在增加一个用户model，将1代表男性，2代表女性，其定义如下：

# api/models.py
class User(models.Model):
    name = models.CharField(verbose_name="姓名", max_length=32)
    age = models.IntegerField(verbose_name="年龄")
    gender = models.SmallIntegerField(verbose_name="性别", choices=((1, "男"), (2, "女")))

其中用户的ModelSerializer定义如下：

class UserSerializers(serializers.ModelSerializer):
    class Meta:
        model = models.User
        fields = "__all__"

 访问用户url，可正常访问 

 不过此时后端数据的返回的gender为1，如果我们需要返回choices中的文本，此时就需要对UserSerializer进行完善，使用source="get_使用choices的关键字_display"

class UserSerializers(serializers.ModelSerializer):
    gender_text = serializers.CharField(source="get_gender_display")
    class Meta:
        model = models.User
        fields = "__all__"

访问用户url，这时可以看见返回了文本信息，性别为男

五、ForeignKey以及ManyToManyField返回数据

在实际的开发中，除了choices会经常用到，更加常用的便是ForeignKey和ManyToManyField此类的连表方式，如果当前的用户model和之前的部门model进行ForeignKey关联，并与一个新的标签model进行ManyToManyField关联，而且要求返回与之关联的数据，则需要我们接着完善UserSerializer

现在的用户model代码如下：

class User(models.Model):
    name = models.CharField(verbose_name="姓名", max_length=32)
    age = models.IntegerField(verbose_name="年龄")
    gender = models.SmallIntegerField(verbose_name="性别", choices=((1, "男"), (2, "女")))
    depart = models.ForeignKey(verbose_name="部门", to="Depart", on_delete=models.CASCADE)
    tags = models.ManyToManyField(verbose_name="标签", to="Tag")

 UserSerializer完善如下：

将depart和tags分别使用两个序列化组件进行数据返回

class UserSerializers(serializers.ModelSerializer):
    gender_text = serializers.CharField(source="get_gender_display")
    depart = UserDepartSerializers()
    tags = UserTagSerializers(many=True)

    class Meta:
        model = models.User
        # fields = "__all__"
        fields = ["name", "age", "gender_text", "depart", "tags"]

其中UserDepartSerializers定义为：

class UserDepartSerializers(serializers.ModelSerializer):
    class Meta:
        model = models.Depart
        fields = ["title"]

UserTagSerializers定义为：

class UserTagSerializers(serializers.ModelSerializer):
    class Meta:
        model = models.Tag
        fields = ["caption"]

访问用户url，这时可以看见返回了部门以及标签