Django Ninja中使用Pydantic实现嵌套模型序列化

在Django Ninja框架中，我们经常需要处理复杂的数据结构序列化问题。本文将介绍如何使用Pydantic模型实现类似Django REST Framework中的嵌套序列化功能，特别是如何将整个数据集传递给嵌套字段。

问题背景

在Web API开发中，我们经常需要将数据库模型转换为JSON格式返回给客户端。有时，我们需要对返回的数据结构进行特殊处理，比如将一个模型实例拆分成多个嵌套对象返回。

模型定义

假设我们有两个相关模型：作者(Author)和博客(Blog)，它们之间是一对多的关系：

class Author(models.Model):
    username = models.CharField(max_length=100)
    email = models.CharField(max_length=100)
    # 其他字段...

class Blog(models.Model):
    title = models.CharField(max_length=200)
    text = models.TextField()
    tags = models.CharField(max_length=200)
    author = models.ForeignKey(Author, on_delete=models.CASCADE)
    # 其他字段...

序列化需求

我们需要将Blog模型实例序列化为以下JSON结构：

{
    "author": {
        "id": 1,
        "username": "jane.doe",
        "name": "Jane Doe",
        "email": "[e-mail]"
    },
    "blog": {
        "id": 1,
        "title": "Lorem Ipsum",
        "text": "Lorem Ipsum Text"
    }
}

解决方案

在Django Ninja中，我们可以使用Pydantic模型和自定义解析方法来实现这一需求：

1. 首先创建基础的模型Schema：

from ninja import ModelSchema, Schema

# 作者Schema，排除不需要的字段
class AuthorSchema(ModelSchema):
    class Meta:
        model = Author
        exclude = ["updated", "date_joined"]

# 博客基础Schema，排除作者字段
class BlogBaseSchema(ModelSchema):
    class Meta:
        model = Blog
        exclude = ["author"]

2. 然后创建最终的组合Schema，并使用resolve_方法实现特殊逻辑：

class BlogSchema(Schema):
    blog: BlogBaseSchema
    author: AuthorSchema

    @staticmethod
    def resolve_blog(self, obj):
        # 将整个Blog对象传递给blog字段
        return obj

3. 在API视图中使用这个Schema：

@api.get("/blog", response=list[BlogSchema])
def list_of_detailed_blogs(request):
    return Blog.objects.all()

技术原理

这里的关键点是resolve_blog静态方法。在Django Ninja中，任何以resolve_开头的方法都会被用作对应字段的解析器。在这个例子中：

1. 当序列化Blog对象时，Ninja会自动调用resolve_blog方法
2. 该方法接收两个参数：self是Schema实例，obj是正在被序列化的原始对象
3. 我们直接将原始Blog对象返回，这样它会被BlogBaseSchema序列化
4. 对于author字段，Ninja会自动从Blog实例的author属性获取值并使用AuthorSchema序列化

优势与对比

相比Django REST Framework的实现方式，Django Ninja的这种方案有几个优点：

1. 代码更加简洁明了
2. 利用了Python的类型提示功能
3. 解析逻辑更加灵活可控
4. 性能通常更好，因为Pydantic的序列化速度较快

总结

通过使用Django Ninja和Pydantic的resolve方法，我们可以轻松实现复杂的数据结构序列化需求。这种方法不仅保持了代码的简洁性，还提供了足够的灵活性来处理各种特殊场景。对于需要从DRF迁移到Django Ninja的开发者来说，理解这种模式转换非常重要。