Django Ninja 中 ModelSchema 关联对象查询的异步处理技巧

在使用 Django Ninja 框架开发 REST API 时，ModelSchema 是一个非常方便的工具，它可以帮助我们快速地将 Django 模型转换为 Pydantic 模型。然而，在处理模型关联关系时，特别是在异步视图环境下，开发者可能会遇到一些棘手的问题。

常见问题场景

当我们需要在 ModelSchema 中包含关联模型的数据时，通常会使用 resolve_* 方法来定义。例如，Country 模型有一个到 News 模型的反向关联，我们希望在序列化 Country 时包含其关联的 News 数据。

同步与异步的冲突

在 Django Ninja 的异步视图中直接使用 Django ORM 的同步查询方法（如 all()、order_by() 等）会导致 SynchronousOnlyOperation 错误。这是因为 Django ORM 的许多查询方法在设计上是同步的，而异步视图需要异步操作。

解决方案

方案一：使用同步解析方法

最简单的解决方案是将 resolve_news 方法标记为同步方法：

class CountryRead(ModelSchema):
    news: list[NewsRead]

    class Config:
        model = Country
        model_fields = ["id", "name", "created", "modified"]

    @staticmethod
    def resolve_news(obj):
        return list(obj.news.all().order_by("-datetime"))

注意这里使用了 list() 强制立即执行查询，避免惰性查询在异步上下文中执行。

方案二：预取关联数据

更优雅的解决方案是在视图层预先获取关联数据：

class CountryRead(ModelSchema):
    news: list[NewsRead] = Field([], alias="prefetched_news")

    class Config:
        model = Country
        model_fields = ["id", "name", "created", "modified"]

@api.get("/country/{id}", response=CountryRead)
async def get_country(request, id: int):
    country = await aget_object_or_404(Country, id=id)
    country.prefetched_news = [n async for n in country.news.all().order_by("-datetime")]
    return country

这种方法有几个优点：

1. 明确区分了同步和异步操作
2. 可以在视图层控制查询的排序和限制
3. 避免了在序列化过程中执行数据库查询

查询优化技巧

当需要限制返回的关联对象数量时，应该使用 Django ORM 的切片查询：

country.prefetched_news = [n async for n in country.news.all().order_by("-datetime")[:5]]

这样生成的 SQL 会包含 LIMIT 子句，比在 Python 中切片更高效。

总结

在 Django Ninja 中处理模型关联关系时，特别是在异步视图环境下，开发者需要注意以下几点：

1. 避免在 Pydantic 的解析方法中直接使用 Django ORM 的同步查询
2. 考虑在视图层预先获取关联数据
3. 使用正确的查询方法优化数据库访问
4. 明确区分同步和异步操作边界

通过合理的设计，可以既保持代码的简洁性，又确保性能最优。