登录
首页 >  文章 >  python教程

Django模型嵌套序列化与Serializer重写方法

时间:2026-04-13 09:33:36 210浏览 收藏

本文深入解析了Django REST Framework中嵌套模型序列化的常见陷阱与实战解决方案:揭示为何直接使用ModelSerializer处理外键及反向关联字段会导致ID裸露、空列表或AttributeError等错误,并系统讲解如何通过自定义子序列化器、重写create/update方法实现灵活的读写控制,同时强调prefetch_related优化N+1查询、规避循环引用、合理设置read_only/required以及精细化处理正向/反向嵌套的完整链路——无论你是想优雅返回完整关联对象,还是支持创建时传入嵌套数据或批量更新,这篇文章都提供了即学即用的核心技巧与避坑指南。

Python Django怎么对嵌套模型序列化_重写Serializer处理关联表

为什么直接用 ModelSerializer 嵌套序列化会出错

因为 Django REST Framework 默认不会自动展开外键或反向关联字段,比如 author 是外键、postsForeignKey 的反向关系,直接在 fields 里写 'author''posts',返回的只是 ID 或空列表,不是嵌套对象。

常见错误现象:AttributeError: Got AttributeError when attempting to get a value for field `author` on serializer `BookSerializer`,或者返回数据里 "author": 1 而不是完整用户信息。

  • 外键正向关联(如 book.author)需显式声明为 AuthorSerializer 实例,不能只写 author
  • 反向关联(如 author.books_set)默认是 ReadOnlyField,必须设 many=True 并指定子序列化器
  • 若没加 read_only=True 或没提供 queryset,创建/更新时会报 Incorrect type. Expected pk value, received dict

怎么重写 Serializer 处理正向外键(如 author

核心是把字段从默认的 PkRelatedField 替换为一个内联的或独立的 Serializer,并控制读写行为。

示例:让 BookSerializer 返回完整的 Author 对象,且允许创建时传作者 ID 或嵌套数据:

class BookSerializer(serializers.ModelSerializer):
    author = AuthorSerializer(read_only=False)  # 允许写入
<pre class="brush:php;toolbar:false"><code>class Meta:
    model = Book
    fields = ['id', 'title', 'author']

def create(self, validated_data):
    author_data = validated_data.pop('author', None)
    if author_data and 'id' not in author_data:
        author = Author.objects.create(**author_data)
        validated_data['author'] = author
    elif author_data:
        validated_data['author_id'] = author_data['id']
    return Book.objects.create(**validated_data)</code>

  • 如果只要读取嵌套数据(不支持创建时传嵌套),直接用 author = AuthorSerializer(read_only=True) 即可
  • 若想支持创建时传 {"author": {"name": "xxx"}},必须重写 create(),否则 DRF 不知道如何处理字典型输入
  • 别漏掉 author_id 字段映射逻辑——DRF 不会自动把嵌套字典转成外键 ID

怎么序列化反向关联(如 author.books)并避免 N+1 查询

反向字段默认不包含在 ModelSerializer 中,必须手动添加,且容易触发未优化的数据库查询。

正确做法是:在 AuthorSerializer 中显式定义 books 字段,并在视图的 get_queryset() 里用 prefetch_related('books')

class AuthorSerializer(serializers.ModelSerializer):
    books = BookSerializer(many=True, read_only=True)
<pre class="brush:php;toolbar:false"><code>class Meta:
    model = Author
    fields = ['id', 'name', 'books']</code>

  • 必须加 many=True,否则报 TypeError: Object of type QuerySet is not JSON serializable
  • 不加 prefetch_related 会导致每个作者查一次所有书籍,100 个作者就发 100 次 SQL
  • 如果只需要部分字段(比如只返回书名和 ID),可用 SlugRelatedFieldbooks = serializers.SlugRelatedField(slug_field='title', read_only=True, many=True)

嵌套序列化时最容易被忽略的两个点

一个是深度嵌套时的循环引用风险(比如 Book 嵌套 AuthorAuthor 又嵌套 Book),另一个是写操作中嵌套字段的验证边界。

  • 循环引用不会报错,但会导致 JSON 序列化卡死或无限递归,用 depth = 1 是最简方案,但仅适用于单层嵌套;更稳妥的是在反向字段上加 exclude 或用 SerializerMethodField
  • 更新嵌套对象(如 PATCH /authors/1/ 同时改 author 和其 books)需要重写 update(),DRF 默认不支持嵌套更新,否则会静默忽略嵌套字段或抛 KeyError
  • 所有嵌套序列化器都建议加 required=False(尤其反向字段),否则反向关系为空时校验失败

本篇关于《Django模型嵌套序列化与Serializer重写方法》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于文章的相关知识,请关注golang学习网公众号!

资料下载
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>