DRF之序列化器嵌套

文章介绍了在Django中使用序列化器嵌套的三种方法:直接声明模型、利用source选项和指定关联深度属性-depth。通过这些方法,可以在序列化学生信息时展示关联的成绩、课程和教师信息。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

序列化器嵌套共有三种声明方式,下面我会给大家逐一介绍,前提我已经建立好了学生、教师、课程、成绩四个表格,且已导入数据,模型如下:

models.py

from django.db import models
from django.utils import timezone as datatime

class Student(models.Model):
    name = models.CharField(max_length=50, verbose_name="姓名")
    age = models.IntegerField(verbose_name="年龄")
    sex = models.BooleanField(default=False)
    class Meta:
        db_table = 'sch_student'

    def __str__(self):
        return self.name

class Course(models.Model):
    name = models.CharField(max_length=50, verbose_name="课程名单")
    teacher = models.ForeignKey("Teacher", on_delete=models.DO_NOTHING, related_name="course",db_constraint=False)
    class Meta:
        db_table = "sch_course"

    def __str__(self):
        return self.name

class Teacher(models.Model):
    name = models.CharField(max_length=50, verbose_name="姓名")
    sex = models.BooleanField(default=False)
    class Meta:
        db_table = "sch_teacher"

    def __str__(self):
        return self.name

class Achievement(models.Model):
    score = models.DecimalField(default=0, max_digits=4, decimal_places=1, verbose_name="成绩")
    student = models.ForeignKey(Student,on_delete=models.DO_NOTHING, related_name='s_achievement', db_constraint=False)
    course = models.ForeignKey(Course,on_delete=models.DO_NOTHING, related_name='c_achievement', db_constraint=False)
    create_dtime = models.DateTimeField(auto_created=datatime.now)
    class Meta:
        db_table = "sch_achievement"

    def __str__(self):
        return str(self.score)

一、直接声明模型

我们要在学生信息界面展示出该学生的成绩,就需要关联到成绩外键,需要在学生的序列化器中调用成绩序列化器

class AchievementModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Achievement
        fields = "__all__"

class StudentModelSerializer(serializers.ModelSerializer):
    # 在序列化器中调用另一个序列化器,就是序列化器嵌套
    s_achievement = AchievementModelSerializer()
    class Meta:
        model = Student
        fields = ['id','name','s_achievement']

结果如图:

二、利用source选项取代主键数值

通过source直接通过外键返回特定字段值

class AchievementModelSerializer(serializers.ModelSerializer):
    # course = CourseModelSerializer()
    # 直接调用别的模型里的外键字段
    course_name = serializers.CharField(source="course.name")
    teacher_name = serializers.CharField(source="course.teacher.name")
    class Meta:
        model = Achievement
        fields = ['id','course_name','teacher_name','score','create_dtime']

class StudentModelSerializer(serializers.ModelSerializer):
    # 在序列化器中调用另一个序列化器,就是序列化器嵌套
    s_achievement = AchievementModelSerializer(many=True)
    class Meta:
        model = Student
        fields = ['id','name','s_achievement']

结果如图:

三、直接指定关联深度属性-depth函数

depth = 1情况:

class AchievementModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Achievement
        fields = ['id','course','score','create_dtime']
        depth = 1
        # 使用深度depth函数直接展示
        """
        从成绩模型-->课程 ------ depth = 1
        从成绩模型-->课程-->老师 ----- depth = 2
        """

class StudentModelSerializer(serializers.ModelSerializer):
    # 在序列化器中调用另一个序列化器,就是序列化器嵌套
    s_achievement = AchievementModelSerializer(many=True)
    class Meta:
        model = Student
        fields = ['id','name','s_achievement']

如图:

depth = 2情况:

四、直接在模型类里自定义

models.py

直接在模型中定义achievement

class Student(models.Model):
    name = models.CharField(max_length=50, verbose_name="姓名")
    age = models.IntegerField(verbose_name="年龄")
    sex = models.BooleanField(default=False)
    class Meta:
        db_table = 'sch_student'

    def __str__(self):
        return self.name

# 直接在模型中定义achievement
    def achievement(self):
        """成绩列表"""
        return self.s_achievement.values()

serializers.py

然后在序列化器中就可以直接添加该字段了

class StudentModelSerializer(serializers.ModelSerializer):
    # 在序列化器中调用另一个序列化器,就是序列化器嵌套
    # s_achievement = AchievementModelSerializer(many=True)
    class Meta:
        model = Student
        fields = ['id','name','achievement']

结果如图:

序列化器嵌套的方式大概就这么几种,希望本篇文章对你有所帮助

### Django REST Framework 中序列化器自动生成 Django REST Framework 提供了一种简便的方法来基于模型自动生成序列化器,即 `ModelSerializer` 类。这使得创建复杂的、与模型紧密关联的 API 变得更加容易。 通过继承 `rest_framework.serializers.ModelSerializer` 而不是直接使用 `serializers.Serializer`,可以减少大量样板代码。对于大多数场景来说,只需指定几个选项即可让 DRF 自动生成字段并实现基本的 CRUD 功能: ```python from rest_framework import serializers from myapp.models import MyModel class MyModelSerializer(serializers.ModelSerializer): class Meta: model = MyModel fields = '__all__' # 或者显式列出字段 ['id', 'name', ...] ``` 这种方式不仅简化了开发过程,还确保了当数据库模式发生变化时,API 表现能够同步更新而无需手动调整序列化逻辑[^1]。 此外,在涉及到外键关系的情况下,`ModelSerializer` 同样能处理得很好。例如,如果存在课程分类的关系,则可以通过简单的声明使序列化器支持这种关联: ```python class CourseSerializer(serializers.ModelSerializer): category = CategorySerializer(read_only=True) class Meta: model = Course fields = ('title', 'description', 'category') ``` 这里展示了如何嵌套另一个序列化器以表示一对多或一对一的关系。当然也可以继续沿用 `PrimaryKeyRelatedField` 来保持简洁性,具体取决于应用场景的需求[^3]。 值得注意的是,虽然 `ModelSerializer` 大大减少了工作量,但在某些特殊情况下可能仍需定制行为,比如重写默认方法来自定义验证逻辑或是修改保存机制等[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值